Class CheckBox

Represents the CheckBox UI element.

Inheritance

System.Object

CommonControl

CheckBox

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService

Inherited Members

CommonControl.RaisePostBackEvent(String)

CommonControl.LoadViewState(Object)

CommonControl.OnInit(EventArgs)

CommonControl.OnLoad(EventArgs)

Namespace: Syncfusion.JavaScript.Web

Assembly: Syncfusion.EJ.Web.dll

Syntax

public class CheckBox : CommonControl, INamingContainer, IPostBackEventHandler, IPostBackDataHandler, IUrlResolutionService

Constructors

CheckBox()

Declaration

public CheckBox()

Properties

Checked

Gets or sets a value indicating checkbox is checked or not.

Declaration

public bool Checked { get; set; }

Property Value

Type	Description
System.Boolean

CheckState

Gets or sets a value indicating the state of the checkbox.

Declaration

public CheckState CheckState { get; set; }

Property Value

Type	Description
CheckState

ClientSideOnBeforeChange

Gets or sets a value indicating this event gets fired before the checkbox is going to changed its state successfully.

Declaration

public string ClientSideOnBeforeChange { get; set; }

Property Value

Type	Description
System.String

ClientSideOnChange

Gets or sets a value indicating this event gets fired when the checkbox state is changed successfully.

Declaration

public string ClientSideOnChange { get; set; }

Property Value

Type	Description
System.String

ClientSideOnCreate

Gets or sets a value indicating this event gets fired when the checkbox is created successfully.

Declaration

public string ClientSideOnCreate { get; set; }

Property Value

Type	Description
System.String

ClientSideOnDestroy

Gets or sets a value indicating this event gets fired when the checkbox is destroyed successfully.

Declaration

public string ClientSideOnDestroy { get; set; }

Property Value

Type	Description
System.String

CssClass

Gets or sets root CSS class to checkbox for theme customization.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String

Enabled

Gets or sets a value indicating whether the control can respond to user interaction.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean

EnablePersistence

Gets or sets a value indicating checkbox model value even after form post back or browser refresh sustains or not.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean

EnableRTL

Gets or sets a value to align the checkbox in right to left direction.

Declaration

public bool EnableRTL { get; set; }

Property Value

Type	Description
System.Boolean

EnableTriState

Gets or sets a value indicating tri-state mode is active or not.

Declaration

public bool EnableTriState { get; set; }

Property Value

Type	Description
System.Boolean

HtmlAttributes

Declaration

public IDictionary<string, object> HtmlAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

IdPrefix

Gets or sets the idprefix value to be added before the current id of the checkbox.

Declaration

public string IdPrefix { get; set; }

Property Value

Type	Description
System.String

Model

Gets or sets the checkbox model object of the checkbox properties.

Declaration

public CheckBoxProperties Model { get; set; }

Property Value

Type	Description
CheckBoxProperties

Name

Gets or sets a value indicating the name attribute of the checkbox.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

ShowRoundedCorner

Gets or sets a value indicating the checkbox with rounded corners or not.

Declaration

public bool ShowRoundedCorner { get; set; }

Property Value

Type	Description
System.Boolean

Size

Gets or sets a value indicating the size of the checkbox.

Declaration

public Size Size { get; set; }

Property Value

Type	Description
Size

Text

Gets or sets a value indicating the text content to be displayed for checkbox.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String

ValidationMessage

Declaration

public List<KeyValue> ValidationMessage { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<KeyValue>

ValidationMessages

Declaration

public List<KeyValue> ValidationMessages { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<KeyValue>

ValidationMsg

Gets or sets the jQuery validation error message for checkbox.

Declaration

[JsonProperty("validationMessage")]
protected Dictionary<string, object> ValidationMsg { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>

ValidationMsgs

Gets or sets the jQuery validation error message for checkbox.

Declaration

[JsonProperty("validationMessages")]
protected Dictionary<string, object> ValidationMsgs { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>

ValidationRule

Declaration

public List<KeyValue> ValidationRule { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<KeyValue>

ValidationRules

Gets or sets the jQuery validation rules for checkbox.

Declaration

[JsonProperty("validationRules")]
public Dictionary<string, object> ValidationRules { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>

Value

Gets or sets a value indicating the value attribute of the checkbox.

Declaration

public string Value { get; set; }

Property Value

Type	Description
System.String

Methods

DependentScripts()

Specifies the dependent scripts.

Declaration

public List<string> DependentScripts()

Returns

Type	Description
System.Collections.Generic.List<System.String>

GetDependentFiles()

Specifies the the dependent files.

Declaration

public override List<string> GetDependentFiles()

Returns

Type	Description
System.Collections.Generic.List<System.String>

Overrides

CommonControl.GetDependentFiles()

OnPreRender(EventArgs)

Modifying server controls before sending them to the client.

Declaration

protected override void OnPreRender(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

PostBackEventHandler(String, Dictionary<String, Object>)

Specifies the handler for server side events.

Declaration

public override void PostBackEventHandler(string EventName, Dictionary<string, object> args)

Parameters

Type	Name	Description
System.String	EventName
System.Collections.Generic.Dictionary<System.String, System.Object>	args

Overrides

CommonControl.PostBackEventHandler(String, Dictionary<String, Object>)

Render()

Renders the checkbox instance.

Declaration

public string Render()

Returns

Type	Description
System.String

Render(HtmlTextWriter)

Declaration

protected override void Render(HtmlTextWriter writer)

Parameters

Type	Name	Description
System.Web.UI.HtmlTextWriter	writer

Overrides

CommonControl.Render(HtmlTextWriter)

UpdateServerModel(Dictionary<String, Object>)

Updates the server model with client model.

Declaration

public override void UpdateServerModel(Dictionary<string, object> ClientModel)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	ClientModel

Overrides

CommonControl.UpdateServerModel(Dictionary<String, Object>)

Events

Change

Represents the button click event handler.

Declaration

public event CheckBox.CheckBoxEventHandler Change

Event Type

Type	Description
CheckBox.CheckBoxEventHandler

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService