Skip to main content

DevExpress.XtraRichEdit Namespace

Contains classes which implement the main functionality of the RichEdit suite.

Assemblies: DevExpress.Docs.v24.1.dll, DevExpress.RichEdit.v24.1.Core.dll

NuGet Packages: DevExpress.Document.Processor, DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Classes

Name Description
AnnotationOptions Provides options for annotations (comments and tracked changes).
Argument An argument within the document field.
ArgumentCollection A collection of Argument objects. Results from parsing a document field.
AuthenticationOptions Represents a set of credentials used to identify editable ranges in a protected document.
AutoCorrectEventArgs Provides data for the RichEditControl.AutoCorrect event.
AutoCorrectInfo Provides data and methods that enable you to process input text and calculate the replacement object when handling the RichEditControl.AutoCorrect event.
AutoCorrectOptions Contains options specifying what autocorrect features are enabled.
AutoCorrectReplaceInfo Contains the text to find and the object to replace it. Used for the table-based autocorrect functionality.
AutoCorrectReplaceInfoCollection A collection of AutoCorrectReplaceInfo objects.
BeforeExportEventArgs Provides data for the RichEditControl.BeforeExport event.
BeforeImportEventArgs Provides data for the RichEditControl.BeforeImport event.
BeforePagePaintEventArgs Provides data for the BeforePagePaint event of the RichEditControl and RichEditDocumentServer.
BookmarkOptions Contains settings used to define the bookmark appearance and behavior in the Rich Text Editor.
CalculateDocumentVariableEventArgs Provides data for the CalculateDocumentVariable event.
CommentEditingEventArgs Provides data for the RichEditControl.CommentInserted event.
CommentOptions Contains options for displaying the comments in a document.
CopyPasteOptions Contains options affecting certain copy-paste scenarios.
CustomizeMergeFieldsEventArgs Provides data for the CustomizeMergeFields event.
DataFormatOptions Contains settings related to the clipboard operations with different document formats.
DecryptionFailedEventArgs Provides data for the DecryptionFailed event.
DocumentCapabilitiesOptions Represents the storage of settings specific for the document restrictions.
DocumentSaveOptions Represents the settings which define file name and file format that are used when saving and loading the document.
DocumentSearchOptions Contains settings which specify parameters affecting search in a document.
DocumentVariableCollection A collection of document variables.
DocVariableValue A class which allows you to specify the current value of a DOCVARIABLE field in the Document.CalculateDocumentVariable event handler.
DraftView Represents a draft view of the Rich Edit control.
DraftViewLayoutOptions Contains settings which affect the layout of the Draft view.
EncryptedFileIntegrityCheckFailedEventArgs Provides data for the EncryptedFileIntegrityCheckFailed event.
EncryptedFilePasswordCheckFailedEventArgs Provides data for the EncryptedFilePasswordCheckFailed event.
EncryptedFilePasswordRequestedEventArgs Provides data for the EncryptedFilePasswordRequest event.
FieldOptions Contains options used to define the appearance and behavior of the document fields.
FontSubstitutionOptions Contains font substitution options.
FormattingMarkVisibilityOptions Contains settings specifying which formatting marks (paragraph marks, spaces, tabs etc.) are visible.
HeaderFooterEditingEventArgs Provides data for the StartHeaderFooterEditing and the FinishHeaderFooterEditing events.
HitTestManager Provides hit testing for the RichEditControl.
HorizontalRulerOptions Represents the class containing options for the horizontal ruler.
HyperlinkClickEventArgs Provides data for the RichEditControl.HyperlinkClick event.
HyperlinkOptions Contains settings used to define the hyperlink appearance in the Rich Text Editor.
MailMergeCustomSeparators Contains custom separators used in numeric format switches of the document fields.
MailMergeFinishedEventArgs Provides data for the MailMergeFinished event.
MailMergeRecordFinishedEventArgs Provides data for the MailMergeRecordFinished event.
MailMergeRecordStartedEventArgs Provides data for the MailMergeRecordStarted event.
MailMergeStartedEventArgs Provides data for the MailMergeStarted event.
NumberingOptions Represents the class containing options for the availability of numbered and bulleted lists in the document.
PageLayoutPosition Combines the page index and position in the page layout.
PrintingOptions Contains settings which specify parameters affecting how the document is printed.
PrintLayoutView Represents a page layout view of the Rich Edit control.
PrintLayoutViewLayoutOptions Contains settings which affect the layout of the PrintLayout view.
RangePermissionOptions Represents settings which define how the ranges with permissions are marked in the document.
RichEditBehaviorOptions Specifies the restricted operations that cannot be performed by end-users over a document.
RichEditBrushBase Platform-independent brush. Its platform-specific implementations are used to fill shapes and draw text on the layout PageCanvas.
RichEditClipboardSetDataExceptionEventArgs Provides data for the RichEditControl.ClipboardSetDataException event.
RichEditControlCompatibility static Allows you to set common parameters for all RichEditControl instances in the application.
RichEditControlOptionsBase Represents the base class for the RichEditControl and RichEditDocumentServer options.
RichEditDecryptionException Fires under certain conditions when an attempt to load a password-protected .doc file fails.
RichEditDocumentServer A non-visual .NET library providing all the word processing functionality.
RichEditDocumentServerExtensions static

