RepositoryItemTokenEdit Members
Provides access to the TokenEdit control’s settings.Constructors
| Name | Description |
|---|---|
| RepositoryItemTokenEdit() | Initializes a new instance of the RepositoryItemTokenEdit class with the default settings. |
Fields
| Name | Description |
|---|---|
| DefaultDropDownRowCount | Stores the default TokenEdit drop-down list capacity, equal to 7 lines. |
| DefaultEditValueSeparatorChar | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| DefaultMaxExpandLines | Stores the default number of lines (4) a TokenEdit can be expanded to. If a Token Edit needs more than 4 lines to display its content, vertical scroll bar appears. To modify this line count, use the RepositoryItemTokenEdit.MaxExpandLines property. |
Properties
| Name | Description |
|---|---|
| AccessibleDefaultActionDescription | Gets or sets the default action description of the repository item for use by accessibility client applications. Inherited from RepositoryItem. |
| AccessibleDescription | Gets or sets the object’s description used by accessibility client applications. Inherited from RepositoryItem. |
| AccessibleName | Gets or sets the object’s name used by accessibility client applications. Inherited from RepositoryItem. |
| AccessibleRole | Gets or sets the object’s accessible role. Inherited from RepositoryItem. |
| AllowFocused | Gets or sets a value specifying whether the focus rectangle is displayed within the editor when it has focus. Inherited from RepositoryItem. |
| AllowFocusedAppearance | Gets a value which indicates whether the appearance settings used to paint the editor when it’s focused can be used. Inherited from RepositoryItem. |
| AllowHtmlDraw | Gets or sets whether HTML tags can be used to format an editor’s text or text of the editor’s items. Inherited from RepositoryItem. |
| AllowInplaceAutoFilter | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| AllowInplaceBorderPainter | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| AllowMouseWheel | Gets or sets whether value scrolling via the Mouse Wheel is supported by the editor. Inherited from RepositoryItem. |
| Appearance | Gets appearance settings used to paint the editor when it is enabled. Inherited from RepositoryItem. |
| AppearanceDisabled | Gets appearance settings used to paint the editor when it is disabled. Inherited from RepositoryItem. |
| AppearanceDropDown | Provides access to appearance settings that allow you to customize the drop-down list appearances for this TokenEdit. |
| AppearanceFocused | Gets appearance settings used to paint the current editor when it is focused. Inherited from RepositoryItem. |
| AppearanceReadOnly | Gets appearance settings used to paint the read-only editor. Inherited from RepositoryItem. |
| AutoHeight | This member supports the internal infrastructure, and is not intended to be used directly from your code. Use the RepositoryItemTokenEdit.AutoHeightMode instead to set whether the TokenEdit should automatically expand based on its current content. |
| AutoHeightMode | Gets or sets the TokenEdit control’s auto-hide mode. |
| BestFitWidth | Gets or sets the editor’s best fit width. Inherited from RepositoryItem. |
| BorderStyle | Gets or sets the editor’s border style. Inherited from RepositoryItem. |
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| CheckMode | Gets or sets whether only one or multiple tokens can be selected (checked) simultaneously within this TokenEdit control. |
| ClearCheckStatesOnLostFocus | Gets or sets whether checked tokens within the related TokenEdit control should be deselected when the editor loses focus. |
| Container | Gets the IContainer that contains the Component. Inherited from Component. |
| ContextMenu | Gets or sets the context menu for the editor. Inherited from RepositoryItem. |
| CustomDropDownControl | Gets or sets the custom drop-down control for this TokenEdit. |
| DataSource | Gets or sets an object that stores Tokens. |
| DefaultAlignment | Gets the default horizontal alignment of the editor’s content. Inherited from RepositoryItem. |
| DefaultBorderStyleInBars | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| DefaultBorderStyleInGrid | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| DeleteTokenOnGlyphClick | Gets or sets whether a TokenEdit‘s token should be deleted if an end-user clicks this token’s image. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| DisplayFormat | Provides access to the format settings applied to the editor’s display text. These settings are in effect when the editor does not have input focus. Inherited from RepositoryItem. |
| DisplayMember | If the Token Edit is connected to a data source, this property specifies which data source field stores visible Token captions. |
| DropDownRowCount | Gets or sets the maximum number of drop-down menu items for this TokenEdit. |
| DropDownShowMode | Gets or sets the way this TokenEdit‘s drop-down list is displayed. |
| Editable | Gets whether the editor’s value can be changed. Inherited from RepositoryItem. |
| EditFormat | Provides access to the settings used to format the edit value when the editor has input focus. Inherited from RepositoryItem. |
| EditMode | Gets or sets whether an end-user can manually enter and validate any desired text within this TokenEdit. |
| EditorTypeName | Gets the editor’s textual representation. |
| EditValueChangedDelay | Gets or sets the time interval between the moment when an end-user stops changing the editor’s value and the RepositoryItem.EditValueChanged event being raised. Inherited from RepositoryItem. |
| EditValueChangedFiringDelay static | Gets or sets the default time interval between the moment when an end-user stops changing the editor’s value and the RepositoryItem.EditValueChanged event being raised. Inherited from RepositoryItem. |
| EditValueChangedFiringMode | Gets or sets the RepositoryItem.EditValueChanged event’s firing mode. Inherited from RepositoryItem. |
| EditValueSeparatorChar | Gets or sets the character used to separate the TokenEdit.EditValue property value into multiple text blocks. |
| EditValueType | Gets or sets the type of this TokenEdit‘s edit value. |
| Enabled | Gets or sets a value indicating whether the edit control can respond to user actions. This property is supported for standalone editors. Inherited from RepositoryItem. |
| Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
| ExportMode | Specifies whether the editor’s value or display text is exported when data is exported to XLS and CSV formats. Inherited from RepositoryItem. |
| HtmlImages | Gets or sets a collection of images that can be embedded in the editor’s display text or the display text of the editor’s items, using the image tag. Inherited from RepositoryItem. |
| IsDesignMode | Indicates whether the editor is currently in design mode. Inherited from RepositoryItem. |
| IsDisposed | Gets a value indicating whether the control has been disposed of. Inherited from RepositoryItem. |
| IsEditValueChangedEventPending | Gets whether the EditValueChanged event is postponed. Inherited from RepositoryItem. |
| IsFilterLookUp | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| IsLoading | Indicates whether the editor is being loaded. Inherited from RepositoryItem. |
| IsLockUpdate | Gets a value indicating whether the editor is immediately updated in response to changing its settings. Inherited from RepositoryItem. |
| IsNonSortableEditor | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| LinkCount | Gets the number of objects connected to the current repository item. Inherited from RepositoryItem. |
| LookAndFeel | Provides access to the stand-alone editor’s look and feel settings. These settings are not in effect for the editor in a bar, ribbon, grid, etc. Inherited from RepositoryItem. |
| MaxExpandLines | Gets or sets the maximum number of lines this TokenEdit can occupy. This property is ignored if the editor is used in-place. |
| MaxTokenCount | Gets or sets the maximum tokens number this TokenEdit control can simultaneously display. |
| MinRowCount | Gets or sets the initial number of rows displayed by this TokenEdit. |
| Name | Gets or sets the repository item name. Inherited from RepositoryItem. |
| NormalizeDisplayText static | Set the NormalizeDisplayText property to true to correctly process diacritics when selecting rows from a dropdown window in the LookUpEdit control. Inherited from RepositoryItem. |
| NullText | Gets or sets the text that presents the editor’s null value (null, System.DBNull.Value and RepositoryItemDateEdit.NullDate - for DateEdit). Inherited from RepositoryItem. |
| OwnerEdit | Returns a TokenEdit that owns this RepositoryItemTokenEdit. |
| OwnerItem | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| PopupFilterMode | Gets or sets how items within this TokenEdit‘s popup are filtered. |
| PopupOffset | Gets or sets the popup window’s location. Inherited from RepositoryItem. |
| PopupPanel | Gets or sets the FlyoutPanel assigned to this TokenEdit. |
| PopupPanelOptions | Provides access to the set of properties that specify the peek panel behavior. |
| PopupSizeable | Gets or sets whether this TokenEdit‘s drop-down list should display a size grip. |
| Properties | Obsolete. This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| ReadOnly | Gets or sets a value specifying whether the editor’s value can be changed by end-users. Inherited from RepositoryItem. |
| RequireDisplayTextSorting | This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| Separators | Provides access to the additional separators collection that are used along with the default separator (the RepositoryItemTokenEdit.EditValueSeparatorChar property) to break the RepositoryItemTokenEdit text into separate blocks that are converted into tokens. |
| ShowDropDown | Gets or sets whether this TokenEdit control’s drop-down list should be displayed. |
| ShowDropDownOnClick | Gets or sets whether the drop-down window is shown when the user clicks within the edit box. |
| ShowRemoveTokenButtons | Gets or sets whether items within this TokenEdit control’s drop-down list should display the ‘remove’ icon. |
| ShowSelectedItemsInPopup | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| ShowSeparators | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| ShowTokenGlyph | Gets or sets whether token glyphs should be displayed. |
| Site | Gets or sets a ISite for the object. Inherited from RepositoryItem. |
| Tag | Gets or sets the data associated with the repository item. Inherited from RepositoryItem. |
| TokenGlyphLocation | Gets or sets the location of token icons relative to token captions. |
| TokenPopulateMode | Gets or sets whether or not the RepositoryItemTokenEdit.Tokens collection supports automatic population. |
| Tokens | Gets a collection of tokens. |
| UseParentBackground | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| UseReadOnlyAppearance | Gets or sets whether this Token Edit Control should be painted using the read-only appearance settings. |
| UseTextEditorForAutoFilter | Gets whether to substitute this editor with the single-line text editor in auto-filter rows. Inherited from RepositoryItem. |
| ValidationRules | Gets or sets a set of validation rules for this TokenEdit. |
| ValueMember | If the Token Edit is connected to a data source, this property specifies which data source field stores unique Token values. |
Methods
| Name | Description |
|---|---|
| AddEnum(Type, Boolean, Boolean) | Populates the editor with tokens created based on values of an enumeration. |
| AddEnum(Type, Boolean) | Populates the editor with tokens created based on values of an enumeration. Allows the created tokens to store the enumeration’s underlying integer constants instead of named constants. |
| AddEnum(Type) | Populates the editor with tokens created based on values of an enumeration. |
| AddEnum<TEnum>() | Populates the editor with tokens created based on values of an enumeration. |
| AddEnum<TEnum>(Boolean) | Populates the editor with tokens created based on values of an enumeration. Allows the created tokens to store the enumeration’s underlying integer constants instead of named constants. |
| Assign(RepositoryItem) | Copies all settings from the target RepositoryItem to this RepositoryItemTokenEdit object. |
| BeginInit() | Notifies the editor that the initialization has been started. Inherited from RepositoryItem. |
| BeginUpdate() | Locks the RepositoryItem object by disallowing visual updates until the EndUpdate or CancelUpdate method is called. Inherited from RepositoryItem. |
| CancelUpdate() | Unlocks the RepositoryItem object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from RepositoryItem. |
| Clone() | Creates a copy of the current repository item. Inherited from RepositoryItem. |
| Connect(Object) | Connects the repository item to the specified object. Inherited from RepositoryItem. |
| CreateEditor() | Creates an editor whose type corresponds to the repository item’s type. Inherited from RepositoryItem. |
| CreateGroupPainter() | Initializes a new instance of the DevExpress.XtraEditors.Drawing.BaseEditorGroupRowPainter class. Inherited from RepositoryItem. |
| CreateObjRef(Type) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject. |
| CreatePainter() | This member supports the editor library’s internal infrastructure and is not intended to be used in your applications. Inherited from RepositoryItem. |
| CreateViewInfo() | This member supports the editors library’s internal infrastructure and is not intended to be used in your applications. Inherited from RepositoryItem. |
| Disconnect(Object) | Removes the connection between the repository item and the specified object. Inherited from RepositoryItem. |
| Dispose() | Releases all resources used by the Component. Inherited from Component. |
| EndInit() | Notifies the editor that the initialization has been completed. Inherited from RepositoryItem. |
| EndUpdate() | Unlocks the RepositoryItem object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from RepositoryItem. |
| 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. |
| ForceInitialize() | Forces the control to finish its initialization. |
| GetBorderSides(Boolean, Boolean) static | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| GetBrick(PrintCellHelperInfo) | Returns a brick object that contains information on how the current editor should be printed. |
| GetDisplayText(FormatInfo, Object) | Returns the text representation of the specified value, formatted according to the specified settings. Inherited from RepositoryItem. |
| GetDisplayText(Object) | Returns the text representation of the specified value formatted using the editor’s settings. Inherited from RepositoryItem. |
| GetDisplayValueByKeyValue(Object) | |
| GetEditorType() | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| GetEditValueForExportByOptions(Object, Object, Object, Object, Function3<String, Object, Object, Object>, ExportTarget) | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| GetHashCode() | Returns a hash code. Inherited from RepositoryItem. |
| GetKeyValueByDisplayValue(Object) | |
| GetLifetimeService() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| GetNormalizedText(String) static | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| GetService(Type) protected | Returns an object that represents a service provided by the Component or by its Container. Inherited from Component. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| InitializeLifetimeService() | Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| IsActivateKey(Keys) | Indicates whether a particular key can activate the editor used as an inplace control. Inherited from RepositoryItem. |
| IsLockDefaultImmediateUpdateRowPosition() | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| IsNeededKey(Keys) | Indicates whether the key is handled by the editor or the container control. Inherited from RepositoryItem. |
| LockEvents() | This method supports the .NET framework infrastructure and is not intended to be called from your code. Inherited from RepositoryItem. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MemberwiseClone(Boolean) protected | Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| ResetEvents() | This member supports the .NET Framework infrastructure and is not intended to be used in your applications. Inherited from RepositoryItem. |
| ScaleProperties(ScaleHelper) | Updates the RepositoryItem according to current scale settings. This method is called automatically when the form’s runtime DPI settings differ from those in design-time. Inherited from RepositoryItem. |
| SwitchMode() | For internal use. Inherited from RepositoryItem. |
| ToString() | Returns a string that represents the current object. Inherited from RepositoryItem. |
| UnLockEvents() | This method supports the .NET framework infrastructure and is not intended to be called from your code. Inherited from RepositoryItem. |
| Validate() | Validates the text entered in the editor. |
Events
| Name | Description |
|---|---|
| BeforePopup | Fires before the drop-down window is shown. |
| BeforeShowMenu | Fires before this TokenEdit control’s popup menu is shown. Allows you to customize items within this menu. |
| BeforeShowPopupPanel | Occurs before the peek panel assigned to this TokenEdit is displayed. |
| Click | Fires when clicking the editor. Inherited from RepositoryItem. |
| Closed | Fires after the drop-down window is closed and gets the reason for closure. |
| CloseUp | Fires when the drop-down window is about to be closed and allows you to get and update the selected token. |
| CustomDisplayText | Enables custom display text to be provided for an editor. Inherited from RepositoryItem. |
| CustomDrawTokenBackground | Occurs each time a token needs to be displayed and allows you to manually draw its background. |
| CustomDrawTokenGlyph | Allows you to re-draw the default token glyph. |
| CustomDrawTokenText | Allows you to re-paint the token text area. |
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
| DoubleClick | Fires when the editor is double clicked. Inherited from RepositoryItem. |
| DragDrop | Fires when an object is dropped onto the editor. Inherited from RepositoryItem. |
| DragEnter | Fires when a dragged object enters the editor’s area. Inherited from RepositoryItem. |
| DragLeave | Fires when a dragged object leaves the editor’s area. Inherited from RepositoryItem. |
| DragOver | Fires repeatedly when dragging an object over the editor. Inherited from RepositoryItem. |
| EditValueChanged | Fires when the editor’s BaseEdit.EditValue property changes. Inherited from RepositoryItem. |
| EditValueChanging | Fires when the editor’s value is about to be changed. Inherited from RepositoryItem. |
| Enter | Fires when the editor receives focus. Inherited from RepositoryItem. |
| FormatEditValue | Enables you to format the editor’s value (change the editor’s value when the formatting mechanism is invoked). Inherited from RepositoryItem. |
| GiveFeedback | Enables you to specify the cursor appearance when dragging this editor’s data. Inherited from RepositoryItem. |
| HelpRequested | Fires when the end-user requests help for the editor. Inherited from RepositoryItem. |
| KeyDown | Fires when a key is pressed while the editor has focus. Inherited from RepositoryItem. |
| KeyPress | Fires when a character key is pressed while the editor has focus. Inherited from RepositoryItem. |
| KeyUp | Fires when a key is released while the editor has focus. Inherited from RepositoryItem. |
| Leave | Fires when the editor loses focus. Inherited from RepositoryItem. |
| Modified | Fires when the edit value is first changed since it was last validated. Inherited from RepositoryItem. |
| MouseDown | Fires when a mouse button is pressed while the mouse pointer is over the editor. Inherited from RepositoryItem. |
| MouseEnter | Fires when the mouse pointer enters the editor’s area. Inherited from RepositoryItem. |
| MouseHover | Fires when hot-tracking an editor element. Inherited from RepositoryItem. |
| MouseLeave | Fires when the mouse pointer leaves the editor’s area. Inherited from RepositoryItem. |
| MouseMove | Fires when the mouse pointer moves over the editor’s area. Inherited from RepositoryItem. |
| MouseUp | Fires when the mouse button is released while the mouse pointer is over the editor. Inherited from RepositoryItem. |
| MouseWheel | Fires when the mouse wheel moves while the mouse pointer is within the editor. Inherited from RepositoryItem. |
| ParseEditValue | Converts an input value (entered by a user or assigned in code) to the value that the editor will store. Inherited from RepositoryItem. |
| Popup | Fires after the drop-down window is opened. |
| ProcessNewValue | Fires when a user enters a new value into a Token Edit that is connected to a data source. Allows you to validate entered values and call data source API to save valid records. |
| PropertiesChanged | Fires immediately after a change to one of the editor’s properties. Inherited from RepositoryItem. |
| QueryAccessibilityHelp | Fires when the help is provided to accessibility applications. Inherited from RepositoryItem. |
| QueryCloseUp | Fires before the drop-down window is closed and allows you to cancel the action. |
| QueryContinueDrag | Fires when dragging the editor’s data allowing you to specify whether dragging should be continued. Inherited from RepositoryItem. |
| QueryPopUp | Fires before the drop-down window is opened and allows you to cancel the action. |
| QueryProcessKey | Provides the capability to specify whether the key pressed in the editor is processed by the editor or a container control (GridControl, TreeList, etc.) that displays this editor. Inherited from RepositoryItem. |
| RemoveTokenButtonClick | Occurs when a user clicks the Remove button in the TokenEdit drop-down menu. |
| SelectedItemsChanged | Occurs whenever a token is added or removed to (from) the TokenEdit. |
| TokenAdded | Occurs after a new token was successfully added to this TokenEdit. |
| TokenAdding | Occurs when a new token is about to be added to this TokenEdit. |
| TokenCheckStateChanged | Occurs when an end-user checks or unchecks a token within the corresponding TokenEdit. |
| TokenClick | Fires when a user clicks a token. |
| TokenDoubleClick | Occurs when an end-user double clicks a token within this TokenEdit. |
| TokenMouseEnter | Fires whenever a user focuses a token. |
| TokenMouseHover | Occurs when an end-user hovers a token within this TokenEdit. |
| TokenMouseLeave | Fires when a TokenEdit token loses mouse focus. |
| TokenRemoved | Occurs after a token is removed from this TokenEdit. |
| TokenRemoving | Fires when a token is about to be removed from this TokenEdit. |
| ValidateToken | Allows you to perform the custom validation on text currently entered in this TokenEdit control. |
| Validating | Allows you to specify whether the edit value is valid. This event does not occur if the editor’s CausesValidation property is disabled. Inherited from RepositoryItem. |
See Also