TcxCustomMRUEditProperties Class
The base class for MRU editor settings.
Declaration
TcxCustomMRUEditProperties = class(
TcxCustomComboBoxProperties
)Remarks
A MRU editor is a single-line text box editor that can display a drop-down list of most recently used (MRU) items.
End-User Keyboard Interaction Options
The MRU Editor supports the following keystrokes:
- ↑ | ↓
- Switch between MRU list items, even when the drop-down list is collapsed.
- Ctrl + Page Up | Ctrl + Page Down
- Select first and last items, respectively.
- Alt + ↑ | Alt + ↓ | F4
- Display or hide the drop-down MRU list.
Ellipsis Button Activation
The MRU editor displays an additional ellipsis button without predefined functionality. You can handle the OnButtonClick event to execute custom code in response to a click on the ellipsis button.
Users can press Ctrl + Enter to activate the ellipsis button using the keyboard. You can use the ClickKey property to change the key combination associated with the ellipsis button.
Main API Members
The list below outlines key members of the TcxCustomMRUEditProperties class.
Appearance Settings
- Alignment | UseLeftAlignmentOnEditing
- Specify content alignment.
- Images
- Specifies the image source for editor button glyphs.
- KeepArrowButtonPressedWhenDroppedDown
- Specifies if the drop-down button retains the pressed state while the drop-down window is displayed.
- Nullstring | UseNullString
- Allow you to display a custom while the editor box is empty.
- OnButtonGlyphDrawParameters
- Allows you to customize the appearance of editor button glyphs.
User Interaction Options
- Automation
Provides access to UI Automation and accessibility-related settings.
Tip
Use Automation.Name and Automation.Description, and other API members to specify information visible to third-party assistive tools as UIA node properties.
- AllowDropDownWhenReadOnly
- Specifies if the editor can display the drop-down window in read-only mode.
- AutoSelect
- Specifies if the editor automatically selects its content when it receives focus.
- ClearKey | ClickKey
- Allow you to associate keystrokes with basic user actions.
- OnButtonClick | OnClosePopup
- Allow you to execute custom code when a user clicks embedded editor buttons and closes the editor’s drop-down window.
- OnCloseQuery
- Allows you to prevent users from closing the drop-down MRU list.
- PopupSizeable
- Specifies if users can resize the displayed MRU list.
- PostPopupValueOnTab
- Specifies if the editor sets the item selected in the drop-down list as the edit value when a user presses Tab.
- ReadOnly
- Specifies if the editor is in read-only mode.
- Revertable
- Specifies if users can double-click the editor to cycle through all values available for selection.
- ShowEllipsis
Specifies if the editor displays an additional ellipsis button. The button has no predefined functionality.
Handle the OnButtonClick event to execute custom code in response to a click on the ellipsis button.
- UseMouseWheel
- Specifies if the editor always responds to mouse wheel rotation.
MRU List & Drop-Down Window Management
- AddItem
- Adds a new item or moves a specified existing item to the top of the MRU list.
- DropDownAutoWidth
- Specifies if drop-down window width is calculated automatically.
- DropDownRows
- Specifies the number of simultaneously visible items in the editor’s drop-down window.
- DropDownSizeable
- Specifies if users can resize the drop-down window.
- DropDownWidth
- Allows you to specify drop-down window width explicitly.
- ItemHeight
- Allows you to specify drop-down item height explicitly.
- MaxItemCount
Allows you to limit the number of stored most recently used items. If the specified limit is reached, the oldest item is removed from the MRU list.
You can handle the OnDeleteLookupItem event to execute custom code in response to such MRU item remove operations.
Content-Related Settings
- MaxLength
- Allows you to limit the string length for user input. This setting does not affect EditValue and other options available in code.
- Items | LookupItems
- Provide access to the list of MRU items.
- Sorted
- Specifies if combo box items are sorted in alphabetical order.
General-Purpose API Members
- AssignedValues | RestoreDefaults
- Allow you to track the state of individual editor-specific settings and reset them.
- BeginUpdate | EndUpdate | LockUpdate | DoUpdate | Update | Changed | ChangedLocked | DataChanged
- Allow you to manage editor updates and avoid excessive redraw operations during batch editor setting changes.
Terminal TcxCustomMRUEditProperties Class Descendant
Do not use the TcxCustomMRUEditProperties class directly. Use the TcxMRUEditProperties class instead.