Back to Devexpress

DevExpress.XtraRichEdit Namespace

officefileapi-devexpress-2ef4f2a5.md

latest28.1 KB
Original Source

DevExpress.XtraRichEdit Namespace

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

Assemblies : DevExpress.Docs.v25.2.dll, DevExpress.RichEdit.v25.2.Core.dll

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

Classes

NameDescription
AnnotationOptionsProvides options for annotations (comments and tracked changes).
ArgumentAn argument within the document field.
ArgumentCollectionA collection of Argument objects. Results from parsing a document field.
AuthenticationOptionsRepresents a set of credentials used to identify editable ranges in a protected document.
AutoCorrectEventArgsProvides data for the RichEditControl.AutoCorrect event.
AutoCorrectInfoProvides data and methods that enable you to process input text and calculate the replacement object when handling the RichEditControl.AutoCorrect event.
AutoCorrectOptionsContains options specifying what autocorrect features are enabled.
AutoCorrectReplaceInfoContains the text to find and the object to replace it. Used for the table-based autocorrect functionality.
AutoCorrectReplaceInfoCollectionA collection of AutoCorrectReplaceInfo objects.
BeforeExportEventArgsProvides data for the RichEditControl.BeforeExport event.
BeforeImportEventArgsProvides data for the RichEditControl.BeforeImport event.
BeforePagePaintEventArgsProvides data for the BeforePagePaint event of the RichEditControl and RichEditDocumentServer.
BookmarkOptionsContains settings used to define the bookmark appearance and behavior in the Rich Text Editor.
CalculateDocumentVariableEventArgsProvides data for the CalculateDocumentVariable event.
CommentEditingEventArgsProvides data for the RichEditControl.CommentInserted event.
CommentOptionsContains options for displaying the comments in a document.
CopyPasteOptionsContains options affecting certain copy-paste scenarios.
CustomizeMergeFieldsEventArgsProvides data for the CustomizeMergeFields event.
DataFormatOptionsContains settings related to the clipboard operations with different document formats.
DecryptionFailedEventArgsProvides data for the DecryptionFailed event.
DocumentCapabilitiesOptionsRepresents the storage of settings specific for the document restrictions.
DocumentSaveOptionsRepresents the settings which define file name and file format that are used when saving and loading the document.
DocumentSearchOptionsContains settings which specify parameters affecting search in a document.
DocumentVariableCollectionA collection of document variables.
DocVariableValueA class which allows you to specify the current value of a DOCVARIABLE field in the Document.CalculateDocumentVariable event handler.
DraftViewRepresents a draft view of the Rich Edit control.
DraftViewLayoutOptionsContains settings which affect the layout of the Draft view.
EncryptedFileIntegrityCheckFailedEventArgsProvides data for the EncryptedFileIntegrityCheckFailed event.
EncryptedFilePasswordCheckFailedEventArgsProvides data for the EncryptedFilePasswordCheckFailed event.
EncryptedFilePasswordRequestedEventArgsProvides data for the EncryptedFilePasswordRequest event.
FieldOptionsContains options used to define the appearance and behavior of the document fields.
FontSubstitutionOptionsContains font substitution options.
FormattingMarkVisibilityOptionsContains settings specifying which formatting marks (paragraph marks, spaces, tabs etc.) are visible.
HeaderFooterEditingEventArgsProvides data for the StartHeaderFooterEditing and the FinishHeaderFooterEditing events.
HitTestManagerProvides hit testing for the RichEditControl.
HorizontalRulerOptionsRepresents the class containing options for the horizontal ruler.
HyperlinkClickEventArgsProvides data for the RichEditControl.HyperlinkClick event.
HyperlinkOptionsContains settings used to define the hyperlink appearance in the Rich Text Editor.
MailMergeCustomSeparatorsContains custom separators used in numeric format switches of the document fields.
MailMergeFinishedEventArgsProvides data for the MailMergeFinished event.
MailMergeRecordFinishedEventArgsProvides data for the MailMergeRecordFinished event.
MailMergeRecordStartedEventArgsProvides data for the MailMergeRecordStarted event.
MailMergeStartedEventArgsProvides data for the MailMergeStarted event.
NumberingOptionsRepresents the class containing options for the availability of numbered and bulleted lists in the document.
PageLayoutPositionCombines the page index and position in the page layout.
PrintingOptionsContains settings which specify parameters affecting how the document is printed.
PrintLayoutViewRepresents a page layout view of the Rich Edit control.
PrintLayoutViewLayoutOptionsContains settings which affect the layout of the PrintLayout view.
RangePermissionOptionsRepresents settings which define how the ranges with permissions are marked in the document.
RichEditBehaviorOptionsSpecifies the restricted operations that cannot be performed by end-users over a document.
RichEditBrushBasePlatform-independent brush. Its platform-specific implementations are used to fill shapes and draw text on the layout PageCanvas.
RichEditClipboardSetDataExceptionEventArgsProvides data for the RichEditControl.ClipboardSetDataException event.
RichEditControlCompatibility staticAllows you to set common parameters for all RichEditControl instances in the application.
RichEditControlOptionsBaseRepresents the base class for the RichEditControl and RichEditDocumentServer options.
RichEditDecryptionExceptionFires under certain conditions when an attempt to load a password-protected .doc file fails.
RichEditDocumentServerA 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

