Ext.NET  5.3.0
.NET Component Framework for Enterprise Level Apps
Ext.Net.AbstractComponent.Config Class Reference

More...

Inheritance diagram for Ext.Net.AbstractComponent.Config:
Ext.Net.Observable.Config Ext.Net.BaseControl.Config Ext.Net.IApply Ext.Net.ActionRef.Config Ext.Net.BoxSplitter.Config Ext.Net.ComponentBase.Config Ext.Net.MvcItem.Config Ext.Net.TagLabelBase.Config Ext.Net.UserControlLoader.Config Ext.Net.Widget.Config Ext.Net.AbstractCalendarView.Config Ext.Net.AbstractContainer.Config Ext.Net.AbstractDataView.Config Ext.Net.Action.Config Ext.Net.ButtonBase.Config Ext.Net.CalloutBase.Config Ext.Net.ColorButton.Config Ext.Net.ColorPicker.Config Ext.Net.Component.Config Ext.Net.DatePicker.Config Ext.Net.Field.Config Ext.Net.ImageBase.Config Ext.Net.LabelBase.Config Ext.Net.MenuItemBase.Config Ext.Net.MonthPicker.Config Ext.Net.ProgressBar.Config Ext.Net.TabStrip.Config Ext.Net.Tool.Config Ext.Net.ToolbarFill.Config Ext.Net.ToolbarItem.Config Ext.Net.TagLabel.Config Ext.Net.Gauge.Config Ext.Net.ProgressBarWidget.Config Ext.Net.SliderWidget.Config Ext.Net.SparklineBase.Config Ext.Net.TreeList.Config

Properties

virtual string Action [get, set]
 Specifies an action for this component More...
 
virtual string TagHiddenName [get, set]
 
virtual object Tag [get, set]
 An Object that contains data about the Component. The default is a null reference. More...
 
virtual string TagString [get, set]
 
virtual string AlignTarget [get, set]
 A Component or Element by which to position this component according to the defaultAlign. Defaults to ths owning Container. Only applicable if this component is floating. Used upon first show. More...
 
virtual JsonObject AriaAttributes [get, set]
 An object containing ARIA attributes to be set on this Component's ARIA element. Use this to set the attributes that cannot be determined by the Component's state. Defaults to: {$value: null, lazy: true} More...
 
virtual string AriaDescribedBy [get, set]
 DOM selector for a child element that is to be used as description for this Component, set in aria-describedby attribute. The selector works the same way as ariaLabelledBy. More...
 
virtual string AriaLabel [get, set]
 ARIA label for this Component. It is best to use ariaLabelledBy option instead, because screen readers prefer aria-labelledby attribute to aria-label. ariaLabelledBy takes precedence if both specified. More...
 
virtual string AriaLabelledBy [get, set]
 DOM selector for a child element that is to be used as label for this Component, set in aria-labelledby attribute. If the selector is by #id, the label element can be any existing element, not necessarily a child of the main Component element. Overrides ariaLabel if both specified. More...
 
virtual string AriaRole [get, set]
 ARIA role for this Component, defaults to no role. With no role, no other ARIA attributes are set. More...
 
DomObject AutoEl [get]
 A tag name or DomHelper spec used to create the Element which will encapsulate this AbstractComponent. More...
 
ParameterCollection Bind [get]
 Setting this config option adds or removes data bindings for other configs. More...
 
virtual object ViewModel [get, set]
 
virtual object BindObject [get, set]
 
virtual string BindString [get, set]
 
virtual bool DestroyContent [get, set]
 If true then component will search components inside Content area and destroy it during own destroy More...
 
virtual bool AutoRender [get, set]
 This config is intended mainly for floating Components which may or may not be shown. Instead of using renderTo in the configuration, and rendering upon construction, this allows a AbstractComponent to render itself upon first show. Default is false. More...
 
virtual string AutoRenderElement [get, set]
 This config is intended mainly for floating Components which may or may not be shown. Instead of using renderTo in the configuration, and rendering upon construction, this allows a AbstractComponent to render itself upon first show. Default is false. More...
 
virtual bool AutoShow [get, set]
 True to automatically show the component upon creation. This config option may only be used for floating components or components that use autoRender. Defaults to false. More...
 
virtual string BaseCls [get, set]
 The base CSS class to apply to this components's element. This will also be prepended to elements within this component like Panel's body will get a class x-panel-body. This means that if you create a subclass of Panel, and you want it to get all the Panels styling for the element and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this component. More...
 
virtual ? bool Border [get, set]
 Specify false to turn off the border for this component. More...
 
virtual string BorderSpec [get, set]
 Specifies the border for this component. The border can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10'. More...
 
ChildElementCollection ChildEls [get]
 An array describing the child elements of the Component. More...
 
virtual string Cls [get, set]
 An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules. More...
 
virtual string ComponentCls [get, set]
 CSS Class to be added to a components root level element to give distinction to it via styling. More...
 
virtual string ComponentLayout [get, set]
 
virtual string CtCls [get, set]
 An optional extra CSS class that will be added to this component's container. This can be useful for adding customized styles to the container or any of its children using standard CSS rules. More...
 
virtual bool Constrain [get, set]
 True to constrain this Components within its containing element, false to allow it to fall outside of its containing element. By default this Component will be rendered to document.body. To render and constrain this Component within another element specify renderTo. Defaults to: false More...
 
virtual string ConstrainToElement [get, set]
 A Region (or an element from which a Region measurement will be read) which is used to constrain the component. Only applies when the component is floating. More...
 
