Class CheckBoxPropertiesBuilder

Holds the CheckBox properties

Inheritance

System.Object

CheckBoxPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class CheckBoxPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

CheckBoxPropertiesBuilder()

Initializes a new instance of the CheckBoxPropertiesBuilder class.

Declaration

public CheckBoxPropertiesBuilder()

CheckBoxPropertiesBuilder(CheckBox)

Initializes a new instance of the CheckBoxPropertiesBuilder class by the specified checkbox object.

Declaration

public CheckBoxPropertiesBuilder(CheckBox checkbox)

Parameters

Type	Name	Description
CheckBox	checkbox

Fields

checkbox

Specifies the instance of the CheckBox class.

Declaration

public CheckBox checkbox

Field Value

Type	Description
CheckBox

Methods

Checked()

Specifies the checked state of checkbox.

Declaration

public CheckBoxPropertiesBuilder Checked()

Returns

Type	Description
CheckBoxPropertiesBuilder

Checked(Boolean)

Specifies whether checkbox is checked or not based on the specified boolean argument.

Declaration

public CheckBoxPropertiesBuilder Checked(bool isCheck)

Parameters

Type	Name	Description
System.Boolean	isCheck	checked

Returns

Type	Description
CheckBoxPropertiesBuilder	This method returns boolean value

CheckState(CheckState)

Specifies the state of checkbox with string argument.

Declaration

public CheckBoxPropertiesBuilder CheckState(CheckState checkState)

Parameters

Type	Name	Description
CheckState	checkState	checkState

Returns

Type	Description
CheckBoxPropertiesBuilder	This method returns enum value

ClientSideEvents(Action<CheckBoxClientSideEventsBuilder>)

Specifies to trigger the checkbox client side events.

Declaration

