The requested page is not available for the requested platform. You are viewing the content for Default platform.

MVCxTokenBoxProperties Members

Contains TokenBox specific properties.

Constructors

Name Description
MVCxTokenBoxProperties()

Initializes a new instance of the MVCxTokenBoxProperties class with default settings.

MVCxTokenBoxProperties(IPropertiesOwner)

Initializes a new instance of the MVCxTokenBoxProperties class with the specified owner.

Properties

Name Description
AllowCustomTokens

Gets or sets whether end-users can input custom tokens.

(Inherited from TokenBoxProperties)
AllowEllipsisInText

Specifies if the combo box can automatically truncate the item's text if it doesn't fit into the item's width.

AllowMouseWheel

This property is not in effect for the TokenBoxProperties class.

(Inherited from TokenBoxProperties)
AllowUserInput

This property is not in effect for the AutoCompleteBoxPropertiesBase class.

AnimationType

Gets or sets a value specifying the animation type used when the editor's drop down window is invoked.

(Inherited from DropDownEditPropertiesBase)
ButtonEditEllipsisImage

This property is not in effect for the TokenBoxProperties class.

(Inherited from TokenBoxProperties)
ButtonStyle

This property is not in effect for the TokenBoxProperties class.

(Inherited from TokenBoxProperties)
ButtonTemplate

This property is not in effect for the TokenBoxProperties class.

(Inherited from TokenBoxProperties)
Buttons

This property is not in effect for the TokenBoxProperties class.

(Inherited from TokenBoxProperties)
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.

Caption

Gets or sets the editor caption.

CaptionCellStyle

Gets the style settings that define the caption cell appearance.

CaptionSettings

Provides access to the editor caption settings.

CaptionStyle

Gets the style settings that define the caption appearance.

CaseSensitiveTokens

Specifies if tokens are case sensitive.

(Inherited from TokenBoxProperties)
ClearButton

This property is not in effect for the TokenBoxProperties class.

(Inherited from TokenBoxProperties)
ClearButtonStyle

Gets the style settings that define the appearance of an editor's Clear button.

(Inherited from ButtonEditPropertiesBase)
ClientInstanceName

Specifies the editor's client programmatic identifier.

(Inherited from EditPropertiesBase)
ClientSideEvents

Gets an object that lists the client-side events specific to the ASPxTokenBox.

(Inherited from TokenBoxProperties)
ConvertEmptyStringToNull

Gets or sets a value that specifies whether empty string values are converted to a null reference when an inplace editor's value is retrieved from a data source field.

(Inherited from EditProperties)
CssFilePath

Gets or sets the path to a CSS file that defines the editor's appearance.

CssPostfix

Gets or sets a CSS class name postfix that identifies style settings to be applied to the editor.

CustomButtonsPosition

Specifies the position of custom control buttons relative to the input element.

(Inherited from DropDownEditPropertiesBase)
DataMember

Gets or sets a specific data member in a multimember data source to bind to the editor.

DataSecurityMode

Provides the capability to restrict setting the editor value on the client side to values listed in the server AutoCompleteBoxPropertiesBase.Items.

DataSource

Gets or sets the object from which the data-bound editor retrieves its list of data items.

DataSourceID

Gets or sets the ID of the control from which the data-bound editor retrieves its list of data items.

DisplayFormatInEditMode

Gets or sets a value specifying whether a format pattern defined via the EditPropertiesBase.DisplayFormatString property should be applied to the editor value displayed in the edit mode of a complex data control (e.g. ASPxGridView).

(Inherited from TextEditProperties)
DisplayFormatString

Gets or sets the pattern used to format the editor's value for display purposes.

(Inherited from EditPropertiesBase)
DisplayImageSpacing

Gets or sets the amount of space between a display image and text.

DropDownApplyButton

Gets the settings of the 'Apply' command buttons in dropdown editors.

(Inherited from DropDownEditPropertiesBase)
DropDownButton

This property is not in effect for the TokenBoxProperties class.

(Inherited from TokenBoxProperties)
DropDownCloseButton

Gets the settings of the 'Close' command buttons in dropdown editors.

(Inherited from DropDownEditPropertiesBase)
DropDownHeight

Gets or sets the height of the editor's dropdown window.

DropDownRows

Gets or sets the number of list items displayed within the editor's scrollable dropdown window simultaneously.

DropDownWidth

Gets or sets the width of the editor's dropdown window.

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 DropDownEditPropertiesBase)
EnableCallbackMode

Obsolete. This property is not in effect for the MVCxTokenBoxProperties class.

EnableClientSideAPI

Gets or sets a value that specifies whether the editor can be manipulated on the client side via code.

(Inherited from EditPropertiesBase)
EnableDefaultAppearance

Obsolete. Specifies whether to enable the control's default appearance.

(Inherited from EditPropertiesBase)
EnableFocusedStyle

Gets or sets a value that specifies whether an editor in a focused state is displayed with predefined style settings.

(Inherited from EditProperties)
EnableIncrementalFiltering

Obsolete. Gets or sets a value that specifies whether the incremental filtering behavior is available for the editor.

EnableItemsVirtualRendering

Specifies whether the editor's items are rendered virtually.

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 Items collection.

EnableSynchronizationOnPerformCallback

This property is not in effect for the AutoCompleteBoxPropertiesBase class.

EncodeHtml

Obsolete. This property is not in effect for the MVCxTokenBoxProperties class.

FilterMinLength

Gets or sets a value that defines the minimum length for the filter string input, after which filtering operations are initiated.

FocusedStyle

Gets the style settings which define an editor's appearance in the focused state.

(Inherited from EditProperties)
Height

Gets or sets the editor's height.

(Inherited from TextEditProperties)
HelpText

Gets or sets the current editor help text.

(Inherited from TextEditProperties)
HelpTextSettings

Provides access to an editor's help text settings.

(Inherited from TextEditProperties)
HelpTextStyle

Gets the style settings that define an editor's help text appearance.

(Inherited from TextEditProperties)
HiddenSerializableObject

For internal use only.

(Inherited from EditPropertiesBase)
ImageUrlField

Gets or sets the data source field that provides image locations for the editor's items.

IncrementalFilteringDelay

Gets or sets the time interval between the time a user enters the last symbol within the editor' edit box and filtering is applied.

IncrementalFilteringMode

Gets or sets a value that specifies the filtering mode of the editor.

InvalidStyle

Gets the style settings which define an editor's appearance in the invalid state.

(Inherited from EditProperties)
ItemImage

Gets the settings of the common image displayed by all the items in the editor.

ItemStyle

Gets the style settings for all items in the editor.

ItemTemplate

Gets or sets a common template used for displaying the content of all items within the combo box and token box.

ItemValueType

Gets the data type of the editor's item values.

(Inherited from TokenBoxProperties)
Items

Gets the collection of items displayed in the editor's dropdown window.

ListBoxStyle

Gets the style settings that define the appearance of the editor's dropdown list.

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.

MaxLength

Gets or sets the maximum number of characters an end user can enter into the editor.

(Inherited from TextBoxPropertiesBase)
NullDisplayText

Gets or sets the text displayed within the editor's edit region when the editor's value is null.

(Inherited from EditPropertiesBase)
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.

NullTextDisplayMode

Gets or sets a value indicating when the null text should be displayed in the editor.

(Inherited from TextEditProperties)
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 TextEditProperties)
ParentImages

This property is not in effect for the EditPropertiesBase class.

(Inherited from EditPropertiesBase)
ParentSkinOwner

For internal use only.

(Inherited from EditPropertiesBase)
ParentStyles

This property is not in effect for the EditPropertiesBase class.

(Inherited from EditPropertiesBase)
Password

This property is not in effect for the DropDownEditPropertiesBase class.

(Inherited from DropDownEditPropertiesBase)
PopupHorizontalAlign

Gets or sets a drop down window's horizontal alignment.

(Inherited from DropDownEditPropertiesBase)
PopupVerticalAlign

Gets or sets a drop down window's vertical alignment.

(Inherited from DropDownEditPropertiesBase)
ReadOnlyStyle

Gets style settings for the read-only editor state.

(Inherited from EditProperties)
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 DropDownEditPropertiesBase)
RootStyle

Gets the style settings defining the appearance of an editor container.

SelectInputTextOnClick

This property is not in effect for the TokenBoxProperties class.