virtual System.Drawing.? Rectangle ConstrainToRegion [get, set]
 A Region (or an element from which a Region measurement will be read) which is used to constrain the component. Only applies when the component is floating. More...
 
virtual string ConstraintInsets [get, set]
 An object or a string (in TRBL order) specifying insets from the configured constrain region within which this component must be constrained when positioning or sizing. example: constraintInsets: '10 10 10 10' // Constrain with 10px insets from parent More...
 
virtual object Data [get, set]
 The initial set of data to apply to the tpl to update the content area of the AbstractComponent. More...
 
virtual string DefaultAlign [get, set]
 The default Ext.dom.Element::getAlignToXY anchor position value for this component relative to its alignTarget (which defaults to its owning Container). Only applicable if this component is floating. Used upon first show. Defaults to: "c-c" More...
 
virtual bool Disabled [get, set]
 Render this component disabled (default is false). More...
 
virtual string DisabledCls [get, set]
 CSS class to add when the AbstractComponent is disabled. Defaults to 'x-item-disabled'. More...
 
virtual Dock Dock [get, set]
 The dock position of this component in its parent panel More...
 
virtual bool Fixed [get, set]
 Configure as true to have this Component fixed at its X, Y coordinates in the browser viewport, immune to scrolling the document. Defaults to: false More...
 
virtual bool Floating [get, set]
 Specify as true to float the AbstractComponent outside of the document flow using CSS absolute positioning. More...
 
virtual LayerConfig FloatingConfig [get, set]
 Additional floating configs More...
 
virtual bool Frame [get, set]
 Specify as true to have the AbstractComponent inject framing elements within the AbstractComponent at render time to provide a graphical rounded frame around the AbstractComponent content. More...
 
virtual bool FormBind [get, set]
 Any component within the FormPanel can be configured with formBind: true. This will cause that component to be automatically disabled when the form is invalid, and enabled when it is valid. This is most commonly used for Button components to prevent submitting the form in an invalid state, but can be used on any component type. More...
 
virtual ? bool Focusable [get, set]
 Set to true for interactive Components, false for static Components. For Containers, this property reflects interactiveness of the Container itself, not its children. Defaults to false. More...
 
virtual string FocusCls [get, set]
 CSS class that will be added to focused Component, and removed when Component blurs. More...
 
override Unit Height [get, set]
 The height of this component in pixels. More...
 
virtual string HeightSpec [get, set]
 
virtual bool Hidden [get, set]
 Render this component hidden (default is false). If true, the hide method will be called internally. More...
 
virtual HideMode HideMode [get, set]
 A String which specifies how this AbstractComponent's encapsulating DOM element will be hidden. More...
 
virtual string Html [get, set]
 An HTML fragment, or a DomHelper specification to use as the layout element content (defaults to '') More...
 
virtual ? bool LiquidLayout [get, set]
 
virtual ComponentLoader Loader [get, set]
 A configuration object or an instance of a Ext.ComponentLoader to load remote content for this AbstractComponent. More...
 
virtual ? int Margin [get, set]
 Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10'. More...
 
virtual string MarginSpec [get, set]
 Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10'. More...
 
virtual string MaskElement [get, set]
 The name of the element property in this component to mask when masked by a LoadMask. More...
 
virtual ? bool MaskOnDisable [get, set]
 This is an internal flag that you use when creating custom components. More...
 
virtual ? int MaxHeight [get, set]
 The maximum value in pixels which this AbstractComponent will set its height to. More...
 
virtual ? int MaxWidth [get, set]
 The maximum value in pixels which this AbstractComponent will set its width to. More...
 
virtual ? int MinHeight [get, set]
 The minimum value in pixels which this AbstractComponent will set its height to. More...
 
virtual ? int MinWidth [get, set]
 The minimum value in pixels which this AbstractComponent will set its width to. More...
 
virtual ? bool ModelValidation [get, set]
 This config enables binding to your Ext.data.Model.validators. More...
 
virtual string OverCls [get, set]
 An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and removed when the mouse moves out. (defaults to ''). This can be useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. More...
 
virtual ? int Padding [get, set]
 Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10'. More...
 
virtual string PaddingSpec [get, set]
 Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10'. More...
 
ItemsCollection< PluginPlugins [get]
 An object or array of objects that will provide custom functionality for this component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.AbstractComponent. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality. More...
 
virtual string Publishes [get, set]
 One or more names of config properties that this component should publish to its ViewModel. Some components override this and publish their most useful configs by default. More...
 
virtual string[] PublishesArray [get, set]
 One or more names of config properties that this component should publish to its ViewModel. Some components override this and publish their most useful configs by default. More...
 
virtual object PublishesObject [get, set]
 One or more names of config properties that this component should publish to its ViewModel. Some components override this and publish their most useful configs by default. More...
 
virtual string Reference [get, set]
 Specifies a name for this component inside its component hierarchy. This name must be unique within its view or its ViewController. See the documentation in Ext.container.Container for more information about references. More...
 
ParameterCollection RenderData [get]
 The data used by renderTpl in addition to the following property values of the component : id, ui, uiCls, baseCls, componentCls, frame More...
 
virtual object RenderDataObject [get, set]
 The data used by renderTpl in addition to the following property values of the component More...
 
ParameterCollection RenderSelectors [get]
 An object containing properties specifying DomQuery selectors which identify child elements created by the render process. More...
 
virtual string RenderTo [get, set]
 Specify the id of the element, a DOM element or an existing Element that this component will be rendered into. More...
 
virtual ? bool RTL [get, set]
 True to layout this component and its descendants in "rtl" (right-to-left) mode. Can be explicitly set to false to override a true value inherited from an ancestor. More...
 
