Class CheckBox
Inherited Members
Namespace: Syncfusion.EJ2.Buttons
Assembly: Syncfusion.EJ2.dll
Syntax
public class CheckBox : EJTagHelper
Constructors
CheckBox()
Declaration
public CheckBox()
Properties
Change
Triggers when the CheckBox state has been changed by user interaction.
Declaration
[HtmlAttributeName("change")]
public string Change { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Checked
Specifies a value that indicates whether the CheckBox is checked
or not.
When set to true
, the CheckBox will be in checked
state.
Declaration
[HtmlAttributeName("checked")]
public bool Checked { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
Created
Triggers once the component rendering is completed.
Declaration
[HtmlAttributeName("created")]
public string Created { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CssClass
Defines class/multiple classes separated by a space in the CheckBox element. You can add custom styles to the CheckBox by using this property.
Declaration
[HtmlAttributeName("cssClass")]
public string CssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Disabled
Specifies a value that indicates whether the CheckBox is disabled
or not.
When set to true
, the CheckBox will be in disabled
state.
Declaration
[HtmlAttributeName("disabled")]
public bool Disabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableHtmlSanitizer
Defines whether to allow the cross-scripting site or not.
Declaration
[HtmlAttributeName("enableHtmlSanitizer")]
public bool EnableHtmlSanitizer { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnablePersistence
Enable or disable persisting component's state between page reloads.
Declaration
[HtmlAttributeName("enablePersistence")]
public bool EnablePersistence { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
[HtmlAttributeName("enableRtl")]
public bool EnableRtl { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
HtmlAttributes
You can add the additional html attributes such as disabled, value etc., to the element. If you configured both property and equivalent html attribute then the component considers the property value.
Declaration
[HtmlAttributeName("htmlAttributes")]
public object HtmlAttributes { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
Indeterminate
Specifies a value that indicates whether the CheckBox is in indeterminate
state or not.
When set to true
, the CheckBox will be in indeterminate
state.
Declaration
[HtmlAttributeName("indeterminate")]
public bool Indeterminate { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
Label
Defines the caption for the CheckBox, that describes the purpose of the CheckBox.
Declaration
[HtmlAttributeName("label")]
public string Label { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
LabelPosition
Positions label before
/after
the CheckBox.
The possible values are:
Before - The label is positioned to left of the CheckBox.
After - The label is positioned to right of the CheckBox.
Declaration
[HtmlAttributeName("labelPosition")]
public LabelPosition LabelPosition { get; set; }
Property Value
Type | Description |
---|---|
LabelPosition | The default value is LabelPosition.After |
Locale
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
[HtmlAttributeName("locale")]
public string Locale { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Name
Defines name
attribute for the CheckBox.
It is used to reference form data (CheckBox value) after a form is submitted.
Declaration
[HtmlAttributeName("name")]
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Value
Defines value
attribute for the CheckBox.
It is a form data passed to the server when submitting the form.
Declaration
[HtmlAttributeName("value")]
public string Value { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |