Skip to main content

TdxTokenEditProperties Members

Contains the token editor‘s appearance and behavior settings.

Constructors

Name Description
Create(TPersistent) Initializes a new instance of the TcxInterfacedPersistent class with specified settings. Inherited from TcxInterfacedPersistent.

Properties

Name Description
Alignment Determines the alignment of the editor’s contents. Inherited from TcxCustomEditProperties.
AllowAddCustomTokens Specifies if it is possible to enter custom tokens to the token editor.
AssignedValues Contains the property flags that indicate which properties specific to a text editor have been changed. Inherited from TcxCustomTextEditProperties.
Automation Provides access to editor UI Automation and accessibility settings. Inherited from TcxCustomEditProperties.
AutoSelect Determines whether the editor’s contents are automatically selected when the editor receives focus. Inherited from TcxCustomEditProperties.
BeepOnError Specifies whether to play the system default sound on a validation error. Inherited from TcxCustomEditProperties.
Buttons Provides access to the collection of editor buttons. Inherited from TcxCustomEditProperties.
ButtonsViewStyle protected Specifies how the editor displays content and embedded buttons. Inherited from TcxCustomEditProperties.
CharCase Specifies the case of editor text. Inherited from TcxCustomTextEditProperties.
ClearKey Specifies the keyboard shortcut to clear the editor entry. Inherited from TcxCustomEditProperties.
ClickKey Specifies a key combination to generate the OnButtonClick click event for the default button. Inherited from TcxCustomEditProperties.
CloseGlyphPosition Specifies the position and availability of the Close glyph within a token box.
DisplayFormat Specifies a formatting pattern for display text when the editor has no focus. Inherited from TcxCustomTextEditProperties.
EchoMode Specifies the text display mode. Inherited from TcxCustomTextEditProperties.
EditFormat Determines the manner in which the editor’s text is formatted when the editor is focused. Inherited from TcxCustomTextEditProperties.
EditValueDelimiter Specifies the character that delimits token text ID strings in the token editor’s edit value.
ErrorIcon Specifies an icon (also called error icon) to be displayed by a standalone editor when it fails validation. Inherited from TcxCustomEditProperties.
GlyphPosition Specifies the position of assigned glyphs or images within token boxes.
HideCursor protected Specifies whether the edit cursor is hidden. Inherited from TcxCustomTextEditProperties.
HideSelection Determines whether the visual indication of the selected text remains when the editor loses focus. Inherited from TcxCustomTextEditProperties.
Images Specifies the collection of images used as editor button icons. Inherited from TcxCustomEditProperties.
ImeMode Specifies the current mode of an Input Method Editor (IME). Inherited from TcxCustomTextEditProperties.
ImeName Specifies the input method editor (IME) to use for converting keyboard input to Asian language characters. Inherited from TcxCustomTextEditProperties.
ImmediatePost Indicates whether the edit value should be saved immediately after it has been modified. Inherited from TcxCustomEditProperties.
ImmediateUpdateText Inherited from TcxCustomTextEditProperties.
IncrementalFiltering Enables the incremental filtering feature for the editor’s drop-down list. Inherited from TcxCustomTextEditProperties.
IncrementalFilteringOptions Specifies how incremental filtering is applied to the editor’s drop-down list. Inherited from TcxCustomTextEditProperties.
IncrementalSearch Enables the automatic completion feature of an editor. Inherited from TcxCustomTextEditProperties.
InputDelimiters Specifies a string whose characters are available as token delimiters within the input string.
IsChanging Inherited from TcxCustomEditProperties.
Lookup Provides access to the token editor‘s lookup settings.
LookupItems Specifies the list of words required to implement the automatic completion feature within an editor. Inherited from TcxCustomTextEditProperties.
LookupItemsSorted Specifies whether the automatic completion words list is sorted in alphabetical order. Inherited from TcxCustomTextEditProperties.
MaxLength Specifies the maximum number of characters a user can enter into an editor. Inherited from TcxCustomTextEditProperties.
MaxLineCount Specifies the maximum number of simultaneously visible lines of token boxes in a token editor if the autosize mode is disabled.
MaxValue Specifies the maximum numeric value an editor can display. Inherited from TcxCustomTextEditProperties.
MinValue Specifies the minimum numeric value an editor can display. Inherited from TcxCustomTextEditProperties.
Nullstring protected Specifies the display text for the Null value. Inherited from TcxCustomTextEditProperties.
OEMConvert Determines whether characters typed in an editor are converted from ANSI to OEM and back to ANSI. Inherited from TcxCustomTextEditProperties.
Owner Provides access to the control or its object to which the persisted settings belong. Inherited from TcxInterfacedPersistent.
PasswordChar Specifies the character (if any) to display in place of the actual characters typed into an editor. Inherited from TcxCustomTextEditProperties.
PostEditValueOnFocusLeave Specifies if the token editor attempts to create a token from the input string and append the token to the edit value when focus leaves the editor.
ReadOnly Specifies if the editor is in read-only mode. Inherited from TcxCustomEditProperties.
ShowPasswordRevealButton Specifies if the editor configured for password input displays a “password reveal” button when the editor’s edit box is not Text. Inherited from TcxCustomTextEditProperties.
Tokens Provides access to the collection of predefined tokens.
Transparent protected Deprecated. Specifies if the editor background is transparent. Inherited from TcxCustomEditProperties.
UseDisplayFormatWhenEditing Specifies if the editor applies the display text formatting pattern to content in edit mode. Inherited from TcxCustomTextEditProperties.
UseLeftAlignmentOnEditing Specifies whether to align text to the left in edit mode. Inherited from TcxCustomEditProperties.
UseMouseWheel Specifies whether an editor responds to mouse wheel rotation. Inherited from TcxCustomEditProperties.
UseNullString protected Specifies whether the custom text will be displayed if the editor is empty. Inherited from TcxCustomTextEditProperties.
ValidateOnEnter Specifies whether validation is performed when an end-user presses the Enter key. Inherited from TcxCustomEditProperties.
ValidationErrorIconAlignment Specifies the horizontal alignment of an error icon displayed by the editor when it fails validation. Inherited from TcxCustomEditProperties.
ValidationOptions Contains a set of flags that specify how the editor handles and displays its validation errors. Inherited from TcxCustomEditProperties.
ValidChars Specifies additional characters valid for a data-aware editor. Inherited from TcxCustomTextEditProperties.
ViewStyle Specifies the view style of the text and buttons in a text editor. Inherited from TcxCustomTextEditProperties.