virtual bool Session [get, set]
 If provided this creates a new Session instance for this component. If this is a Container, this will then be inherited by all child components. More...
 
virtual object TouchAction [get, set]
 Emulates the behavior of the CSS touch-action property in a cross-browser compatible manner. More...
 
virtual XTemplate RenderTpl [get, set]
 An XTemplate used to create the internal structure inside this AbstractComponent's encapsulating Element. More...
 
virtual ShrinkWrap ShrinkWrap [get, set]
 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 "Height". More...
 
virtual string StyleSpec [get, set]
 A custom style specification to be applied to this component's Element. More...
 
virtual string StyleHtmlCls [get, set]
 The class that is added to the content target when you set styleHtmlContent to true. Defaults to 'x-html' More...
 
virtual bool StyleHtmlContent [get, set]
 True to automatically style the html inside the content target of this component (body for panels). Defaults to false. More...
 
virtual XTemplate Tpl [get, set]
 An XTemplate used to create the internal structure inside this AbstractComponent's encapsulating Element. More...
 
virtual TemplateWriteMode TplWriteMode [get, set]
 The Ext.(X)Template method to use when updating the content area of the AbstractComponent. Defaults to 'overwrite' More...
 
override short TabIndex [get, set]
 DOM tabIndex attribute for this Focusable More...
 
virtual UI UI [get, set]
 A set of predefined ui styles for individual components. Most components support 'light' and 'dark'. Extra string added to the baseCls with an extra '-'. More...
 
virtual string UIName [get, set]
 A set of predefined ui styles for individual components. Most components support 'light' and 'dark'. Extra string added to the baseCls with an extra '-'. More...
 
virtual string UserCls [get, set]
 One or more CSS classes to add to the component's primary element. This config is intended solely for use by the component instantiator (the "user"), not by derived classes. More...
 
override Unit Width [get, set]
 The width of this component in pixels. More...
 
virtual string WidthSpec [get, set]
 
virtual JFunction PreInit [get, set]
 
virtual KeyBindItemCollection KeyMap [get, set]
 An object containing handlers for keyboard events. More...
 
virtual KeyNav KeyNav [get, set]
 
ResponsiveRules ResponsiveConfig [get]
 
ResponsiveFormulas ResponsiveFormulas [get]
 
virtual string Anchor [get, set]
 This config is only used when this AbstractComponent is rendered by a Container which has been configured to use an AnchorLayout based layout manager More...
 
virtual string DefaultAnchor [get, set]
 The DefaultAnchor is applied as the Anchor config item to all child Items during render. More...
 
virtual string AnchorHorizontal [get, set]
 See Anchor property More...
 
virtual string AnchorVertical [get, set]
 See Anchor property More...
 
virtual Region Region [get, set]
 Note: this config is only used when this AbstractComponent is rendered by a Container which has been configured to use the BorderLayout layout manager (e.g. specifying layout:'border'). More...
 
virtual bool SplitterResize [get, set]
 This configuration option is to be applied to the child items managed by this layout and is used in conjunction with split. By default, when specifying split, the region can be dragged to be resized. Set this option to false to show the split bar but prevent resizing. Defaults to: true More...
 
virtual bool Split [get, set]
 Only actual for items managed by Border layout. Each region with Split="true" will get a Splitter that allows for manual resizing of the container. Except for the center region. More...
 
virtual BoxSplitter SplitterConfig [get, set]
 Only actual for items managed by Border layout. Each region with a SplitterConfig will get a Splitter that allows for manual resizing of the container. Except for the center region. More...
 
virtual double ColumnWidth [get, set]
 The ColumnWidth property is only used with ColumnLayout is used. The ColumnWidth property is always evaluated as a percentage, and must be a decimal value greater than 0 and less than 1. More...
 
virtual int Flex [get, set]
 NOTE: This property is only used when the parent Layout is HBoxLayout or VBoxLayout. This configuation option is to be applied to child items of the container managed by this layout. Each child item with a flex property will be flexed horizontally according to each item's relative flex value compared to the sum of all items with a flex value specified. Any child items that have either a flex = 0 or flex = undefined will not be 'flexed' (the initial size will not be changed). More...
 
virtual bool Reorderable [get, set]
 False to disallow reordering for this Component. More...
 
virtual int RowSpan [get, set]
 Applied to the table cell containing the item. More...
 
virtual int ColSpan [get, set]
 Applied to the table cell containing the item. More...
 
virtual string CellCls [get, set]
 CSS class name added to the table cell containing the item. More...
 
virtual string CellId [get, set]
 An id applied to the table cell containing the item. More...
 
virtual string ContextMenuID [get, set]
 
ItemsCollection< ObservableBin [get]
 
virtual int SaveDelay [get, set]
 A buffer to be applied if many state events are fired within a short period (defaults to 100). More...
 
virtual string[] StateEvents [get, set]
 An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be any types of events supported by this component, including browser or custom events (e.g., ['click', 'customerchange']). More...
 
virtual string StateID [get, set]
 The unique id for this component to use for state management purposes (defaults to the component id). More...
 
virtual bool Stateful [get, set]
 A flag which causes the AbstractComponent to attempt to restore the state of internal properties from a saved state on startup. Defaults to false. More...
 
JFunction GetState [get]
 Return component's data which should be saved by StateProvider More...
 
virtual bool AlwaysOnTop [get, set]
 A flag indicating that this component should be on the top of the z-index stack for use by the zIndexManager to sort its stack. Defaults to false. More...
 