Defines extension methods for the RichEditDocumentServer class.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use these methods in production code.

RichEditHitTestResult Provides options used to retrieve information about the layout element located under the hit point.
RichEditInvalidFormatExceptionEventArgs Provides data for the RichEditDocumentServer.InvalidFormatException, RichEditControl.InvalidFormatException and RichEditControl.InvalidFormatException events.
RichEditLayoutOptions Represents the class containing miscellaneous layout options.
RichEditMailMergeOptions Contains common mail merge options.
RichEditNotificationOptions Represents a base class for the classes containing different options used in the RichEditControl.
RichEditPenBase Platform-independent pen. Its platform-specific implementations are used to draw ellipses, lines and rectangles on the layout PageCanvas.
RichEditUnhandledExceptionEventArgs Provides data for the RichEditControl.UnhandledException event.
RichEditView Represents a base class for the RichEditControl views.
RichEditViewRepository Represents a repository for the views of the Rich Edit control.
RulerOptions Represents the base class for ruler options.
SimpleView Represents a simple view of the Rich Edit control.
SimpleViewLayoutOptions Contains settings which affect the layout of the Simple view.
SpellCheckerOptions Contains options that specify how the spell checker should process text in any range of the document.
SpellingErrorLimitExceededEventArgs Provides data for the RichEditControl.SpellingErrorLimitExceeded event.
TableOptions Represents the class containing miscellaneous table options.
TrackChangesOptions Represents Track Changes color options.
TrackedMovesConflictEventArgs Provides data for the TrackedMovesConflict event.
VerticalRulerOptions Represents the class containing options for the vertical ruler.

Interfaces

Name Description
IDataSourceContainerOptions Defines parameters required to connect to an external data source.
IRichEditControl Interface implemented to facilitate creating certain types of RichEdit objects, such as commands.
IRichEditDocumentServer Interface of a rich text engine providing the essential Rich Editor functionality.
IRichEditViewVisitor Interface implementing the Visitor pattern.

Structs

Name Description
DocumentExportCapabilities Represents the formatting capabilities required for correct export of the document.
DocumentFormat A document format.
PageLayoutInfo Combines the page index and page bounds.

Delegates

Name Description
AutoCorrectEventHandler A method that will handle the RichEditControl.AutoCorrect event.
BeforeExportEventHandler Represents a method that will handle the RichEditControl.BeforeExport event.
BeforeImportEventHandler Represents a method that will handle the RichEditControl.BeforeImport event.
BeforePagePaintEventHandler A method that will handle the BeforePagePaint event of the RichEditControl or RichEditDocumentServer.
CalculateDocumentVariableEventHandler A method that will handle the CalculateDocumentVariable event.
CommentEditingEventHandler A method that will handle the CommentInserted event of the RichEditControl.
CustomizeMergeFieldsEventHandler A method that will handle the RichEditControl.CustomizeMergeFields event.
DecryptionFailedEventHandler References a method that will handle the DecryptionFailed event.
EncryptedFileIntegrityCheckFailedEventHandler A method that will handle the RichEditDocumentServer.EncryptedFileIntegrityCheckFailed, XtraRichEdit.RichEditControl.EncryptedFileIntegrityCheckFailed, and Xpf.RichEdit.RichEditControl.EncryptedFileIntegrityCheckFailed event.
EncryptedFilePasswordCheckFailedEventHandler Represents a method that will handle the EncryptedFilePasswordCheckFailed event.
EncryptedFilePasswordRequestedEventHandler A method that will handle the RichEditDocumentServer.EncryptedFilePasswordRequested, XtraRichEdit.RichEditControl.EncryptedFilePasswordRequested, and Xpf.RichEdit.RichEditControl.EncryptedFilePasswordRequested event.
HeaderFooterEditingEventHandler A method that will handle the HeaderFooterEditing event.
HyperlinkClickEventHandler Represents a method that will handle the RichEditControl.HyperlinkClick event.
MailMergeFinishedEventHandler A method that will handle the MailMergeFinished event of the RichEditControl.
MailMergeRecordFinishedEventHandler A method that will handle the MailMergeRecordFinished event of the RichEditControl.
MailMergeRecordStartedEventHandler A method that will handle the MailMergeRecordStarted event of the RichEditControl.
MailMergeStartedEventHandler A method that will handle the MailMergeStarted event of the RichEditControl.
RichEditClipboardSetDataExceptionEventHandler Represents a method that will handle the RichEditControl.ClipboardSetDataException event.
RichEditInvalidFormatExceptionEventHandler References a method that will handle the RichEditDocumentServer.InvalidFormatException, RichEditControl.InvalidFormatException and RichEditControl.InvalidFormatException events.
RichEditUnhandledExceptionEventHandler Represents a method that will handle the UnhandledException event of the RichEditControl.
SpellingErrorLimitExceededEventHandler A method that will handle the RichEditControl.SpellingErrorLimitExceeded event.
TrackedMovesConflictEventHandler References a method that will handle the TrackedMovesConflict event.