Methods

Name Description
AllowRepositorySharing Inherited from TcxCustomEditProperties.
Assign(TPersistent) Inherited from TPersistent.
AssignTo(TPersistent) Inherited from TPersistent.
BeginUpdate Postpones all editor redraw operations that reflect any editor setting change until an EndUpdate procedure call. Inherited from TcxCustomEditProperties.
CanCompareEditValue Inherited from TcxCustomEditProperties.
CanModify protected Specifies whether the edit value can be modified. Inherited from TcxCustomEditProperties.
CanValidate protected Indicates if the editor supports validation. Inherited from TcxCustomEditProperties.
Changed Inherited from TcxCustomEditProperties.
ChangedLocked Inherited from TcxCustomEditProperties.
Clone(TPersistent) Inherited from TcxCustomEditProperties.
CompareDisplayValues(TcxEditValue,TcxEditValue) Inherited from TcxCustomEditProperties.
CreatePreviewProperties Inherited from TcxCustomEditProperties.
CreateViewData(TcxCustomEditStyle,Boolean,TdxScaleFactor,Boolean) Inherited from TcxCustomEditProperties.
CreateViewData(TcxCustomEditStyle,Boolean,Boolean) Inherited from TcxCustomEditProperties.
DataChanged Inherited from TcxCustomEditProperties.
DisplayValueToDisplayText(string) Inherited from TcxCustomTextEditProperties.
DoPrepareDisplayValue(TcxEditValue,TcxEditValue,Boolean) protected Inherited from TcxCustomTextEditProperties.
DoUpdate(TcxCustomEditProperties) Inherited from TcxCustomEditProperties.
EditValueToTokens(TcxEditValue) Converts the specified edit value to the list of token text strings.
EndUpdate(Boolean) Applies all pending changes and redraws the editor after a BeginUpdate procedure call. Inherited from TcxCustomEditProperties.
Equals(TObject) Inherited from TObject.
GetButtonsClass Determines the type of the button collection accessible via the Buttons property. Inherited from TcxCustomEditProperties.
GetContainerClass Determines the editor container type for the current TcxCustomEditProperties object. Inherited from TcxCustomEditProperties.
GetDisplayText(TcxEditValue,Boolean,Boolean) Inherited from TcxCustomEditProperties.
GetEditConstantPartSize(TcxCanvas,TcxCustomEditStyle,Boolean,TcxEditSizeProperties,TSize) Inherited from TcxCustomEditProperties.
GetEditContentSize(TcxCanvas,TcxCustomEditStyle,Boolean,TcxEditValue,TcxEditSizeProperties) Inherited from TcxCustomEditProperties.
GetEditSize(TcxCanvas,TcxCustomEditStyle,Boolean,TcxEditValue,TcxEditSizeProperties) Inherited from TcxCustomEditProperties.
GetEditValueSource(Boolean) Inherited from TcxCustomEditProperties.
GetHashCode Inherited from TObject.
GetLookupDataClass protected Inherited from TcxCustomTextEditProperties.
GetNamePath Inherited from TPersistent.
GetOwner Inherited from TPersistent.
GetSpecialFeatures Inherited from TcxCustomEditProperties.
GetStyleClass Determines the style type that corresponds to the current TcxCustomEditProperties object. Inherited from TcxCustomEditProperties.
GetSupportedOperations Inherited from TcxCustomEditProperties.
GetViewDataClass protected Inherited from TcxCustomEditProperties.
GetViewInfoClass Determines the ViewInfo type that corresponds to the current TcxCustomEditProperties object. Inherited from TcxCustomEditProperties.
IsActivationKey(Char) Inherited from TcxCustomEditProperties.
IsDisplayValueValid(TcxEditValue,Boolean) Determines whether the specified display value is valid. Inherited from TcxCustomTextEditProperties.
IsEditValueValid(TcxEditValue,Boolean) Ascertains whether the specified edit value is valid. Inherited from TcxCustomEditProperties.
IsResetEditClass Inherited from TcxCustomEditProperties.
IsValueFormattedByProperties Inherited from TcxCustomEditProperties.
IsValueFormattedByProvider Inherited from TcxCustomEditProperties.
LockUpdate(Boolean) Inherited from TcxCustomEditProperties.
PrepareDisplayValue(TcxEditValue,TcxEditValue,Boolean) Inherited from TcxCustomEditProperties.
QueryInterface(TGUID,Untyped) Inherited from TInterfacedPersistent.
RefreshNonShareable Inherited from TcxCustomEditProperties.
RestoreDefaults Restores a set of properties, which are dependent on field settings for data-aware editors, to their default values. Inherited from TcxCustomEditProperties.
SetMinMaxValues(Double,Double) Inherited from TcxCustomTextEditProperties.
TokensToEditValue(TStrings) Converts the specified list of token token text strings to the edit value.
ToString Inherited from TObject.
Update(TcxCustomEditProperties) Inherited from TcxCustomEditProperties.
ValidateDisplayValue(TcxEditValue,TCaption,Boolean,TcxCustomEdit) Validates the specified display value.