virtual int AlwaysOnTopIndex [get, set]
 A flag indicating that this component should be on the top of the z-index stack for use by the zIndexManager to sort its stack. Defaults to false. More...
 
virtual ? bool AnimateShadow [get, set]
 
virtual bool FocusOnToFront [get, set]
 Specifies whether the floated component should be automatically focused when it is brought to the front. Defaults to true. More...
 
virtual bool Shadow [get, set]
 Specifies whether the floating component should be given a shadow. Set to true to automatically create an Ext.Shadow, or a string indicating the shadow's display Ext.Shadow.mode. Set to false to disable the shadow. (Defaults to 'sides'.) More...
 
virtual ShadowMode ShadowMode [get, set]
 Specifies whether the floating component should be given a shadow. Set to true to automatically create an Ext.Shadow, or a string indicating the shadow's display Ext.Shadow.mode. Set to false to disable the shadow. (Defaults to 'sides'.) More...
 
virtual int ShadowOffset [get, set]
 
virtual ? bool Shim [get, set]
 
ItemsCollection< ToolTipToolTips [get]
 A collection of ToolTip configs used to add ToolTips to the AbstractComponent More...
 
ItemsCollection< CalloutCallouts [get]
 A collection of ToolTip configs used to add ToolTips to the AbstractComponent More...
 
virtual bool AutoFocus [get, set]
 True to automatically set the focus after render (defaults to false). More...
 
virtual int AutoFocusDelay [get, set]
 Focus delay (in milliseconds) when AutoFocus is true. More...
 
virtual bool Selectable [get, set]
 Determines if this component is selectable. (default is true). More...
 
virtual Unit PageX [get, set]
 The page level x coordinate for this component if contained within a positioning container. More...
 
virtual Unit PageY [get, set]
 The page level y coordinate for this component if contained within a positioning container. More...
 
virtual int X [get, set]
 The local x (left) coordinate for this component if contained within a positioning container. More...
 
virtual int Y [get, set]
 The local y (addToStart) coordinate for this component if contained within a positioning container. More...
 
virtual int Weight [get, set]
 Weight of docked item More...
 
- Properties inherited from Ext.Net.Observable.Config
ConfigItemCollection CustomConfig [get]
 Collection of custom js config More...
 
MessageBusListeners MessageBusListeners [get]
 
MessageBusDirectEvents MessageBusDirectEvents [get]
 
- Properties inherited from Ext.Net.BaseControl.Config
virtual string ItemID [get, set]
 An itemId can be used as an alternative way to get a reference to a component when no object reference is available. More...
 
virtual bool Disabled [get, set]
 
virtual short TabIndex [get, set]
 
virtual bool IsInForm [get, set]
 
virtual Unit Height [get, set]
 
virtual Unit Width [get, set]
 
virtual string ToolTip [get, set]
 
virtual bool RegisterAllResources [get, set]
 
virtual bool AutoDataBind [get, set]
 
virtual IDMode IDMode [get, set]
 
virtual LazyMode LazyMode [get, set]
 
virtual string Namespace [get, set]
 
List< ClientResourceItemResourceItems [get]
 

Additional Inherited Members

- Public Member Functions inherited from Ext.Net.BaseControl.Config
override string ToString ()
 
override bool Equals (object obj)
 
override int GetHashCode ()
 
new Type GetType ()
 
object ApplyIf (object obj)
 
Apply< T > (object obj)
 
object Apply (object obj)
 
virtual string ToScript ()
 
- Static Public Member Functions inherited from Ext.Net.BaseControl.Config
static Config ToConfig (string config)
 
static TConfig ToConfig< TConfig > (string config)
 

Detailed Description

Property Documentation

◆ Action

virtual string Ext.Net.AbstractComponent.Config.Action
getset

Specifies an action for this component

◆ AlignTarget

virtual string Ext.Net.AbstractComponent.Config.AlignTarget
getset

A Component or Element by which to position this component according to the defaultAlign. Defaults to ths owning Container. Only applicable if this component is floating. Used upon first show.

◆ AlwaysOnTop

virtual bool Ext.Net.AbstractComponent.Config.AlwaysOnTop
getset

A flag indicating that this component should be on the top of the z-index stack for use by the zIndexManager to sort its stack. Defaults to false.

◆ AlwaysOnTopIndex

virtual int Ext.Net.AbstractComponent.Config.AlwaysOnTopIndex
getset

A flag indicating that this component should be on the top of the z-index stack for use by the zIndexManager to sort its stack. Defaults to false.

◆ Anchor

virtual string Ext.Net.AbstractComponent.Config.Anchor
getset

This config is only used when this AbstractComponent is rendered by a Container which has been configured to use an AnchorLayout based layout manager

◆ AnchorHorizontal

virtual string Ext.Net.AbstractComponent.Config.AnchorHorizontal
getset

See Anchor property

◆ AnchorVertical

virtual string Ext.Net.AbstractComponent.Config.AnchorVertical
getset

See Anchor property

◆ AnimateShadow

virtual ? bool Ext.Net.AbstractComponent.Config.AnimateShadow
getset

◆ AriaAttributes

virtual JsonObject Ext.Net.AbstractComponent.Config.AriaAttributes
getset

An object containing ARIA attributes to be set on this Component's ARIA element. Use this to set the attributes that cannot be determined by the Component's state. Defaults to: {$value: null, lazy: true}

◆ AriaDescribedBy

virtual string Ext.Net.AbstractComponent.Config.AriaDescribedBy
getset

DOM selector for a child element that is to be used as description for this Component, set in aria-describedby attribute. The selector works the same way as ariaLabelledBy.