NameDescription
IDataSourceContainerOptionsDefines parameters required to connect to an external data source.
IRichEditControlInterface implemented to facilitate creating certain types of RichEdit objects, such as commands.
IRichEditDocumentServerInterface of a rich text engine providing the essential Rich Editor functionality.
IRichEditViewVisitorInterface implementing the Visitor pattern.

Structs

NameDescription
DocumentExportCapabilitiesRepresents the formatting capabilities required for correct export of the document.
DocumentFormatA document format.
PageLayoutInfoCombines the page index and page bounds.

Delegates

NameDescription
AutoCorrectEventHandlerA method that will handle the RichEditControl.AutoCorrect event.
BeforeExportEventHandlerRepresents a method that will handle the RichEditControl.BeforeExport event.
BeforeImportEventHandlerRepresents a method that will handle the RichEditControl.BeforeImport event.
BeforePagePaintEventHandlerA method that will handle the BeforePagePaint event of the RichEditControl or RichEditDocumentServer.
CalculateDocumentVariableEventHandlerA method that will handle the CalculateDocumentVariable event.
CommentEditingEventHandlerA method that will handle the CommentInserted event of the RichEditControl.
CustomizeMergeFieldsEventHandlerA method that will handle the RichEditControl.CustomizeMergeFields event.
DecryptionFailedEventHandlerReferences a method that will handle the DecryptionFailed event.
EncryptedFileIntegrityCheckFailedEventHandlerA method that will handle the RichEditDocumentServer.EncryptedFileIntegrityCheckFailed, XtraRichEdit.RichEditControl.EncryptedFileIntegrityCheckFailed, and Xpf.RichEdit.RichEditControl.EncryptedFileIntegrityCheckFailed event.
EncryptedFilePasswordCheckFailedEventHandlerRepresents a method that will handle the EncryptedFilePasswordCheckFailed event.
EncryptedFilePasswordRequestedEventHandlerA method that will handle the RichEditDocumentServer.EncryptedFilePasswordRequested, XtraRichEdit.RichEditControl.EncryptedFilePasswordRequested, and Xpf.RichEdit.RichEditControl.EncryptedFilePasswordRequested event.
HeaderFooterEditingEventHandlerA method that will handle the HeaderFooterEditing event.
HyperlinkClickEventHandlerRepresents a method that will handle the RichEditControl.HyperlinkClick event.
MailMergeFinishedEventHandlerA method that will handle the MailMergeFinished event of the RichEditControl.
MailMergeRecordFinishedEventHandlerA method that will handle the MailMergeRecordFinished event of the RichEditControl.
MailMergeRecordStartedEventHandlerA method that will handle the MailMergeRecordStarted event of the RichEditControl.
MailMergeStartedEventHandlerA method that will handle the MailMergeStarted event of the RichEditControl.
RichEditClipboardSetDataExceptionEventHandlerRepresents a method that will handle the RichEditControl.ClipboardSetDataException event.
RichEditInvalidFormatExceptionEventHandlerReferences a method that will handle the RichEditDocumentServer.InvalidFormatException, RichEditControl.InvalidFormatException and RichEditControl.InvalidFormatException events.
RichEditUnhandledExceptionEventHandlerRepresents a method that will handle the UnhandledException event of the RichEditControl.
SpellingErrorLimitExceededEventHandlerA method that will handle the RichEditControl.SpellingErrorLimitExceeded event.
TrackedMovesConflictEventHandlerReferences a method that will handle the TrackedMovesConflict event.

Enums

NameDescription
AutoSizeModeLists how the control is resized to fit its contents.
CalculationModeTypeLists modes for layout calculation.
ChangedLinesMarkupPositionLists values used to indicate the position of a markup indicating changed document lines.’
ConflictNameActionLists actions that can be performed when a bookmark in the document being inserted and in the target document have the same name.
DisplayDeletionStyleLists values used to indicate the markup style for deleted content.
DisplayFormattingLists values used to indicate how to markup content with changed format options.
DisplayForReviewModeLists values used to indicate how changes are displayed in the document.
DisplayInsertionStyleLists values used to indicate the markup style for inserted content.
DocumentCapabilityLists the availability of a certain functionality in the XtraRichEdit document.
DocumentLayoutUnitLists measurement units used for the document layout.
DocumentViewDirectionLists values indicating the page order in Print Layout view and in Print Preview.
DragDropModeLists the values used to specify the drag-and-drop mode of the DragDropMode.
FieldsHighlightModeLists conditions for highlighting the fields in the document.
HitTestSearchOptionLists the hit test’s accuracy level.
HtmlImageSourceTypeList types of images that can be included in the HTML content of the Clipboard.
LineBreakSubstituteLists variants for substituting the line break.
PageBreakInsertModeLists the values specifying the mode for inserting a page break into a document.
PasteModeLists modes characterizing how the formatting of the destination document is applied to the text being pasted.
PdfBookmarkDisplayModeLists values used to specify what bookmarks of a document exported to PDF should appear in the PDF Viewer’s Bookmarks panel.
PrintPreviewFormKindLists the values specifying the user interface of the Print Preview form.
RevisionColorLists values used to indicate the color for revision markup.
RichEditBaseValueSourceLists possible sources of a particular property value.
RichEditBookmarkVisibilityLists values specifying the visibility of bookmarks.
RichEditClipboardModeLists values that indicate what format-specific clipboard operations are allowed.
RichEditCommentVisibilityLists values specifying the visibility of comments.
RichEditDashStyleLists styles of dashed lines drawn with the RichEditPenBase object and its descendants.
RichEditDecryptionErrorLists possible errors which occur while attempting to load a password-encrypted document.
RichEditFormattingMarkVisibilityLists values specifying the visibility of formatting marks.
RichEditPageHorizontalAlignmentLists values that specify how to align pages in the PrintLayoutView.
RichEditRangePermissionVisibilityLists values specifying the visibility of indicators for ranges with permissions (highlighting, enclosing brackets).
RichEditRulerVisibilitySpecifies the visibility of a ruler.
RichEditTableGridLinesVisibilityLists values specifying the visibility of grid lines in table cells without borders.
RichEditViewTypeSpecifies the view used to show the document within the RichEditControl.
TableCellRevisionColorLists values used to indicate revisions made in table cells.
TrackedMovesConflictResolveModeLists values used to indicate what version of the moved text to keep.
UpdateDocVariablesBeforePrintLists modes that determine whether DOCVARIABLE fields are recalculated before printing or export to PDF.
UpdateLockedFieldsLists options which determine how the Field.Locked property affects field updates.