Events

Name Description
OnButtonClick Allows you to execute custom code when a user clicks an embedded editor button. Inherited from TcxCustomEditProperties.
OnButtonGlyphDrawParameters Allows you to customize the appearance of individual editor button glyphs. Inherited from TcxCustomEditProperties.
OnChange Occurs on changing the value within an editor. Inherited from TcxCustomEditProperties.
OnClosePopup Inherited from TcxCustomEditProperties.
OnCustomDrawToken Enables you to implement the custom painter for token boxes in the token editor.
OnEditValueChanged Allows you to respond to edit value changes. Inherited from TcxCustomEditProperties.
OnNewLookupDisplayText Allows you to respond to new user input that does not match one of the automatic completion list entries. Inherited from TcxCustomTextEditProperties.
OnPropertiesChanged Occurs on every editor setting change. Inherited from TcxCustomEditProperties.
OnTokenAdd Enables you to respond to an attempt to add a new token to the token editor.
OnTokenClick Allows you to perform specific actions when a user clicks a token box in the token editor.
OnTokenDelete Enables you to respond to an attempt to remove a token box from the token editor.
OnTokenGlyphClick Enables you to respond to clicking a token glyph within the token editor.
OnValidate Occurs before converting the display value to the edit value. Inherited from TcxCustomEditProperties.
See Also