◆ AriaLabel

virtual string Ext.Net.AbstractComponent.Config.AriaLabel
getset

ARIA label for this Component. It is best to use ariaLabelledBy option instead, because screen readers prefer aria-labelledby attribute to aria-label. ariaLabelledBy takes precedence if both specified.

◆ AriaLabelledBy

virtual string Ext.Net.AbstractComponent.Config.AriaLabelledBy
getset

DOM selector for a child element that is to be used as label for this Component, set in aria-labelledby attribute. If the selector is by #id, the label element can be any existing element, not necessarily a child of the main Component element. Overrides ariaLabel if both specified.

◆ AriaRole

virtual string Ext.Net.AbstractComponent.Config.AriaRole
getset

ARIA role for this Component, defaults to no role. With no role, no other ARIA attributes are set.

◆ AutoEl

DomObject Ext.Net.AbstractComponent.Config.AutoEl
get

A tag name or DomHelper spec used to create the Element which will encapsulate this AbstractComponent.

◆ AutoFocus

virtual bool Ext.Net.AbstractComponent.Config.AutoFocus
getset

True to automatically set the focus after render (defaults to false).

◆ AutoFocusDelay

virtual int Ext.Net.AbstractComponent.Config.AutoFocusDelay
getset

Focus delay (in milliseconds) when AutoFocus is true.

◆ AutoRender

virtual bool Ext.Net.AbstractComponent.Config.AutoRender
getset

This config is intended mainly for floating Components which may or may not be shown. Instead of using renderTo in the configuration, and rendering upon construction, this allows a AbstractComponent to render itself upon first show. Default is false.

◆ AutoRenderElement

virtual string Ext.Net.AbstractComponent.Config.AutoRenderElement
getset

This config is intended mainly for floating Components which may or may not be shown. Instead of using renderTo in the configuration, and rendering upon construction, this allows a AbstractComponent to render itself upon first show. Default is false.

◆ AutoShow

virtual bool Ext.Net.AbstractComponent.Config.AutoShow
getset

True to automatically show the component upon creation. This config option may only be used for floating components or components that use autoRender. Defaults to false.

◆ BaseCls

virtual string Ext.Net.AbstractComponent.Config.BaseCls
getset

The base CSS class to apply to this components's element. This will also be prepended to elements within this component like Panel's body will get a class x-panel-body. This means that if you create a subclass of Panel, and you want it to get all the Panels styling for the element and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this component.

◆ Bin

ItemsCollection<Observable> Ext.Net.AbstractComponent.Config.Bin
get

◆ Bind

ParameterCollection Ext.Net.AbstractComponent.Config.Bind
get

Setting this config option adds or removes data bindings for other configs.

◆ BindObject

virtual object Ext.Net.AbstractComponent.Config.BindObject
getset

◆ BindString

virtual string Ext.Net.AbstractComponent.Config.BindString
getset

◆ Border

virtual ? bool Ext.Net.AbstractComponent.Config.Border
getset

Specify false to turn off the border for this component.

◆ BorderSpec

virtual string Ext.Net.AbstractComponent.Config.BorderSpec
getset

Specifies the border for this component. The border can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10'.

◆ Callouts

ItemsCollection<Callout> Ext.Net.AbstractComponent.Config.Callouts
get

A collection of ToolTip configs used to add ToolTips to the AbstractComponent

◆ CellCls

virtual string Ext.Net.AbstractComponent.Config.CellCls
getset

CSS class name added to the table cell containing the item.

◆ CellId

virtual string Ext.Net.AbstractComponent.Config.CellId
getset

An id applied to the table cell containing the item.

◆ ChildEls

ChildElementCollection Ext.Net.AbstractComponent.Config.ChildEls
get

An array describing the child elements of the Component.

◆ Cls

virtual string Ext.Net.AbstractComponent.Config.Cls
getset

An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules.

◆ ColSpan

virtual int Ext.Net.AbstractComponent.Config.ColSpan
getset

Applied to the table cell containing the item.

◆ ColumnWidth

virtual double Ext.Net.AbstractComponent.Config.ColumnWidth
getset

The ColumnWidth property is only used with ColumnLayout is used. The ColumnWidth property is always evaluated as a percentage, and must be a decimal value greater than 0 and less than 1.

◆ ComponentCls

virtual string Ext.Net.AbstractComponent.Config.ComponentCls
getset

CSS Class to be added to a components root level element to give distinction to it via styling.

◆ ComponentLayout

virtual string Ext.Net.AbstractComponent.Config.ComponentLayout
getset

◆ Constrain

virtual bool Ext.Net.AbstractComponent.Config.Constrain
getset

True to constrain this Components within its containing element, false to allow it to fall outside of its containing element. By default this Component will be rendered to document.body. To render and constrain this Component within another element specify renderTo. Defaults to: false

◆ ConstraintInsets

virtual string Ext.Net.AbstractComponent.Config.ConstraintInsets
getset

An object or a string (in TRBL order) specifying insets from the configured constrain region within which this component must be constrained when positioning or sizing. example: constraintInsets: '10 10 10 10' // Constrain with 10px insets from parent

◆ ConstrainToElement

virtual string Ext.Net.AbstractComponent.Config.ConstrainToElement
getset

A Region (or an element from which a Region measurement will be read) which is used to constrain the component. Only applies when the component is floating.

◆ ConstrainToRegion

virtual System.Drawing.? Rectangle Ext.Net.AbstractComponent.Config.ConstrainToRegion
getset

