Ext.NET  5.3.0
.NET Component Framework for Enterprise Level Apps
Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder > Class Template Reference

More...

Inheritance diagram for Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >:
Ext.Net.Field.Builder< TCheckboxBase, TBuilder >

Public Member Functions

 Builder (TCheckboxBase component)
 
virtual TBuilder AfterBoxLabelTextTpl (XTemplate afterBoxLabelTextTpl)
 An optional string or XTemplate configuration to insert in the field markup after the box label text. If an XTemplate is used, the component's subTpl data serves as the context. More...
 
virtual TBuilder AfterBoxLabelTpl (XTemplate afterBoxLabelTpl)
 An optional string or XTemplate configuration to insert in the field markup after the box label element. If an XTemplate is used, the component's subTpl data serves as the context. More...
 
virtual TBuilder BeforeBoxLabelTextTpl (XTemplate beforeBoxLabelTextTpl)
 An optional string or XTemplate configuration to insert in the field markup before the box label text. If an XTemplate is used, the component's subTpl data serves as the context. More...
 
virtual TBuilder BeforeBoxLabelTpl (XTemplate beforeBoxLabelTpl)
 An optional string or XTemplate configuration to insert in the field markup before the box label text. If an XTemplate is used, the component's subTpl data serves as the context. More...
 
virtual TBuilder BoxLabel (string boxLabel)
 An optional text label that will appear next to the checkbox. Whether it appears before or after the checkbox is determined by the boxLabelAlign config (defaults to after). More...
 
virtual TBuilder BoxLabelAlign (BoxLabelAlign boxLabelAlign)
 The position relative to the checkbox where the boxLabel should appear. Recognized values are 'before' and 'after'. Defaults to 'after'. More...
 
virtual TBuilder BoxLabelStyle (string boxLabelStyle)
 
virtual TBuilder BoxLabelAttrTpl (XTemplate boxLabelAttrTpl)
 An optional string or XTemplate configuration to insert in the field markup inside the box label element (as attributes). If an XTemplate is used, the component's subTpl data serves as the context. More...
 
virtual TBuilder BoxLabelCls (string boxLabelCls)
 
virtual TBuilder Checked (bool _checked)
 True if the the checkbox should render already checked (defaults to false). More...
 
virtual TBuilder CheckedCls (string checkedCls)
 The CSS class added to the component's main element when it is in the checked state. More...
 
virtual TBuilder Handler (string handler)
 A function called when the checked value changes (can be used instead of handling the change event). More...
 
virtual TBuilder InputValue (string inputValue)
 The value that should go into the generated input element's value attribute and should be used as the parameter value when submitting as part of a form. Defaults to "on". More...
 
virtual TBuilder ModelValue (string modelValue)
 The value to use for getModelData when checked. Valid values are 'true', 'false' a number or another string value. More...
 
virtual TBuilder ModelValueUnchecked (string modelValueUnchecked)
 The value to use for getModelData when not checked. Valid values are 'true', 'false' a number or another string value. Default: 'false'. More...
 
virtual TBuilder Scope (string scope)
 An object to use as the scope ('this' reference) of the handler function. Defaults to this Checkbox. More...
 
virtual TBuilder UncheckedValue (string uncheckedValue)
 If configured, this will be submitted as the checkbox's value during form submit if the checkbox is unchecked. By default this is undefined, which results in nothing being submitted for the checkbox field when the form is submitted (the default behavior of HTML checkboxes). More...
 

Detailed Description

Type Constraints
TCheckboxBase :CheckboxBase 
TBuilder :Builder 
TBuilder :TCheckboxBase 
TBuilder :TBuilder 

Constructor & Destructor Documentation

◆ Builder()

Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >.Builder ( TCheckboxBase  component)
inline

Member Function Documentation

◆ AfterBoxLabelTextTpl()

virtual TBuilder Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >.AfterBoxLabelTextTpl ( XTemplate  afterBoxLabelTextTpl)
inlinevirtual

