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

More...

Inheritance diagram for Ext.Net.FieldContainer.Builder< TFieldContainer, TBuilder >:
Ext.Net.FieldContainerBase.Builder< TFieldContainer, TBuilder >

Public Member Functions

 Builder (TFieldContainer component)
 
virtual TBuilder Listeners (Action< FieldContainerListeners > action)
 Client-side JavaScript Event Handlers More...
 
virtual TBuilder DirectEvents (Action< FieldContainerDirectEvents > action)
 Server-side Ajax Event Handlers More...
 
 Builder ()
 
 Builder (FieldContainer component)
 
 Builder (FieldContainer.Config config)
 
- Public Member Functions inherited from Ext.Net.FieldContainerBase.Builder< TFieldContainer, TBuilder >
 Builder (TFieldContainerBase component)
 
virtual TBuilder CombineErrors (bool combineErrors)
 If set to true, the field container will automatically combine and display the validation errors from all the fields it contains as a single error on the container, according to the configured msgTarget. Defaults to false. More...
 
virtual TBuilder CombineLabels (bool combineLabels)
 If set to true, and there is no defined fieldLabel, the field container will automatically generate its label by combining the labels of all the fields it contains. Defaults to false. More...
 
virtual TBuilder LabelConnector (string labelConnector)
 The string to use when joining the labels of individual sub-fields, when combineLabels is set to true. Defaults to ', '. More...
 
virtual TBuilder FieldDefaults (Action< Labelable > action)
 If specified, the properties in this object are used as default config values for each Ext.form.Labelable instance (e.g. Ext.form.field.Base or Ext.form.FieldContainer) that is added as a descendant of this container. Corresponding values specified in an individual field's own configuration, or from the defaults config of its parent container, will take precedence. See the documentation for Ext.form.Labelable to see what config options may be specified in the fieldDefaults. More...
 
virtual TBuilder ShrinkWrap (ShrinkWrap shrinkWrap)
 In CSS terms, shrink-wrap width is analogous to an inline-block element as opposed to a block-level element. Some container layouts always shrink-wrap their children, effectively ignoring this property (e.g., Ext.layout.container.HBox, Ext.layout.container.VBox, Ext.layout.component.Dock). The Default is "Both". More...
 
virtual TBuilder ActiveError (string activeError)
 If specified, then the component will be displayed with this value as its active error when first rendered. Defaults to undefined. Use setActiveError or unsetActiveError to change it after component creation. More...
 
virtual TBuilder ActiveErrorsTpl (Action< XTemplate > action)
 The template used to format the Array of error messages passed to setActiveErrors into a single HTML string. By default this renders each message as an item in an unordered list. More...
 
virtual TBuilder AfterLabelTextTpl (XTemplate afterLabelTextTpl)
 An optional string or XTemplate configuration to insert in the field markup after the label text. If an XTemplate is used, the component's render data serves as the context. More...
 
virtual TBuilder AutoFitErrors (bool autoFitErrors)
 Whether to adjust the component's body area to make room for 'side' or 'under' error messages. Defaults to true. More...
 
virtual TBuilder BaseBodyCls (string baseBodyCls)
 The CSS class to be applied to the body content element. Defaults to 'x-form-item-body'. More...
 
virtual TBuilder ClearCls (string clearCls)
 The CSS class used to to apply to the special clearing div rendered directly after each form field wrapper to provide field clearing (defaults to 'x-form-clear-left'). More...
 
virtual TBuilder ErrorMsgCls (string errorMsgCls)
 The CSS class to be applied to the error message element. Defaults to 'x-form-error-msg'. More...
 
virtual TBuilder FieldBodyCls (string fieldBodyCls)
 An extra CSS class to be applied to the body content element in addition to fieldBodyCls. Defaults to empty. More...
 
virtual TBuilder FieldLabel (string fieldLabel)
 The label for the field. It gets appended with the labelSeparator, and its position and sizing is determined by the labelAlign, labelWidth, and labelPad configs. Defaults to undefined. More...
 
virtual TBuilder FormItemCls (string formItemCls)
 A CSS class to be applied to the outermost element to denote that it is participating in the form field layout. Defaults to 'x-form-item'. More...
 
virtual TBuilder HideEmptyLabel (bool hideEmptyLabel)
 When set to true, the label element (fieldLabel and labelSeparator) will be automatically hidden if the fieldLabel is empty. More...
 
virtual TBuilder HideLabel (bool hideLabel)
 Set to true to completely hide the label element (fieldLabel and labelSeparator). Defaults to false. More...
 