A Region (or an element from which a Region measurement will be read) which is used to constrain the component. Only applies when the component is floating.

◆ ContextMenuID

virtual string Ext.Net.AbstractComponent.Config.ContextMenuID
getset

◆ CtCls

virtual string Ext.Net.AbstractComponent.Config.CtCls
getset

An optional extra CSS class that will be added to this component's container. This can be useful for adding customized styles to the container or any of its children using standard CSS rules.

◆ Data

virtual object Ext.Net.AbstractComponent.Config.Data
getset

The initial set of data to apply to the tpl to update the content area of the AbstractComponent.

◆ DefaultAlign

virtual string Ext.Net.AbstractComponent.Config.DefaultAlign
getset

The default Ext.dom.Element::getAlignToXY anchor position value for this component relative to its alignTarget (which defaults to its owning Container). Only applicable if this component is floating. Used upon first show. Defaults to: "c-c"

◆ DefaultAnchor

virtual string Ext.Net.AbstractComponent.Config.DefaultAnchor
getset

The DefaultAnchor is applied as the Anchor config item to all child Items during render.

◆ DestroyContent

virtual bool Ext.Net.AbstractComponent.Config.DestroyContent
getset

If true then component will search components inside Content area and destroy it during own destroy

◆ Disabled

virtual bool Ext.Net.AbstractComponent.Config.Disabled
getset

Render this component disabled (default is false).

◆ DisabledCls

virtual string Ext.Net.AbstractComponent.Config.DisabledCls
getset

CSS class to add when the AbstractComponent is disabled. Defaults to 'x-item-disabled'.

◆ Dock

virtual Dock Ext.Net.AbstractComponent.Config.Dock
getset

The dock position of this component in its parent panel

◆ Fixed

virtual bool Ext.Net.AbstractComponent.Config.Fixed
getset

Configure as true to have this Component fixed at its X, Y coordinates in the browser viewport, immune to scrolling the document. Defaults to: false

◆ Flex

virtual int Ext.Net.AbstractComponent.Config.Flex
getset

NOTE: This property is only used when the parent Layout is HBoxLayout or VBoxLayout. This configuation option is to be applied to child items of the container managed by this layout. Each child item with a flex property will be flexed horizontally according to each item's relative flex value compared to the sum of all items with a flex value specified. Any child items that have either a flex = 0 or flex = undefined will not be 'flexed' (the initial size will not be changed).

◆ Floating

virtual bool Ext.Net.AbstractComponent.Config.Floating
getset

Specify as true to float the AbstractComponent outside of the document flow using CSS absolute positioning.

◆ FloatingConfig

virtual LayerConfig Ext.Net.AbstractComponent.Config.FloatingConfig
getset

Additional floating configs

◆ Focusable

virtual ? bool Ext.Net.AbstractComponent.Config.Focusable
getset

Set to true for interactive Components, false for static Components. For Containers, this property reflects interactiveness of the Container itself, not its children. Defaults to false.

◆ FocusCls

virtual string Ext.Net.AbstractComponent.Config.FocusCls
getset

CSS class that will be added to focused Component, and removed when Component blurs.

◆ FocusOnToFront

virtual bool Ext.Net.AbstractComponent.Config.FocusOnToFront
getset

Specifies whether the floated component should be automatically focused when it is brought to the front. Defaults to true.

◆ FormBind

virtual bool Ext.Net.AbstractComponent.Config.FormBind
getset

Any component within the FormPanel can be configured with formBind: true. This will cause that component to be automatically disabled when the form is invalid, and enabled when it is valid. This is most commonly used for Button components to prevent submitting the form in an invalid state, but can be used on any component type.

◆ Frame

virtual bool Ext.Net.AbstractComponent.Config.Frame
getset

Specify as true to have the AbstractComponent inject framing elements within the AbstractComponent at render time to provide a graphical rounded frame around the AbstractComponent content.

◆ GetState

JFunction Ext.Net.AbstractComponent.Config.GetState
get

Return component's data which should be saved by StateProvider

◆ Height

override Unit Ext.Net.AbstractComponent.Config.Height
getset

The height of this component in pixels.

◆ HeightSpec

virtual string Ext.Net.AbstractComponent.Config.HeightSpec
getset

◆ Hidden

virtual bool Ext.Net.AbstractComponent.Config.Hidden
getset

Render this component hidden (default is false). If true, the hide method will be called internally.

◆ HideMode

virtual HideMode Ext.Net.AbstractComponent.Config.HideMode
getset

A String which specifies how this AbstractComponent's encapsulating DOM element will be hidden.

◆ Html

virtual string Ext.Net.AbstractComponent.Config.Html
getset

An HTML fragment, or a DomHelper specification to use as the layout element content (defaults to '')

◆ KeyMap

virtual KeyBindItemCollection Ext.Net.AbstractComponent.Config.KeyMap
getset

An object containing handlers for keyboard events.

◆ KeyNav

virtual KeyNav Ext.Net.AbstractComponent.Config.KeyNav
getset

◆ LiquidLayout

virtual ? bool Ext.Net.AbstractComponent.Config.LiquidLayout
getset

◆ Loader

virtual ComponentLoader Ext.Net.AbstractComponent.Config.Loader
getset

A configuration object or an instance of a Ext.ComponentLoader to load remote content for this AbstractComponent.

◆ Margin

virtual ? int Ext.Net.AbstractComponent.Config.Margin
getset

Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10'.

◆ MarginSpec

virtual string Ext.Net.AbstractComponent.Config.MarginSpec
getset

Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10'.

◆ MaskElement

virtual string Ext.Net.AbstractComponent.Config.MaskElement
getset

