Class CheckBoxBuilder

Inheritance
System.Object
ControlBuilder
CheckBoxBuilder
Inherited Members
Namespace: Syncfusion.EJ2.Buttons
Assembly: Syncfusion.EJ2.dll
Syntax
public class CheckBoxBuilder : ControlBuilder

Constructors

CheckBoxBuilder()

Declaration
public CheckBoxBuilder()

CheckBoxBuilder(CheckBox)

Declaration
public CheckBoxBuilder(CheckBox model)
Parameters
Type Name Description
CheckBox model

Fields

model

Declaration
public CheckBox model
Field Value
Type Description
CheckBox

Properties

HtmlAttr

Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

Declaration
public string ID { get; set; }
Property Value
Type Description
System.String

Output

Declaration
public override TextWriter Output { get; set; }
Property Value
Type Description
System.IO.TextWriter
Overrides

Methods

Change(String)

Triggers when the CheckBox state has been changed by user interaction.

Declaration
public CheckBoxBuilder Change(string change)
Parameters
Type Name Description
System.String change
Returns
Type Description
CheckBoxBuilder

Checked(Boolean)

Declaration
public CheckBoxBuilder Checked(bool check = true)
Parameters
Type Name Description
System.Boolean check
Returns
Type Description
CheckBoxBuilder

Created(String)

Triggers once the component rendering is completed.

Declaration
public CheckBoxBuilder Created(string created)
Parameters
Type Name Description
System.String created
Returns
Type Description
CheckBoxBuilder

CssClass(String)

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
public CheckBoxBuilder CssClass(string cssClass)
Parameters
Type Name Description
System.String cssClass
Returns
Type Description
CheckBoxBuilder

Disabled(Boolean)

Specifies a value that indicates whether the CheckBox is disabled or not. When set to true, the CheckBox will be in disabled state.

Declaration
public CheckBoxBuilder Disabled(bool disabled = true)
Parameters
Type Name Description
System.Boolean disabled
Returns
Type Description
CheckBoxBuilder

EnableHtmlSanitizer(Boolean)

Defines whether to allow the cross-scripting site or not.

Declaration
public CheckBoxBuilder EnableHtmlSanitizer(bool enableHtmlSanitizer = true)
Parameters
Type Name Description
System.Boolean enableHtmlSanitizer
Returns
Type Description
CheckBoxBuilder

EnablePersistence(Boolean)

Enable or disable persisting component's state between page reloads.

Declaration
public CheckBoxBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type Name Description
System.Boolean enablePersistence
Returns
Type Description
CheckBoxBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration
public CheckBoxBuilder EnableRtl(bool enableRtl = true)
Parameters
Type Name Description
System.Boolean enableRtl
Returns
Type Description
CheckBoxBuilder

HtmlAttributes(Object)

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
public CheckBoxBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type Name Description
System.Object htmlAttributes
Returns
Type Description
CheckBoxBuilder

Indeterminate(Boolean)

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
public CheckBoxBuilder Indeterminate(bool indeterminate = true)
Parameters
Type Name Description
System.Boolean indeterminate
Returns
Type Description
CheckBoxBuilder

Label(String)

Defines the caption for the CheckBox, that describes the purpose of the CheckBox.

Declaration
public CheckBoxBuilder Label(string label)
Parameters
Type Name Description
System.String label
Returns
Type Description
CheckBoxBuilder

LabelPosition(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
public CheckBoxBuilder LabelPosition(LabelPosition labelPosition)
Parameters
Type Name Description
LabelPosition labelPosition
Returns
Type Description
CheckBoxBuilder

Locale(String)

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration
public CheckBoxBuilder Locale(string locale)
Parameters
Type Name Description
System.String locale
Returns
Type Description
CheckBoxBuilder

Name(String)

Defines name attribute for the CheckBox. It is used to reference form data (CheckBox value) after a form is submitted.

Declaration
public CheckBoxBuilder Name(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
CheckBoxBuilder

Render()

Declaration
public HtmlString Render()
Returns
Type Description
Microsoft.AspNetCore.Html.HtmlString

Value(String)

Defines value attribute for the CheckBox. It is a form data passed to the server when submitting the form.

Declaration
public CheckBoxBuilder Value(string value)
Parameters
Type Name Description
System.String value
Returns
Type Description
CheckBoxBuilder