virtual TBuilder InvalidCls (string invalidCls)
 The CSS class to use when marking the component invalid (defaults to 'x-form-invalid') More...
 
virtual TBuilder LabelAlign (LabelAlign labelAlign)
 Controls the position and alignment of the fieldLabel. More...
 
virtual TBuilder LabelCls (string labelCls)
 The CSS class to be applied to the label element. More...
 
virtual TBuilder LabelPad (int labelPad)
 The amount of space in pixels between the fieldLabel and the input field. Defaults to 5. More...
 
virtual TBuilder LabelSeparator (string labelSeparator)
 Character(s) to be inserted at the end of the label text. More...
 
virtual TBuilder LabelStyle (string labelStyle)
 A CSS style specification string to apply directly to this field's label. Defaults to undefined. More...
 
virtual TBuilder LabelWidth (int labelWidth)
 The width of the fieldLabel in pixels. Only applicable if the labelAlign is set to "left" or "right". Defaults to 100. More...
 
virtual TBuilder MsgTarget (MessageTarget msgTarget)
 The location where the error message text should display. More...
 
virtual TBuilder MsgTargetElement (string msgTargetElement)
 Add the error message directly to the innerHTML of the specified element. More...
 
virtual TBuilder PreventMark (bool preventMark)
 true to disable displaying any error message set on this object. Defaults to false. More...
 
virtual TBuilder PreserveIndicatorIcon (bool preserveIndicatorIcon)
 Preserve indicator icon place. Defaults to false More...
 
virtual TBuilder IndicatorText (string indicatorText)
 The indicator text. More...
 
virtual TBuilder IndicatorCls (string indicatorCls)
 The indicator css class. More...
 
virtual TBuilder IndicatorIconCls (string indicatorIconCls)
 The indicator icon class. More...
 
virtual TBuilder IndicatorIcon (Icon indicatorIcon)
 
virtual TBuilder IndicatorTip (string indicatorTip)
 The indicator tip. More...
 
virtual TBuilder IndicatorTipConfig (QTipCfg indicatorTipConfig)
 
virtual TBuilder Note (string note)
 The note. More...
 
virtual TBuilder NoteCls (string noteCls)
 The note css class. More...
 
virtual TBuilder NoteAlign (NoteAlign noteAlign)
 Note align More...
 
virtual TBuilder NoteEncode (bool noteEncode)
 True to encode note text More...
 
virtual TBuilder SetNote (string note, bool encode)
 
virtual TBuilder ShowNote ()
 
virtual TBuilder HideNote ()
 
virtual TBuilder ShowIndicator ()
 
virtual TBuilder HideIndicator ()
 
virtual TBuilder ClearIndicator ()
 
virtual TBuilder AlignIndicator ()
 
virtual TBuilder SetFieldLabel (string label)
 

Static Public Member Functions

static implicit operator Builder (FieldContainer component)
 

Detailed Description

Type Constraints
TFieldContainer :FieldContainer 
TBuilder :Builder 
TBuilder :TFieldContainer 
TBuilder :TBuilder 

Constructor & Destructor Documentation

◆ Builder() [1/4]

Ext.Net.FieldContainer.Builder< TFieldContainer, TBuilder >.Builder ( TFieldContainer  component)
inline

◆ Builder() [2/4]

Ext.Net.FieldContainer.Builder< TFieldContainer, TBuilder >.Builder ( )
inline

◆ Builder() [3/4]

Ext.Net.FieldContainer.Builder< TFieldContainer, TBuilder >.Builder ( FieldContainer  component)
inline

◆ Builder() [4/4]

Ext.Net.FieldContainer.Builder< TFieldContainer, TBuilder >.Builder ( FieldContainer.Config  config)
inline

Member Function Documentation

◆ DirectEvents()

virtual TBuilder Ext.Net.FieldContainer.Builder< TFieldContainer, TBuilder >.DirectEvents ( Action< FieldContainerDirectEvents action)
inlinevirtual

Server-side Ajax Event Handlers

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ Listeners()

virtual TBuilder Ext.Net.FieldContainer.Builder< TFieldContainer, TBuilder >.Listeners ( Action< FieldContainerListeners action)
inlinevirtual

Client-side JavaScript Event Handlers

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ operator Builder()

static implicit Ext.Net.FieldContainer.Builder< TFieldContainer, TBuilder >.operator Builder ( FieldContainer  component)
inlinestatic


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