The name of the element property in this component to mask when masked by a LoadMask.

◆ MaskOnDisable

virtual ? bool Ext.Net.AbstractComponent.Config.MaskOnDisable
getset

This is an internal flag that you use when creating custom components.

By default this is set to true which means that every component gets a mask when its disabled.

Components like FieldContainer, FieldSet, Field, Button, Tab override this property to false since they want to implement custom disable logic.

◆ MaxHeight

virtual ? int Ext.Net.AbstractComponent.Config.MaxHeight
getset

The maximum value in pixels which this AbstractComponent will set its height to.

◆ MaxWidth

virtual ? int Ext.Net.AbstractComponent.Config.MaxWidth
getset

The maximum value in pixels which this AbstractComponent will set its width to.

◆ MinHeight

virtual ? int Ext.Net.AbstractComponent.Config.MinHeight
getset

The minimum value in pixels which this AbstractComponent will set its height to.

◆ MinWidth

virtual ? int Ext.Net.AbstractComponent.Config.MinWidth
getset

The minimum value in pixels which this AbstractComponent will set its width to.

◆ ModelValidation

virtual ? bool Ext.Net.AbstractComponent.Config.ModelValidation
getset

This config enables binding to your Ext.data.Model.validators.

◆ OverCls

virtual string Ext.Net.AbstractComponent.Config.OverCls
getset

An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and removed when the mouse moves out. (defaults to ''). This can be useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.

◆ Padding

virtual ? int Ext.Net.AbstractComponent.Config.Padding
getset

Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10'.

◆ PaddingSpec

virtual string Ext.Net.AbstractComponent.Config.PaddingSpec
getset

Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10'.

◆ PageX

virtual Unit Ext.Net.AbstractComponent.Config.PageX
getset

The page level x coordinate for this component if contained within a positioning container.

◆ PageY

virtual Unit Ext.Net.AbstractComponent.Config.PageY
getset

The page level y coordinate for this component if contained within a positioning container.

◆ Plugins

ItemsCollection<Plugin> Ext.Net.AbstractComponent.Config.Plugins
get

An object or array of objects that will provide custom functionality for this component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.AbstractComponent. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.

◆ PreInit

virtual JFunction Ext.Net.AbstractComponent.Config.PreInit
getset

◆ Publishes

virtual string Ext.Net.AbstractComponent.Config.Publishes
getset

One or more names of config properties that this component should publish to its ViewModel. Some components override this and publish their most useful configs by default.

◆ PublishesArray

virtual string [] Ext.Net.AbstractComponent.Config.PublishesArray
getset

One or more names of config properties that this component should publish to its ViewModel. Some components override this and publish their most useful configs by default.

◆ PublishesObject

virtual object Ext.Net.AbstractComponent.Config.PublishesObject
getset

One or more names of config properties that this component should publish to its ViewModel. Some components override this and publish their most useful configs by default.

◆ Reference

virtual string Ext.Net.AbstractComponent.Config.Reference
getset

Specifies a name for this component inside its component hierarchy. This name must be unique within its view or its ViewController. See the documentation in Ext.container.Container for more information about references.

◆ Region

virtual Region Ext.Net.AbstractComponent.Config.Region
getset

Note: this config is only used when this AbstractComponent is rendered by a Container which has been configured to use the BorderLayout layout manager (e.g. specifying layout:'border').

◆ RenderData

ParameterCollection Ext.Net.AbstractComponent.Config.RenderData
get

The data used by renderTpl in addition to the following property values of the component : id, ui, uiCls, baseCls, componentCls, frame

◆ RenderDataObject

virtual object Ext.Net.AbstractComponent.Config.RenderDataObject
getset

The data used by renderTpl in addition to the following property values of the component

◆ RenderSelectors

ParameterCollection Ext.Net.AbstractComponent.Config.RenderSelectors
get

An object containing properties specifying DomQuery selectors which identify child elements created by the render process.

◆ RenderTo

virtual string Ext.Net.AbstractComponent.Config.RenderTo
getset

Specify the id of the element, a DOM element or an existing Element that this component will be rendered into.

◆ RenderTpl

virtual XTemplate Ext.Net.AbstractComponent.Config.RenderTpl
getset

An XTemplate used to create the internal structure inside this AbstractComponent's encapsulating Element.

◆ Reorderable

virtual bool Ext.Net.AbstractComponent.Config.Reorderable
getset

False to disallow reordering for this Component.

◆ ResponsiveConfig

ResponsiveRules Ext.Net.AbstractComponent.Config.ResponsiveConfig
get

◆ ResponsiveFormulas

ResponsiveFormulas Ext.Net.AbstractComponent.Config.ResponsiveFormulas
get

◆ RowSpan

virtual int Ext.Net.AbstractComponent.Config.RowSpan
getset

Applied to the table cell containing the item.

◆ RTL

virtual ? bool Ext.Net.AbstractComponent.Config.RTL
getset

True to layout this component and its descendants in "rtl" (right-to-left) mode. Can be explicitly set to false to override a true value inherited from an ancestor.

◆ SaveDelay

virtual int Ext.Net.AbstractComponent.Config.SaveDelay
getset

A buffer to be applied if many state events are fired within a short period (defaults to 100).

◆ Selectable

virtual bool Ext.Net.AbstractComponent.Config.Selectable
getset

Determines if this component is selectable. (default is true).

◆ Session

virtual bool Ext.Net.AbstractComponent.Config.Session
getset

If provided this creates a new Session instance for this component. If this is a Container, this will then be inherited by all child components.