Enums

Name Description
AutoSizeMode Lists how the control is resized to fit its contents.
CalculationModeType Lists modes for layout calculation.
ChangedLinesMarkupPosition Lists values used to indicate the position of a markup indicating changed document lines.’
ConflictNameAction Lists actions that can be performed when a bookmark in the document being inserted and in the target document have the same name.
DisplayDeletionStyle Lists values used to indicate the markup style for deleted content.
DisplayFormatting Lists values used to indicate how to markup content with changed format options.
DisplayForReviewMode Lists values used to indicate how changes are displayed in the document.
DisplayInsertionStyle Lists values used to indicate the markup style for inserted content.
DocumentCapability Lists the availability of a certain functionality in the XtraRichEdit document.
DocumentLayoutUnit Lists measurement units used for the document layout.
DocumentViewDirection Lists values indicating the page order in Print Layout view and in Print Preview.
DragDropMode Lists the values used to specify the drag-and-drop mode of the DragDropMode.
FieldsHighlightMode Lists conditions for highlighting the fields in the document.
HitTestSearchOption Lists the hit test’s accuracy level.
HtmlImageSourceType List types of images that can be included in the HTML content of the Clipboard.
LineBreakSubstitute Lists variants for substituting the line break.
PageBreakInsertMode Lists the values specifying the mode for inserting a page break into a document.
PasteMode Lists modes characterizing how the formatting of the destination document is applied to the text being pasted.
PdfBookmarkDisplayMode Lists values used to specify what bookmarks of a document exported to PDF should appear in the PDF Viewer’s Bookmarks panel.
PrintPreviewFormKind Lists the values specifying the user interface of the Print Preview form.
RevisionColor Lists values used to indicate the color for revision markup.
RichEditBaseValueSource Lists possible sources of a particular property value.
RichEditBookmarkVisibility Lists values specifying the visibility of bookmarks.
RichEditClipboardMode Lists values that indicate what format-specific clipboard operations are allowed.
RichEditCommentVisibility Lists values specifying the visibility of comments.
RichEditDashStyle Lists styles of dashed lines drawn with the RichEditPenBase object and its descendants.
RichEditDecryptionError Lists possible errors which occur while attempting to load a password-encrypted document.
RichEditFormattingMarkVisibility Lists values specifying the visibility of formatting marks.
RichEditPageHorizontalAlignment Lists values that specify how to align pages in the PrintLayoutView.
RichEditRangePermissionVisibility Lists values specifying the visibility of indicators for ranges with permissions (highlighting, enclosing brackets).
RichEditRulerVisibility Specifies the visibility of a ruler.
RichEditTableGridLinesVisibility Lists values specifying the visibility of grid lines in table cells without borders.
RichEditViewType Specifies the view used to show the document within the RichEditControl.
TableCellRevisionColor Lists values used to indicate revisions made in table cells.
TrackedMovesConflictResolveMode Lists values used to indicate what version of the moved text to keep.
UpdateDocVariablesBeforePrint Lists modes that determine whether DOCVARIABLE fields are recalculated before printing or export to PDF.
UpdateLockedFields Lists options which determine how the Field.Locked property affects field updates.