public CheckBoxPropertiesBuilder ClientSideEvents(Action<CheckBoxClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<CheckBoxClientSideEventsBuilder>	clientSideEvents

Returns

Type	Description
CheckBoxPropertiesBuilder

CssClass(String)

Specifies the root CSS class to checkbox for theme customization.

Declaration

public CheckBoxPropertiesBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass	cssClass

Returns

Type	Description
CheckBoxPropertiesBuilder	This method returns string value

Enabled()

Specifies the checkbox control to respond for user interaction.

Declaration

public CheckBoxPropertiesBuilder Enabled()

Returns

Type	Description
CheckBoxPropertiesBuilder

Enabled(Boolean)

Specifies the checkbox control to respond for user interaction with the specified boolean argument.

Declaration

public CheckBoxPropertiesBuilder Enabled(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled	enabled

Returns

Type	Description
CheckBoxPropertiesBuilder	This method returns boolean value

EnablePersistence()

Persists checkbox model value even after form post back or browser refresh.

Declaration

public CheckBoxPropertiesBuilder EnablePersistence()

Returns

Type	Description
CheckBoxPropertiesBuilder

EnablePersistence(Boolean)

Persists checkbox model value even after form post back or browser refresh with the specified boolean argument.

Declaration

public CheckBoxPropertiesBuilder EnablePersistence(bool enablePersistence)

Parameters

Type	Name	Description
System.Boolean	enablePersistence	enablePersistence

Returns

Type	Description
CheckBoxPropertiesBuilder	This method returns boolean value

EnableRTL()

Specifies to align the checkbox in right to left direction.

Declaration

public CheckBoxPropertiesBuilder EnableRTL()

Returns

Type	Description
CheckBoxPropertiesBuilder

EnableRTL(Boolean)

Specifies to align the checkbox in right to left direction with the specified boolean argument.

Declaration

public CheckBoxPropertiesBuilder EnableRTL(bool enableRTL)

Parameters

Type	Name	Description
System.Boolean	enableRTL	enableRTL

Returns

Type	Description
CheckBoxPropertiesBuilder	This method returns boolean value

EnableTriState()

Specifies the tri-state mode of checkbox.

Declaration

public CheckBoxPropertiesBuilder EnableTriState()

Returns

Type	Description
CheckBoxPropertiesBuilder

EnableTriState(Boolean)

Specifies the tri-state mode in checkbox is active or not with the specified boolean argument.

Declaration

public CheckBoxPropertiesBuilder EnableTriState(bool enableTriState)

Parameters

Type	Name	Description
System.Boolean	enableTriState	enableTriState

Returns

Type	Description
CheckBoxPropertiesBuilder	This method returns boolean value

HtmlAttributes(IDictionary<String, Object>)

Specifies to map the field of HTML attributes.

Declaration

public CheckBoxPropertiesBuilder HtmlAttributes(IDictionary<string, object> itemHtmlAttributes)

Parameters

Type	Name	Description
System.Collections.Generic.IDictionary<System.String, System.Object>	itemHtmlAttributes	HTML Attributes

Returns

Type	Description
CheckBoxPropertiesBuilder	This method returns object value

Id(String)

Specified id attribute of the checkbox with string argument.

Declaration

public CheckBoxPropertiesBuilder Id(string id)

Parameters

Type	Name	Description
System.String	id	Id

Returns

Type	Description
CheckBoxPropertiesBuilder	This method returns string value

IdPrefix(String)

Specifies the prefix value of id to be added before the current id of the checkbox with string argument.

Declaration

public CheckBoxPropertiesBuilder IdPrefix(string idPrefix)

Parameters

Type	Name	Description
System.String	idPrefix	idPrefix

Returns

Type	Description
CheckBoxPropertiesBuilder	This method returns string value

Name(String)

Specifies the name attribute of the checkbox with string argument.

Declaration

public CheckBoxPropertiesBuilder Name(string name)

Parameters

Type	Name	Description
System.String	name	name

Returns

Type	Description
CheckBoxPropertiesBuilder	This method returns string value

Render()

Renders the checkbox instance.

Declaration

public void Render()

ShowRoundedCorner()

Displays the checkbox with rounded corners.

Declaration

public CheckBoxPropertiesBuilder ShowRoundedCorner()

Returns

Type	Description
CheckBoxPropertiesBuilder

ShowRoundedCorner(Boolean)

Displays the checkbox with rounded corners with the specified boolean argument.

Declaration

public CheckBoxPropertiesBuilder ShowRoundedCorner(bool showRoundedCorner)

Parameters

Type	Name	Description
System.Boolean	showRoundedCorner	showRoundedCorner

Returns

Type	Description
CheckBoxPropertiesBuilder	This method returns boolean value

Size(Size)

Specifies the size of the checkbox. Size can be set as normal, mini, smalll, medium or large.

Declaration

public CheckBoxPropertiesBuilder Size(Size size)

Parameters

Type	Name	Description
Size	size	size

Returns

Type	Description
CheckBoxPropertiesBuilder	This method returns enum value

Text(String)

Specifies the text content to be displayed for checkbox with string argument.

Declaration

public CheckBoxPropertiesBuilder Text(string text)

Parameters

Type	Name	Description
System.String	text	text

Returns

Type	Description
CheckBoxPropertiesBuilder	This method returns string value

ToHtmlString()

Represents an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

ValidationMessage(Action<CheckboxValidationMessageBuilder>)

Specifies the jQuery validation error message for checkbox with object argument.This API is deprecated please use ValidationMessages instead of this.

Declaration

[Obsolete("The ValidationMessage property has been deprecated.Use 'ValidationMessages' instead")]
public CheckBoxPropertiesBuilder ValidationMessage(Action<CheckboxValidationMessageBuilder> validationMessage)

Parameters

Type	Name	Description
System.Action<CheckboxValidationMessageBuilder>	validationMessage

Returns

Type	Description
CheckBoxPropertiesBuilder

ValidationMessage(Dictionary<String, Object>)

Specifies the jQuery validation error message in checkbox with dictionary argument.This API is deprecated please use ValidationMessages instead of this.

Declaration

[Obsolete("The ValidationMessage property has been deprecated.Use 'ValidationMessages' instead")]
public CheckBoxPropertiesBuilder ValidationMessage(Dictionary<string, object> validationMessage)

Parameters

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

Returns

Type	Description
CheckBoxPropertiesBuilder	This method returns object value

ValidationMessages(Action<CheckboxValidationMessageBuilder>)

Specifies the jQuery validation error message for checkbox with object argument.

Declaration

public CheckBoxPropertiesBuilder ValidationMessages(Action<CheckboxValidationMessageBuilder> validationMessage)

Parameters

Type	Name	Description
System.Action<CheckboxValidationMessageBuilder>	validationMessage

Returns

Type	Description
CheckBoxPropertiesBuilder

ValidationMessages(Dictionary<String, Object>)

Specifies the jQuery validation error message in checkbox with dictionary argument.

Declaration

public CheckBoxPropertiesBuilder ValidationMessages(Dictionary<string, object> validationMessage)

Parameters

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

Returns

Type	Description
CheckBoxPropertiesBuilder	This method returns object value

ValidationRules(Action<CheckboxValidationRuleBuilder>)

specifies the jQuery validation rules for checkbox with object argument.

Declaration

public CheckBoxPropertiesBuilder ValidationRules(Action<CheckboxValidationRuleBuilder> validationRule)

Parameters

Type	Name	Description
System.Action<CheckboxValidationRuleBuilder>	validationRule

Returns

Type	Description
CheckBoxPropertiesBuilder

ValidationRules(Dictionary<String, Object>)

Specifies the jQuery validation rules for checkbox with dictionary argument.

Declaration

public CheckBoxPropertiesBuilder ValidationRules(Dictionary<string, object> validationRule)

Parameters

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

Returns

Type	Description
CheckBoxPropertiesBuilder	This method returns object value

Value(String)

Specifies the value attribute of the checkbox with string argument.

Declaration

public CheckBoxPropertiesBuilder Value(string value)

Parameters

Type	Name	Description
System.String	value	value

Returns

Type	Description
CheckBoxPropertiesBuilder	This method returns string value

Implements

IPropertiesBuilder

System.Web.IHtmlString