◆ Shadow

virtual bool Ext.Net.AbstractComponent.Config.Shadow
getset

Specifies whether the floating component should be given a shadow. Set to true to automatically create an Ext.Shadow, or a string indicating the shadow's display Ext.Shadow.mode. Set to false to disable the shadow. (Defaults to 'sides'.)

◆ ShadowMode

virtual ShadowMode Ext.Net.AbstractComponent.Config.ShadowMode
getset

Specifies whether the floating component should be given a shadow. Set to true to automatically create an Ext.Shadow, or a string indicating the shadow's display Ext.Shadow.mode. Set to false to disable the shadow. (Defaults to 'sides'.)

◆ ShadowOffset

virtual int Ext.Net.AbstractComponent.Config.ShadowOffset
getset

◆ Shim

virtual ? bool Ext.Net.AbstractComponent.Config.Shim
getset

◆ ShrinkWrap

virtual ShrinkWrap Ext.Net.AbstractComponent.Config.ShrinkWrap
getset

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 "Height".

◆ Split

virtual bool Ext.Net.AbstractComponent.Config.Split
getset

Only actual for items managed by Border layout. Each region with Split="true" will get a Splitter that allows for manual resizing of the container. Except for the center region.

◆ SplitterConfig

virtual BoxSplitter Ext.Net.AbstractComponent.Config.SplitterConfig
getset

Only actual for items managed by Border layout. Each region with a SplitterConfig will get a Splitter that allows for manual resizing of the container. Except for the center region.

◆ SplitterResize

virtual bool Ext.Net.AbstractComponent.Config.SplitterResize
getset

This configuration option is to be applied to the child items managed by this layout and is used in conjunction with split. By default, when specifying split, the region can be dragged to be resized. Set this option to false to show the split bar but prevent resizing. Defaults to: true

◆ StateEvents

virtual string [] Ext.Net.AbstractComponent.Config.StateEvents
getset

An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be any types of events supported by this component, including browser or custom events (e.g., ['click', 'customerchange']).

◆ Stateful

virtual bool Ext.Net.AbstractComponent.Config.Stateful
getset

A flag which causes the AbstractComponent to attempt to restore the state of internal properties from a saved state on startup. Defaults to false.

◆ StateID

virtual string Ext.Net.AbstractComponent.Config.StateID
getset

The unique id for this component to use for state management purposes (defaults to the component id).

◆ StyleHtmlCls

virtual string Ext.Net.AbstractComponent.Config.StyleHtmlCls
getset

The class that is added to the content target when you set styleHtmlContent to true. Defaults to 'x-html'

◆ StyleHtmlContent

virtual bool Ext.Net.AbstractComponent.Config.StyleHtmlContent
getset

True to automatically style the html inside the content target of this component (body for panels). Defaults to false.

◆ StyleSpec

virtual string Ext.Net.AbstractComponent.Config.StyleSpec
getset

A custom style specification to be applied to this component's Element.

◆ TabIndex

override short Ext.Net.AbstractComponent.Config.TabIndex
getset

DOM tabIndex attribute for this Focusable

◆ Tag

virtual object Ext.Net.AbstractComponent.Config.Tag
getset

An Object that contains data about the Component. The default is a null reference.

◆ TagHiddenName

virtual string Ext.Net.AbstractComponent.Config.TagHiddenName
getset

◆ TagString

virtual string Ext.Net.AbstractComponent.Config.TagString
getset

◆ ToolTips

ItemsCollection<ToolTip> Ext.Net.AbstractComponent.Config.ToolTips
get

A collection of ToolTip configs used to add ToolTips to the AbstractComponent

◆ TouchAction

virtual object Ext.Net.AbstractComponent.Config.TouchAction
getset

Emulates the behavior of the CSS touch-action property in a cross-browser compatible manner.

◆ Tpl

virtual XTemplate Ext.Net.AbstractComponent.Config.Tpl
getset

An XTemplate used to create the internal structure inside this AbstractComponent's encapsulating Element.

◆ TplWriteMode

virtual TemplateWriteMode Ext.Net.AbstractComponent.Config.TplWriteMode
getset

The Ext.(X)Template method to use when updating the content area of the AbstractComponent. Defaults to 'overwrite'

◆ UI

virtual UI Ext.Net.AbstractComponent.Config.UI
getset

A set of predefined ui styles for individual components. Most components support 'light' and 'dark'. Extra string added to the baseCls with an extra '-'.

◆ UIName

virtual string Ext.Net.AbstractComponent.Config.UIName
getset

A set of predefined ui styles for individual components. Most components support 'light' and 'dark'. Extra string added to the baseCls with an extra '-'.

◆ UserCls

virtual string Ext.Net.AbstractComponent.Config.UserCls
getset

One or more CSS classes to add to the component's primary element. This config is intended solely for use by the component instantiator (the "user"), not by derived classes.

◆ ViewModel

virtual object Ext.Net.AbstractComponent.Config.ViewModel
getset

◆ Weight

virtual int Ext.Net.AbstractComponent.Config.Weight
getset

Weight of docked item

◆ Width

override Unit Ext.Net.AbstractComponent.Config.Width
getset

The width of this component in pixels.

◆ WidthSpec

virtual string Ext.Net.AbstractComponent.Config.WidthSpec
getset

◆ X

virtual int Ext.Net.AbstractComponent.Config.X
getset

The local x (left) coordinate for this component if contained within a positioning container.

◆ Y

virtual int Ext.Net.AbstractComponent.Config.Y
getset

The local y (addToStart) coordinate for this component if contained within a positioning container.


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