TcxRichEditProperties Class
Stores rich text editor settings.
Declaration
TcxRichEditProperties = class(
TcxCustomRichEditProperties
)Remarks
A rich text editor (TcxRichEdit or TcxDBRichEdit) component is a multi-line text box editor designed to view and edit Rich Text Format (RTF) documents.
In this topic…
Main API Members
The list below outlines key members of the TcxCustomRichEditProperties class.
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.
- OnQueryInsertObject
- Allows you to prevent users from inserting specific objects into the editor.
- OnSelectionChange
- Allows you to respond to selection changes in the editor.
- OnURLClick | OnURLHint | OnURLMove
- Allow you to override predefined user interaction with hyperlinks within content.
- ReadOnly
- Enables or disables read-only mode. You can use the editor’s Style.ReadOnly and StyleReadOnly properties to customize editor appearance options for the read-only state.
Common Text Editor Settings
- AutoSelect
- Specifies if content is selected automatically when the editor receives focus.
- MaxLength
- Allows you to limit the maximum number of characters in the editor.
- VisibleLineCount
- Allows you to specify editor height in text lines.
- WantReturns
- Specifies if users can input carriage return (CR) characters (Enter).
- WantTabs
- Specifies if users can input tab characters (Tab).
- WordWrap
- Specifies if word wrap mode is enabled.
Rich Text Editor-Specific Settings
- AdvancedTypography
- Specifies if advanced typography features (tables, bulleted/numbered lists, etc.) are enabled.
- AllowObjects
- Specifies if OLE operations are enabled.
- AutoURLDetect
- Specifies if automatic URL detection is enabled for user input.
- HideScrollBars
- Specifies if scrollbars are automatically hidden when the editor displays content in full.
- MemoMode
- Specifies if the editor displays RTF content without formatting (memo mode).
- PlainText
- Specifies if the editor displays RTF tags in loaded formatted content (plain text mode).
- SelectionBar
- Specifies if an auxiliary blank region (for line selection) is displayed.
- ShowURLHint
- Specifies if URL hints are displayed for hyperlinks defined in content.
- RichEditClass
- Specifies the active rich text editor engine version.
- ZoomFactor
- Allows you to zoom displayed content in or out.
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.
Direct TcxRichEditProperties Class References
The following properties reference a TcxRichEditProperties class:
- TcxEditRepositoryRichItem.Properties
- Provides access to stored rich text editor settings.
- TcxRichEdit.ActiveProperties
- Provides access to active rich text editor settings.
- TcxRichEdit.Properties
- Provides access to rich text editor settings.
- TcxDBRichEdit.ActiveProperties
- Provides access to active rich text editor settings.
- TcxDBRichEdit.Properties
- Provides access to rich text editor settings.
Inheritance
See Also