An optional string or XTemplate configuration to insert in the field markup after the box label text. If an XTemplate is used, the component's subTpl data serves as the context.

◆ AfterBoxLabelTpl()

virtual TBuilder Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >.AfterBoxLabelTpl ( XTemplate  afterBoxLabelTpl)
inlinevirtual

An optional string or XTemplate configuration to insert in the field markup after the box label element. If an XTemplate is used, the component's subTpl data serves as the context.

◆ BeforeBoxLabelTextTpl()

virtual TBuilder Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >.BeforeBoxLabelTextTpl ( XTemplate  beforeBoxLabelTextTpl)
inlinevirtual

An optional string or XTemplate configuration to insert in the field markup before the box label text. If an XTemplate is used, the component's subTpl data serves as the context.

◆ BeforeBoxLabelTpl()

virtual TBuilder Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >.BeforeBoxLabelTpl ( XTemplate  beforeBoxLabelTpl)
inlinevirtual

An optional string or XTemplate configuration to insert in the field markup before the box label text. If an XTemplate is used, the component's subTpl data serves as the context.

◆ BoxLabel()

virtual TBuilder Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >.BoxLabel ( string  boxLabel)
inlinevirtual

An optional text label that will appear next to the checkbox. Whether it appears before or after the checkbox is determined by the boxLabelAlign config (defaults to after).

◆ BoxLabelAlign()

virtual TBuilder Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >.BoxLabelAlign ( BoxLabelAlign  boxLabelAlign)
inlinevirtual

The position relative to the checkbox where the boxLabel should appear. Recognized values are 'before' and 'after'. Defaults to 'after'.

◆ BoxLabelAttrTpl()

virtual TBuilder Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >.BoxLabelAttrTpl ( XTemplate  boxLabelAttrTpl)
inlinevirtual

An optional string or XTemplate configuration to insert in the field markup inside the box label element (as attributes). If an XTemplate is used, the component's subTpl data serves as the context.

◆ BoxLabelCls()

virtual TBuilder Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >.BoxLabelCls ( string  boxLabelCls)
inlinevirtual

◆ BoxLabelStyle()

virtual TBuilder Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >.BoxLabelStyle ( string  boxLabelStyle)
inlinevirtual

◆ Checked()

virtual TBuilder Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >.Checked ( bool  _checked)
inlinevirtual

True if the the checkbox should render already checked (defaults to false).

◆ CheckedCls()

virtual TBuilder Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >.CheckedCls ( string  checkedCls)
inlinevirtual

The CSS class added to the component's main element when it is in the checked state.

◆ Handler()

virtual TBuilder Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >.Handler ( string  handler)
inlinevirtual

A function called when the checked value changes (can be used instead of handling the change event).

◆ InputValue()

virtual TBuilder Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >.InputValue ( string  inputValue)
inlinevirtual

The value that should go into the generated input element's value attribute and should be used as the parameter value when submitting as part of a form. Defaults to "on".

◆ ModelValue()

virtual TBuilder Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >.ModelValue ( string  modelValue)
inlinevirtual

The value to use for getModelData when checked. Valid values are 'true', 'false' a number or another string value.

◆ ModelValueUnchecked()

virtual TBuilder Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >.ModelValueUnchecked ( string  modelValueUnchecked)
inlinevirtual

The value to use for getModelData when not checked. Valid values are 'true', 'false' a number or another string value. Default: 'false'.

◆ Scope()

virtual TBuilder Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >.Scope ( string  scope)
inlinevirtual

An object to use as the scope ('this' reference) of the handler function. Defaults to this Checkbox.

◆ UncheckedValue()

virtual TBuilder Ext.Net.CheckboxBase.Builder< TCheckboxBase, TBuilder >.UncheckedValue ( string  uncheckedValue)
inlinevirtual

If configured, this will be submitted as the checkbox's value during form submit if the checkbox is unchecked. By default this is undefined, which results in nothing being submitted for the checkbox field when the form is submitted (the default behavior of HTML checkboxes).


The documentation for this class was generated from the following file: