Class ToggleButtonProperties
Inherited Members
Namespace: Syncfusion.JavaScript.Models
Assembly: Syncfusion.EJ.dll
Syntax
public class ToggleButtonProperties : EJTagHelper
Constructors
ToggleButtonProperties()
Initializes a new instance of the ToggleButtonProperties class.
Declaration
public ToggleButtonProperties()
Properties
ActivePrefixIcon
Gets or sets the primary icon of toggle button when the control is in active(checked) state. This is applicable for the content types image only, image text image, text and image and image both.
Declaration
[JsonProperty("activePrefixIcon")]
public string ActivePrefixIcon { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
ActiveSuffixIcon
Gets or sets the secondary icon of toggle button when the control is in active(checked) state. This is applicable for the content types imagetextimage and imageboth.
Declaration
[JsonProperty("activeSuffixIcon")]
public string ActiveSuffixIcon { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
ActiveText
Gets or sets the text to be shown in the active(checked) state of the toggle button.
Declaration
[JsonProperty("activeText")]
public string ActiveText { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Change
Gets or sets a value indicating this event gets fired when toggle button state is changed successfully.
Declaration
[JsonProperty("change")]
public string Change { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Click
Gets or sets a value indicating this event gets fired when toggle button is clicked successfully.
Declaration
[JsonProperty("click")]
public string Click { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
ContentType
Gets or sets the content type of the toggle button. Button can have image only, text only, image text image, text and image or image both as content type.
Declaration
[JsonProperty("contentType")]
[JsonConverter(typeof(StringEnumConverter))]
public ContentType ContentType { get; set; }
Property Value
| Type | Description |
|---|---|
| ContentType |
Create
Gets or sets a value indicating this event gets fired when toggle button is created successfully.
Declaration
[JsonProperty("create")]
public string Create { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
CssClass
Gets or sets the root CSS class to toggle button for theme customization.
Declaration
[JsonProperty("cssClass")]
public string CssClass { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
DefaultPrefixIcon
Gets or sets the primary icon of toggle button when the control is in default(unchecked) state. This is applicable for the content types image only, image text image, text and image and image both.
Declaration
[JsonProperty("defaultPrefixIcon")]
public string DefaultPrefixIcon { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
DefaultSuffixIcon
Gets or sets the secondary icon of toggle button when the control is in default(unchecked) state. This is applicable for the content types imagetextimage and imageboth.
Declaration
[JsonProperty("defaultSuffixIcon")]
public string DefaultSuffixIcon { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
DefaultText
Gets or sets the text to be shown in the default(unchecked) state of the toggle button.
Declaration
[JsonProperty("defaultText")]
public string DefaultText { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Destroy
Gets or sets a value indicating this event gets fired when toggle button is destroyed successfully.
Declaration
[JsonProperty("destroy")]
public string Destroy { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Enabled
Gets or sets a value indicating whether the control can respond to user interaction.
Declaration
[JsonProperty("enabled")]
public bool Enabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
EnablePersistence
Gets or set the value indicating toggle button model value even after form post back/browser refresh sustains or not.
Declaration
[JsonProperty("enablePersistence")]
public bool EnablePersistence { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
EnableRTL
Gets or sets a value indicating whether control's elements supports to align in right to left direction.
Declaration
[JsonProperty("enableRTL")]
public bool EnableRTL { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Height
Gets or sets the height of the toggle button.
Declaration
[JsonProperty("height")]
public string Height { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
HtmlAttributes
Gets or sets the value to map the field of HTML attributes.
Declaration
[JsonProperty("htmlAttributes")]
public IDictionary<string, object> HtmlAttributes { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IDictionary<System.String, System.Object> |
ImagePosition
Gets or sets a value indicating whether image position is left or right. This property is applicable for the content type 'text and image' only.
Declaration
[JsonProperty("imagePosition")]
[JsonConverter(typeof(StringEnumConverter))]
public ImagePosition ImagePosition { get; set; }
Property Value
| Type | Description |
|---|---|
| ImagePosition |
PreventToggle
Gets or sets a value which prevents the toggling behavior of the control.
Declaration
[JsonProperty("preventToggle")]
public bool PreventToggle { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
ShowRoundedCorner
Gets or sets a value indicating whether toggle button with rounded corners or not.
Declaration
[JsonProperty("showRoundedCorner")]
public bool ShowRoundedCorner { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Size
Gets or sets the size of the toggle button. Size can be normal, mini, small, medium or large.
Declaration
[JsonProperty("size")]
[JsonConverter(typeof(StringEnumConverter))]
public ButtonSize Size { get; set; }
Property Value
| Type | Description |
|---|---|
| ButtonSize |
ToggleState
Gets or sets a value indicating toggle button state to be checked(active) or unchecked(default).
Declaration
[JsonProperty("toggleState")]
public bool ToggleState { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Type
Gets or sets a value indicating whether button type is a submit, reset or normal button.
Declaration
[JsonProperty("type")]
[JsonConverter(typeof(StringEnumConverter))]
public ButtonType Type { get; set; }
Property Value
| Type | Description |
|---|---|
| ButtonType |
Width
Gets or sets the width of the toggle button.
Declaration
[JsonProperty("width")]
public string Width { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Methods
GetControlDetails()
Declaration
protected override object GetControlDetails()
Returns
| Type | Description |
|---|---|
| System.Object |