(Inherited from TokenBoxProperties)
SettingsAdaptivity

Provides access to the token box's adaptivity settings.

(Inherited from TokenBoxProperties)
ShowDropDownOnFocus

Specifies the drop down window visibility when the editor gets focus.

(Inherited from TokenBoxProperties)
ShowShadow

Gets or sets a value that specifies whether the editor's drop down window casts a shadow.

(Inherited from DropDownEditPropertiesBase)
Spacing

Gets or sets the spacing between the editor's elements.

(Inherited from ButtonEditPropertiesBase)
Style

Obsolete. This property is not in effect for the MVCxTokenBoxProperties class.

TextField

Gets or sets the data source field that provides display texts for the editor's items.

TextFormatString

Gets or sets the pattern used to format the selected item's text displayed within the editor's edit box.

TextSeparator

Gets or sets a separator that is used in the editor ASPxTokenBox.Text property to divide tokens.

(Inherited from TokenBoxProperties)
TokenBoxInputStyle

Gets the style settings that define the appearance of an input area.

(Inherited from TokenBoxProperties)
TokenHoverStyle

Gets the style settings that define the appearance of a token when it is hovered by a pointer.

(Inherited from TokenBoxProperties)
TokenRemoveButtonHoverStyle

Gets the style settings that define the appearance of a token's remove button when it is hovered by a pointer.

(Inherited from TokenBoxProperties)
TokenRemoveButtonStyle

Gets the style settings that define the appearance of a token's remove button.

(Inherited from TokenBoxProperties)
TokenStyle

Gets the style settings that define the appearance of a token.

(Inherited from TokenBoxProperties)
TokenTextStyle

Gets the style settings that define the appearance of a token's text.

(Inherited from TokenBoxProperties)
Tokens

Provide access to a collection of editor tokens.

(Inherited from TokenBoxProperties)
ValidationSettings

Gets the token box's validation settings.

ValueField

Gets or sets the data source field that provides values for the editor's items.

ValueSeparator

Gets or sets a separator that is used in the editor ASPxTokenBox.Value property to divide values of items, corresponding to editor tokens.

(Inherited from TokenBoxProperties)
Width

Obsolete. Gets or sets the editor's width.

Methods

Name Description
Assign(PropertiesBase)

Copies the settings from the specified PropertiesBase object to the current object.

(Inherited from TokenBoxProperties)
CreateDisplayControl(CreateDisplayControlArgs, EditorsFactory)

For internal use only.

(Inherited from EditPropertiesBase)
CreateEdit(CreateEditControlArgs, Boolean, EditorsFactory)

For internal use only.

(Inherited from EditPropertiesBase)
CreateEdit(CreateEditControlArgs, EditorsFactory)

For internal use only.

(Inherited from EditPropertiesBase)
Equals(Object) Determines whether the specified object is equal to the current object.
(Inherited from Object)
Equals(Object, Object) static Determines whether the specified object instances are considered equal.
(Inherited from Object)
GetDisplayControlDefaultAlign()

For internal use only.

GetDisplayText(CreateDisplayControlArgs, Boolean, EditorsFactory)

For internal use only.

(Inherited from EditPropertiesBase)
GetDisplayText(CreateDisplayControlArgs, EditorsFactory)

For internal use only.

(Inherited from EditPropertiesBase)
GetEditorType()

For internal use only.

GetExportDisplayText(CreateDisplayControlArgs, EditorsFactory)

For internal use only.

(Inherited from EditPropertiesBase)
GetExportNavigateUrl(CreateDisplayControlArgs)

For internal use only.

(Inherited from EditPropertiesBase)
GetExportValue(CreateDisplayControlArgs)

For internal use only.

GetHashCode() Serves as the default hash function.
(Inherited from Object)
GetType() Gets the Type of the current instance.
(Inherited from Object)
MemberwiseClone() Creates a shallow copy of the current Object.
(Inherited from Object)
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance.
(Inherited from Object)
RequireDataBinding()

For internal use only.

(Inherited from EditPropertiesBase)
ToString()

Returns the string that represents the current object.

(Inherited from EditPropertiesBase)

Events

Name Description
CustomFiltering

Provides the capability to implement custom filtering logic before the server-side filtering is executed.

See Also