ASPxTokenBox Members
The token box editor.Constructors
| Name | Description |
|---|---|
| ASPxTokenBox() | Initializes a new instance of the ASPxTokenBox class with default settings. |
Properties
| Name | Description |
|---|---|
| AccessibilityCompliant | This property is not in effect for the ASPxTokenBox class. |
| AccessibilityLabelText | Specifies the editor’s label text for a screen reader. |
| AccessKey | Gets or sets the access key that allows you to quickly navigate to the Web server control. Inherited from WebControl. |
| Adapter protected | Gets the browser-specific adapter for the control. Inherited from Control. |
| AllowCustomTokens | Gets or sets whether end-users can input custom tokens. |
| AllowEllipsisInText | Specifies if the combo box can automatically truncate the item’s text if it doesn’t fit into the item’s width. Inherited from ASPxAutoCompleteBoxBase. |
| AnimationType | Gets or sets a value specifying the animation type used when the editor’s drop down window is invoked. Inherited from ASPxDropDownEditBase. |
| AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. Inherited from Control. |
| Attributes | Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from WebControl. |
| AutoPostBack | Gets or sets a value that specifies whether server-side processing is required to respond to specific predefined user actions. Inherited from ASPxEdit. |
| AutoResizeWithContainer | Gets or sets a value that specifies whether the editor, whose width is a percentage value, can be resized automatically when the width of its resizable container changes. Inherited from ASPxTextEdit. |
| BackColor | Gets or sets the background color of the Web server control. Inherited from WebControl. |
| BackgroundImage | Gets the web control’s background image. Inherited from ASPxWebControl. |
| BackwardCompatibility static | Provides access to the control’s backward compatibility settings. Inherited from ASPxWebControl. |
| Border | Gets the web control’s border settings. Inherited from ASPxWebControl. |
| BorderBottom | Gets the settings of the web control’s bottom border. Inherited from ASPxWebControl. |
| BorderLeft | Gets the settings of the web control’s left border. Inherited from ASPxWebControl. |
| BorderRight | Gets the settings of the web control’s right border. Inherited from ASPxWebControl. |
| BorderTop | Gets the settings of the web control’s top border. Inherited from ASPxWebControl. |
| Bound | Gets a value that specifies whether the control is data bound. Inherited from ASPxDataWebControlBase. |
| CallbackPageSize | Gets or sets the number of items returned from the server on each callback request performed in response to a predefined client user action. Inherited from ASPxAutoCompleteBoxBase. |
| Caption | Gets or sets the editor caption. Inherited from ASPxEditBase. |
| CaptionCellStyle | Gets the style settings that define the caption cell appearance. Inherited from ASPxEditBase. |
| CaptionSettings | Provides access to the editor caption settings. Inherited from ASPxEdit. |
| CaptionStyle | Gets the style settings that define the caption appearance. Inherited from ASPxEditBase. |
| CaseSensitiveTokens | Specifies if tokens are case sensitive. |
| ChildControlsCreated protected | Gets a value that indicates whether the server control’s child controls have been created. Inherited from Control. |
| ClientEnabled | Gets or sets a value that indicates whether an editor is enabled on the client. Inherited from ASPxEditBase. |
| ClientID | Gets the control’s identifier generated by ASP.NET. Inherited from ASPxWebControlBase. |
| ClientIDMode | Gets or sets the algorithm that is used to generate the value of the ClientID property. Inherited from Control. |
| ClientIDSeparator protected | Gets a character value representing the separator character used in the ClientID property. Inherited from Control. |
| ClientInstanceName | Specifies the editor’s client programmatic identifier. Inherited from ASPxEditBase. |
| ClientReadOnly | Gets or sets whether the editor is read only on the client-side. Inherited from ASPxEdit. |
| ClientSideEvents | Gets an object that lists the client-side events specific to the ASPxTokenBox. |
| ClientVisible | Gets or sets a value that specifies the initial visibility state of an editor on the client. Inherited from ASPxEditBase. |
| Context protected | Gets the HttpContext object associated with the server control for the current Web request. Inherited from Control. |
| Controls | Gets the web control’s collection of child controls. Inherited from ASPxEditBase. |
| ControlStyle | Gets the style of the Web server control. This property is used primarily by control developers. Inherited from WebControl. |
| ControlStyleCreated | Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. Inherited from WebControl. |
| CssClass | Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. Inherited from WebControl. |
| CssFilePath | Gets or sets the path to a CSS file that defines the editor’s appearance. Inherited from ASPxEditBase. |
| CssPostfix | Gets or sets a CSS class name postfix that identifies style settings to be applied to the editor. Inherited from ASPxEditBase. |
| Cursor | Gets or sets the type of cursor to display when the mouse pointer is over the web control. Inherited from ASPxWebControl. |
| CustomButtonsPosition | Specifies the position of custom control buttons relative to the input element. Inherited from ASPxDropDownEditBase. |
| DataItemContainer | Gets a reference to the naming container if the naming container implements IDataItemContainer. Inherited from Control. |
| DataKeysContainer | Gets a reference to the naming container if the naming container implements IDataKeysControl. Inherited from Control. |
| DataSecurityMode | Provides the capability to restrict setting the editor value on the client side to values listed in the server ASPxAutoCompleteBoxBase.Items. Inherited from ASPxAutoCompleteBoxBase. |
| DataSource | Gets or sets the object from which a data-bound editor retrieves its list of data items. Inherited from ASPxAutoCompleteBoxBase. |
| DataSourceID | Specifies the ID of the control from which the editor gets data items. Inherited from ASPxAutoCompleteBoxBase. |
| DisabledCssClass static | Gets or sets the CSS class to apply to the rendered HTML element when the control is disabled. Inherited from WebControl. |
| DisabledStyle | Gets the style settings which define a control’s appearance in the disabled state. Inherited from ASPxWebControl. |
| DropDownApplyButton | Gets the settings of the ‘Apply’ command buttons in dropdown editors. Inherited from ASPxDropDownEditBase. |
| DropDownCloseButton | Gets the settings of the ‘Close’ command buttons in dropdown editors. Inherited from ASPxDropDownEditBase. |
| DropDownHeight | Gets or sets the height of the editor’s dropdown window. Inherited from ASPxAutoCompleteBoxBase. |
| DropDownRows | Gets or sets the number of list items displayed within the editor’s scrollable dropdown window simultaneously. Inherited from ASPxAutoCompleteBoxBase. |
| DropDownWidth | Gets or sets the width of the editor’s dropdown window. Inherited from ASPxAutoCompleteBoxBase. |
| EmptyImage static | Obsolete. Gets the settings of an image which is displayed by the control if the control’s value is null. Inherited from ASPxWebControl. |
| EnableAnimation | Obsolete. Gets or sets a value that specifies whether a specific animation effect is used when the editor’s drop down window is invoked. Inherited from ASPxDropDownEditBase. |
| EnableCallbackMode | Gets or sets a value that specifies whether the editor’s list items can be loaded to the client side on demand via callbacks. Inherited from ASPxAutoCompleteBoxBase. |
| EnableClientSideAPI | Gets or sets a value that specifies whether the editor can be manipulated on the client side via code. Inherited from ASPxEditBase. |
| Enabled | Gets or sets a value that indicates whether the editor is enabled, allowing it to respond to end-user interactions. Inherited from ASPxEdit. |
| EnableDefaultAppearance | Obsolete. Specifies whether to enable the control’s default appearance. Inherited from ASPxWebControl. |
| EnableFocusedStyle | Gets or sets a value that specifies whether an editor in a focused state is displayed with predefined style settings. Inherited from ASPxEdit. |
| EnableIncrementalFiltering | Obsolete. Gets or sets a value that specifies whether the incremental filtering behavior is available for the editor. Inherited from ASPxAutoCompleteBoxBase. |
| EnableSynchronization | Gets or sets a value that specifies whether client manipulations with the editor’s list items (adding, deleting) should be synchronized with the editor’s server ASPxAutoCompleteBoxBase.Items collection. Inherited from ASPxAutoCompleteBoxBase. |
| EnableTheming | Gets or sets a value indicating whether themes apply to this control. Inherited from WebControl. |
| EnableViewState | Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. Inherited from Control. |
| EncodeHtml | Gets or sets whether to encode editor value and content. Inherited from ASPxButtonEditBase. |
| ErrorText | Gets or sets an error text to be displayed within an editor’s error frame if the editor’s custom validation fails. Inherited from ASPxEdit. |
| Events protected | Gets a list of event handler delegates for the control. This property is read-only. Inherited from Control. |
| FilterMinLength | Specifies the minimum length of the filter string. Inherited from ASPxAutoCompleteBoxBase. |
| FocusedStyle | Gets the style settings which define an editor’s appearance in the focused state. Inherited from ASPxEdit. |
| Font | Gets the font properties associated with the Web server control. Inherited from WebControl. |
| ForceDataBinding | Gets or sets a value that specifies whether the editor should be rebound to a data source automatically. Inherited from ASPxAutoCompleteBoxBase. |
| ForeColor | Gets or sets the foreground color (typically the color of the text) of the Web server control. Inherited from WebControl. |
| GlobalAccessibilityCompliant static | Gets or sets whether accessibility support is globally enabled for all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl. |
| GlobalCheckReferencesToExternalScripts static | Gets or sets whether links to external client scripts (such as jQuery, Knockout, and others), which are used by some DevExpress web components, are checked for presence and correctness. Inherited from ASPxWebControl. |
| GlobalEmbedRequiredClientLibraries static | Obsolete. Gets or sets whether external client libraries (including scripts and CSS files) are automatically embedded in the DevExpress.Web assembly as resources. Inherited from ASPxWebControl. |
| GlobalRightToLeft static | Gets or sets that the right-to-left orientation shall be globally applied to all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl. |
| GlobalStyleSheetTheme static | Gets or sets the name of the style sheet theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl. |
| GlobalTheme static | Gets or sets the name of the Theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl. |
| GlobalThemeBaseColor static | Gets or sets the base color for the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl. |
| GlobalThemeFont static | Gets or sets the font settings of the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl. |
| HasAttributes | Gets a value indicating whether the control has attributes set. Inherited from WebControl. |
| HasChildViewState protected | Gets a value indicating whether the current server control’s child controls have any saved view-state settings. Inherited from Control. |
| Height | Gets or sets the editor’s height. Inherited from ASPxTextEdit. |
| HelpText | Gets or sets the current editor help text. Inherited from ASPxTextEdit. |
| HelpTextSettings | Provides access to the help text settings within the editor. Inherited from ASPxTextEdit. |
| HelpTextStyle | Gets the style settings that define the help text appearance. Inherited from ASPxTextEdit. |
| HorizontalAlign | Gets or sets the horizontal alignment of the editor’s contents. Inherited from ASPxPureTextBoxBase. |
| ID | Gets or sets the programmatic identifier assigned to the server control. Inherited from Control. |
| IdSeparator protected | Gets the character used to separate control identifiers. Inherited from Control. |
| ImageFolder | Gets or sets the path to the folder that contains images used by an editor. Inherited from ASPxEdit. |
| ImageUrlField | Gets or sets the data source field that provides image locations for the editor’s items. Inherited from ASPxAutoCompleteBoxBase. |
| IncrementalFilteringDelay | Specifies the time interval after which the editor filters items. Inherited from ASPxAutoCompleteBoxBase. |
| IncrementalFilteringMode | Specifies the incremental filter mode. Inherited from ASPxAutoCompleteBoxBase. |
| Initialized | Gets a value indicating whether the web control has been initialized. Inherited from ASPxWebControlBase. |
| InvalidStyle | Gets the style settings which define an editor’s appearance in the invalid state. Inherited from ASPxEdit. |
| IsCallback | Gets a value indicating whether the request is the result of a callback sent by the control. Inherited from ASPxWebControl. |
| IsChildControlStateCleared protected | Gets a value indicating whether controls contained within this control have control state. Inherited from Control. |
| IsTrackingViewState protected | Gets a value that indicates whether the server control is saving changes to its view state. Inherited from Control. |
| IsValid | Gets or sets a value that indicates whether the editor’s value passes validation. Inherited from ASPxEdit. |
| IsViewStateEnabled protected | Gets a value indicating whether view state is enabled for this control. Inherited from Control. |
| ItemImage | Gets the settings of the common image displayed by all the items in the editor. Inherited from ASPxAutoCompleteBoxBase. |
| Items | Gets the collection of editor items. Inherited from ASPxAutoCompleteBoxBase. |
| ItemStyle | Gets the style settings for all items in the editor. Inherited from ASPxAutoCompleteBoxBase. |
| ItemTemplate | Specifies a common template used for displaying the content of all items in the combo box and token box. Inherited from ASPxAutoCompleteBoxBase. |
| ItemValueType | Gets the data type of the editor’s item values. |
| JSProperties | Enables you to supply any server data that can then be parsed on the client. Inherited from ASPxEditBase. |
| ListBoxStyle | Gets the style settings that define the appearance of the editor’s dropdown list. Inherited from ASPxAutoCompleteBoxBase. |
| LoadDropDownOnDemand | Gets or sets a value specifying whether the HTML code that represents the editor’s drop-down window should be loaded via a callback on demand. Inherited from ASPxAutoCompleteBoxBase. |
| Loaded | Indicates whether a web control has been loaded into the Page object. Inherited from ASPxWebControlBase. |
| LoadingPanelDelay | Obsolete. Gets or sets the delay before displaying the loading panel in the editor. Inherited from ASPxAutoCompleteBoxBase. |
| LoadingPanelImage | Gets the settings of an image displayed within a loading panel. Inherited from ASPxAutoCompleteBoxBase. |
| LoadingPanelImagePosition | Obsolete. Gets or sets the position of an image displayed within a loading panel. Inherited from ASPxAutoCompleteBoxBase. |
| LoadingPanelStyle | Gets the style settings defining the appearance of the loading panel. Inherited from ASPxAutoCompleteBoxBase. |
| LoadingPanelText | Obsolete. Gets or sets the text to be displayed within a loading panel while waiting for a callback response. Inherited from ASPxAutoCompleteBoxBase. |
| LoadViewStateByID protected | Gets a value indicating whether the control participates in loading its view state by ID instead of index. Inherited from Control. |
| MaxLength | Gets or sets the maximum number of characters an end user can enter into the editor. Inherited from ASPxTextBoxBase. |
| NamingContainer | Gets a reference to the server control’s naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. Inherited from Control. |
| NullText | Gets or sets the prompt text displayed within the editor’s input box when the editor is not focused and its value is null. Inherited from ASPxAutoCompleteBoxBase. |
| NullTextDisplayMode | Specifies when the null text is visible in the editor. Inherited from ASPxTextEdit. |
| NullTextStyle | Gets the style settings for the editor’s edit box and prompt text, when the editor is not focused and its text is null. Inherited from ASPxTextEdit. |
| Paddings | Gets the editor’s padding settings. Inherited from ASPxPureTextBoxBase. |
| Page | Gets a reference to the Page instance that contains the server control. Inherited from Control. |
| Parent | Gets a reference to the server control’s parent control in the page control hierarchy. Inherited from Control. |
| ParentImages | This property is not in effect for the ASPxEditBase class. Inherited from ASPxEditBase. |
| ParentSkinOwner | For internal use only. Inherited from ASPxEditBase. |
| ParentStyles | This property is not in effect for the ASPxEditBase class. Inherited from ASPxEditBase. |
| PopupHorizontalAlign | Gets or sets a drop down window‘s horizontal alignment. Inherited from ASPxDropDownEditBase. |
| PopupVerticalAlign | Gets or sets a drop down window‘s vertical alignment. Inherited from ASPxDropDownEditBase. |
| ReadOnly | Gets or sets a value indicating whether an end-user can change the editor’s contents at runtime. Inherited from ASPxAutoCompleteBoxBase. |
| ReadOnlyStyle | Gets style settings for the read-only editor state. Inherited from ASPxEdit. |
| RenderIFrameForPopupElements | Gets or sets a value that specifies whether the editor’s dropdown window is displayed above Java applets that may present on the web page. Inherited from ASPxDropDownEditBase. |
| RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. Inherited from Control. |
| RightToLeft | Specifies whether to apply right-to-left representation to the control. Inherited from ASPxTextEdit. |
| RootStyle | Gets the style settings defining the appearance of an editor container. Inherited from ASPxEditBase. |
| SettingsLoadingPanel | Provides access to the loading panel settings. Inherited from ASPxAutoCompleteBoxBase. |
| ShadowImage static | Obsolete. Gets the shadow image properties. Inherited from ASPxWebControl. |
| ShowDropDownOnFocus | Specifies the drop-down window visibility when the editor gets focus. |
| ShowLoadingPanel | Obsolete. Gets or sets whether the loading panel can be displayed. Inherited from ASPxAutoCompleteBoxBase. |
| ShowLoadingPanelImage | Obsolete. Specifies whether or not the image can be displayed within a loading panel while waiting for a callback response. Inherited from ASPxAutoCompleteBoxBase. |
| ShowShadow | Gets or sets a value that specifies whether the editor’s drop down window casts a shadow. Inherited from ASPxDropDownEditBase. |
| Site | Gets information about the container that hosts the current control when rendered on a design surface. Inherited from Control. |
| SkinID | Gets or sets the skin to apply to the control. Inherited from WebControl. |
| Spacing | Gets or sets the spacing between the editor’s elements. Inherited from ASPxButtonEditBase. |
| SpriteCssFilePath | Gets or sets the path to a CSS file that defines the control’s sprite image settings. Inherited from ASPxEdit. |
| SpriteImageUrl | Gets or sets the path to a sprite image. Inherited from ASPxEdit. |
| Style | Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. Inherited from WebControl. |
| SupportsDisabledAttribute |
Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to “disabled” when the control’s IsEnabled property is false.
Inherited from WebControl. |
| IControlBuilderAccessor.ControlBuilder | For a description of this member, see ControlBuilder. Inherited from Control. |
| IControlDesignerAccessor.UserData | For a description of this member, see UserData. Inherited from Control. |
| IDataBindingsAccessor.DataBindings | For a description of this member, see DataBindings. Inherited from Control. |
| IDataBindingsAccessor.HasDataBindings | For a description of this member, see HasDataBindings. Inherited from Control. |
| IExpressionsAccessor.Expressions | For a description of this member, see Expressions. Inherited from Control. |
| IExpressionsAccessor.HasExpressions | For a description of this member, see HasExpressions. Inherited from Control. |
| TabIndex | Gets or sets the tab index of the Web server control. Inherited from WebControl. |
| TagKey protected | Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. Inherited from WebControl. |
| TagName protected | Gets the name of the control tag. This property is used primarily by control developers. Inherited from WebControl. |
| TemplateControl | Gets or sets a reference to the template that contains this control. Inherited from Control. |
| TemplateSourceDirectory | Gets the virtual directory of the Page or UserControl that contains the current server control. Inherited from Control. |
| Text | Gets or sets the editor token texts, separated with a sign specified by the ASPxTokenBox.TextSeparator property. |
| TextField | Gets or sets the data source field that provides display texts for the editor’s items. Inherited from ASPxAutoCompleteBoxBase. |
| TextSeparator | Gets or sets a separator that is used in the editor ASPxTokenBox.Text property to divide tokens. |
| Theme | Gets or sets the name of the Theme to be applied to the control. Inherited from ASPxWebControl. |
| TokenBoxInputStyle | Gets the style settings that define the appearance of an input area. |
| TokenHoverStyle | Gets the style settings that define the appearance of a token when it is hovered by a pointer. |
| TokenRemoveButtonHoverStyle | Gets the style settings that define the appearance of a token‘s remove button when it is hovered by a pointer. |
| TokenRemoveButtonStyle | Gets the style settings that define the appearance of a token‘s remove button. |
| Tokens | Provide access to a collection of editor tokens. |
| TokenStyle | Gets the style settings that define the appearance of a token. |
| TokenTextStyle | Gets the style settings that define the appearance of a token‘s text. |
| ToolTip | Gets or sets the text displayed when the mouse pointer hovers over the Web server control. Inherited from WebControl. |
| UniqueID | Gets the unique, hierarchically qualified identifier for the server control. Inherited from Control. |
| ValidateRequestMode | Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. Inherited from Control. |
| ValidationSettings | Gets the editor’s validation settings. Inherited from ASPxEdit. |
| Value | Gets or sets the editor value. |
| ValueField | Gets or sets the data source field that provides values for the editor’s items. Inherited from ASPxAutoCompleteBoxBase. |
| ValueSeparator | Gets or sets a separator that is used in the editor ASPxTokenBox.Value property to divide values of items, corresponding to editor tokens. |
| ViewState protected | Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. Inherited from Control. |
| ViewStateIgnoresCase protected | Gets a value that indicates whether the StateBag object is case-insensitive. Inherited from Control. |
| ViewStateMode | Gets or sets the view-state mode of this control. Inherited from Control. |
| Visible | Gets or sets a value specifying the editor’s visibility. Inherited from ASPxEdit. |
| Width | Gets or sets the editor’s width. Inherited from ASPxTextEdit. |
Methods
| Name | Description |
|---|---|
| AddAttributesToRender(HtmlTextWriter) protected | Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. Inherited from WebControl. |
| AddedControl(Control, Int32) protected | Called after a child control is added to the Controls collection of the Control object. Inherited from Control. |
| AddParsedSubObject(Object) protected | Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control’s ControlCollection object. Inherited from Control. |
| ApplyStyle(Style) | Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. Inherited from WebControl. |
| ApplyStyleSheetSkin(Page) | Applies the style properties defined in the page style sheet to the control. Inherited from Control. |
| AreEditorsValid(Control, Boolean) static | Verifies whether the editors in the specified container are valid. Inherited from ASPxEdit. |
| AreEditorsValid(Control, String, Boolean) static | Verifies whether the editors with the specified settings are valid. Inherited from ASPxEdit. |
| AreEditorsValid(Control, String) static | Verifies whether visible editors with the specified settings are valid. Inherited from ASPxEdit. |
| AreEditorsValid(Control) static | Verifies whether visible editors with the specified settings are valid. Inherited from ASPxEdit. |
| BeginRenderTracing(TextWriter, Object) protected | Begins design-time tracing of rendering data. Inherited from Control. |
| BuildProfileTree(String, Boolean) protected | Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. Inherited from Control. |
| ClearCachedClientID() protected |
Sets the cached ClientID value to null.
Inherited from Control. |
| ClearChildControlState() protected | Deletes the control-state information for the server control’s child controls. Inherited from Control. |
| ClearChildState() protected | Deletes the view-state and control-state information for all the server control’s child controls. Inherited from Control. |
| ClearChildViewState() protected | Deletes the view-state information for all the server control’s child controls. Inherited from Control. |
| ClearEditorsInContainer(Control, Boolean) static | Assigns a null value to all editors which are located within the specified container object, dependent on the visibility state specified. Inherited from ASPxEdit. |
| ClearEditorsInContainer(Control, String, Boolean) static | Assigns a null value to all editors which are located within the specified container object and belong to a specific validation group, depending upon their visibility state specified. Inherited from ASPxEdit. |
| ClearEditorsInContainer(Control, String) static | Assigns a null value to all visible editors that are located within the specified container object and belong to a specific validation group. Inherited from ASPxEdit. |
| ClearEditorsInContainer(Control) static | Assigns a null value to all visible editors that are located within the specified container object. Inherited from ASPxEdit. |
| ClearEffectiveClientIDMode() protected | Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. Inherited from Control. |
| CopyBaseAttributes(WebControl) | Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. Inherited from WebControl. |
| CreateControlCollection() protected | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. Inherited from Control. |
| DataBind() | Binds the data source to the invoked server control. Inherited from ASPxWebControl. |
| DataBind(Boolean) protected | Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. Inherited from Control. |
| DataBindChildren() protected | Binds a data source to the server control’s child controls. Inherited from Control. |
| DataBindItems() | Binds edit items to the data source’s data, without resolving any data-binding expressions within the editor. Inherited from ASPxAutoCompleteBoxBase. |
| Dispose() | Enables a server control to perform final clean up before it is released from memory. Inherited from Control. |
| EndRenderTracing(TextWriter, Object) protected | Ends design-time tracing of rendering data. Inherited from Control. |
| EnsureID() protected | Creates an identifier for controls that do not have an identifier assigned. Inherited from Control. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| FindControl(String, Int32) protected |
Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method.
Inherited from Control. |
| FindControl(String) |
Searches the current naming container for a server control with the specified id parameter.
Inherited from Control. |
| Focus() | Sets input focus to the web control. Inherited from ASPxWebControl. |
| GetCallbackErrorMessage() static | Obtains the error info while processing the redirection page. Inherited from ASPxWebControl. |
| GetClientSideEventHandler(String) | Returns the specified client event’s handler. Inherited from ASPxWebControl. |
| GetClientSideEvents() | For internal use only. Inherited from ASPxEditBase. |
| GetCssClassNamePrefix() | For internal use only. Inherited from ASPxWebControl. |
| GetCssClassNamePrefix(String) | For internal use only. Inherited from ASPxWebControl. |
| GetDefaultBooleanProperty(String, DefaultBoolean) | For internal use only. Inherited from ASPxWebControl. |
| GetDesignModeState() protected | Gets design-time data for a control. Inherited from Control. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetResourceUrl(Page, String) static | Returns a URL reference to an embedded resource in an assembly. Inherited from ASPxWebControl. |
| GetResourceUrl(Page, Type, String) static | Returns a URL reference to an embedded resource in an assembly. Inherited from ASPxWebControl. |
| GetRouteUrl(Object) | Gets the URL that corresponds to a set of route parameters. Inherited from Control. |
| GetRouteUrl(String, Object) | Gets the URL that corresponds to a set of route parameters and a route name. Inherited from Control. |
| GetRouteUrl(String, RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters and a route name. Inherited from Control. |
| GetRouteUrl(RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters. Inherited from Control. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| GetUniqueIDRelativeTo(Control) | Returns the prefixed portion of the UniqueID property of the specified control. Inherited from Control. |
| HasControls() | Determines if the server control contains any child controls. Inherited from Control. |
| HasEvents() protected | Returns a value indicating whether events are registered for the control or any child controls. Inherited from Control. |
| HtmlEncode(String, Boolean) | For internal use only. Inherited from ASPxWebControl. |
| HtmlEncode(String) | For internal use only. Inherited from ASPxWebControl. |
| IsAccessibilityCompliantRender() | Returns a value that indicates whether the control’s accessible html code is rendered. Inherited from ASPxWebControl. |
| IsAccessibilityCompliantRender(Boolean) | Returns a value that indicates whether the control’s accessible html code is rendered. Inherited from ASPxWebControl. |
| IsClientSideAPIEnabled() | Returns a value that indicates whether a specific programmatic interface (in particular, specific objects and methods) are available to the editor on the client side. Inherited from ASPxAutoCompleteBoxBase. |
| IsEnabled() | Returns a value that specifies whether a web control is enabled. Inherited from ASPxWebControlBase. |
| IsLiteralContent() protected | Determines if the server control holds only literal content. Inherited from Control. |
| IsLoading() | This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from ASPxWebControl. |
| IsVisible() | Returns a value that specifies whether the current web control is displayed. Inherited from ASPxWebControlBase. |
| LoadControlState(Object) protected | Restores control-state information from a previous page request that was saved by the SaveControlState() method. Inherited from Control. |
| MakeResponseCompressed() static | Specifies that the response code (the HTML code of the web page) should be compressed on the server before sending it to the client. Inherited from ASPxWebControl. |
| MakeResponseCompressed(Boolean) static | Specifies that the response code (the HTML code of the web page) should be compressed on the server before sending it to the client, and accepts a parameter specifying whether to apply compression to IE6. Inherited from ASPxWebControl. |
| MapPathSecure(String) protected | Retrieves the physical path that a virtual path, either absolute or relative, maps to. Inherited from Control. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MergeStyle(Style) | Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. Inherited from WebControl. |
| OnBubbleEvent(Object, EventArgs) protected | Determines whether the event for the server control is passed up the page’s UI server control hierarchy. Inherited from Control. |
| OnUnload(EventArgs) protected | Raises the Unload event. Inherited from Control. |
| OpenFile(String) protected | Gets a Stream used to read a file. Inherited from Control. |
| RaiseBubbleEvent(Object, EventArgs) protected | Assigns any sources of the event and its information to the control’s parent. Inherited from Control. |
| RedirectOnCallback(String) static | Redirects a client to a new URL while processing a callback. Inherited from ASPxWebControl. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| RegisterBaseScript(Page, Boolean) static | Registers base scripts required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl. |
| RegisterBaseScript(Page) static | Registers base scripts, required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl. |
| RegisterEditorIncludeScripts() | For internal use only. |
| RegisterStyleSheets() | For internal use only. Inherited from ASPxTextEdit. |
| RegisterUtilsScript(Page) static | Obsolete. Registers utils scripts required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl. |
| RemovedControl(Control) protected | Called after a child control is removed from the Controls collection of the Control object. Inherited from Control. |
| RenderBeginTag(HtmlTextWriter) | Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. Inherited from WebControl. |
| RenderChildren(HtmlTextWriter) protected | Outputs the content of a server control’s children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. Inherited from Control. |
| RenderContents(HtmlTextWriter) protected | Renders the contents of the control to the specified writer. This method is used primarily by control developers. Inherited from WebControl. |
| RenderControl(HtmlTextWriter, ControlAdapter) protected | Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. Inherited from Control. |
| RenderControl(HtmlTextWriter) | Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. Inherited from Control. |
| RenderEndTag(HtmlTextWriter) | Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. Inherited from WebControl. |
| RequireClientLibrariesRegistering() static | Specifies whether client library registration is required. Inherited from ASPxWebControl. |
| ResolveAdapter() protected | Gets the control adapter responsible for rendering the specified control. Inherited from Control. |
| ResolveClientUrl(String) | Gets a URL that can be used by the browser. Inherited from ASPxWebControlBase. |
| ResolveUrl(String) | Converts a URL into one that is usable on the requesting client. Inherited from Control. |
| SaveControlState() protected | Saves any server control state changes that have occurred since the time the page was posted back to the server. Inherited from Control. |
| SetCallbackErrorMessage(String) static | Specifies the message text to be displayed for remote clients when a DevExpress control callback error has occurred. Inherited from ASPxWebControl. |
| SetClientSideEventHandler(String, String) | Defines a handler for the specified client event. Inherited from ASPxWebControl. |
| SetDesignModeState(IDictionary) protected | Sets design-time data for a control. Inherited from Control. |
| SetRenderMethodDelegate(RenderMethod) | Assigns an event handler delegate to render the server control and its content into its parent control. Inherited from Control. |
| SetTraceData(Object, Object, Object) | Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value. Inherited from Control. |
| SetTraceData(Object, Object) | Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. Inherited from Control. |
| IAttributeAccessor.GetAttribute(String) | Gets an attribute of the Web control with the specified name. Inherited from WebControl. |
| IAttributeAccessor.SetAttribute(String, String) | Sets an attribute of the Web control to the specified name and value. Inherited from WebControl. |
| IControlDesignerAccessor.GetDesignModeState() | For a description of this member, see GetDesignModeState(). Inherited from Control. |
| IControlDesignerAccessor.SetDesignModeState(IDictionary) | For a description of this member, see SetDesignModeState(IDictionary). Inherited from Control. |
| IControlDesignerAccessor.SetOwnerControl(Control) | For a description of this member, see SetOwnerControl(Control). Inherited from Control. |
| IParserAccessor.AddParsedSubObject(Object) | For a description of this member, see AddParsedSubObject(Object). Inherited from Control. |
| ToString() | Returns a string that represents the current object. Inherited from Object. |
| Validate() | Performs the editor’s validation. Inherited from ASPxEdit. |
| ValidateEditorsInContainer(Control, Boolean) static | Performs validation of the editors which are located within the specified container, dependent on the visibility state specified. Inherited from ASPxEdit. |
| ValidateEditorsInContainer(Control, String, Boolean) static | Performs validation of the editors which are located within the specified container and belong to a specific validation group, dependent on the visibility state specified. Inherited from ASPxEdit. |
| ValidateEditorsInContainer(Control, String) static | Performs validation of visible editors that are located within the specified container and belong to a specific validation group. Inherited from ASPxEdit. |
| ValidateEditorsInContainer(Control) static | Performs validation of visible editors that are located within the specified container. Inherited from ASPxEdit. |
Events
| Name | Description |
|---|---|
| ButtonClick | Fires after a button is clicked within the editor. Inherited from ASPxButtonEditBase. |
| Callback |
Fires after the client PerformCallback method initiates a callback and during each subsequent internal callback.
Inherited from ASPxAutoCompleteBoxBase. |
| CallbackError static | Allows you to handle any server exception that might occur during server-side processing of a callback sent by a DevExpress web control. Inherited from ASPxWebControl. |
| CustomFiltering | Fires before the server-side filtering is executed. Inherited from ASPxAutoCompleteBoxBase. |
| CustomJSProperties | Enables you to supply any server data that can then be parsed on the client. Inherited from ASPxEditBase. |
| CustomTokensAdded | Serves as a notification that the token box contains custom tokens. |
| DataBinding | Occurs when the server control binds to a data source. Inherited from Control. |
| DataBound | Occurs after the server control binds to the data source. Inherited from ASPxDataWebControlBase. |
| Disposed | Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. Inherited from Control. |
| Init | Occurs when the server control is initialized, which is the first step in its lifecycle. Inherited from Control. |
| ItemDeleted | Occurs after a list item has been deleted. Inherited from ASPxAutoCompleteBoxBase. |
| ItemDeleting | Enables you to prevent a list item from being deleted. Inherited from ASPxAutoCompleteBoxBase. |
| ItemInserted | Occurs after a new list item has been added to the editor’s item collection. Inherited from ASPxAutoCompleteBoxBase. |
| ItemInserting | Enables you to prevent a list item from being added to the editor’s item collection. Inherited from ASPxAutoCompleteBoxBase. |
| ItemRowPrepared | Enables you to change individual rows settings. Inherited from ASPxAutoCompleteBoxBase. |
| ItemTextCellPrepared | Occurs on the server side before a text cell has been rendered. Inherited from ASPxAutoCompleteBoxBase. |
| Load | Occurs when the server control is loaded into the Page object. Inherited from Control. |
| PreRender | Occurs after the Control object is loaded but prior to rendering. Inherited from Control. |
| TextChanged | Fires when the control accepts the new text value entered by a user. Inherited from ASPxTextEdit. |
| TokensChanged | Fires on the server side after the token collection has been changed. |
| Unload | Occurs when the server control is unloaded from memory. Inherited from Control. |
| Validation | Allows you to specify whether the value entered into the editor is valid, and whether the editor is allowed to lose focus. Inherited from ASPxEdit. |
| ValueChanged | Fires when the control accepts the new value entered by a user. Inherited from ASPxEdit. |
See Also