Skip to main content
BuyLog In
Office File API
Search in…
Docs > API Reference > DevExpress.XtraRichEdit.API.Native > Document > Members
All docs
V24.1
Office File API
Demo Application
Install NuGet Packages
Redistribution and Deployment (.NET Framework)
.NET/.NET Core Support
Cloud Integration
Blazor Integration
Dockerize an Office File API Application
Use Office File API in .NET MAUI Applications
Backend Web/REST API for Office File API
Load and Use Custom Fonts in Office File API
Sign Office Documents
Spreadsheet Document API
Word Processing Document API
PDF Document API
Excel Export Library
Snap Report API
Zip Compression and Archive API
Barcode Generation API
Unit Conversion API
API Reference
DevExpress.BarCodes
DevExpress.Compression
DevExpress.Docs.Text
DevExpress.Office
DevExpress.Office.DigitalSignatures
DevExpress.Office.Drawing
DevExpress.Office.Export
DevExpress.Office.Export.Html
DevExpress.Office.Import
DevExpress.Office.Localization
DevExpress.Office.Options
DevExpress.Office.Services
DevExpress.Office.Tsp
DevExpress.Office.Utils
DevExpress.Pdf
DevExpress.Pdf.Localization
DevExpress.Pdf.Xmp
DevExpress.Spreadsheet
DevExpress.Spreadsheet.Charts
DevExpress.Spreadsheet.Drawings
DevExpress.Spreadsheet.Export
DevExpress.Spreadsheet.Formulas
DevExpress.Spreadsheet.Functions
DevExpress.UnitConversion
DevExpress.XtraPrinting
DevExpress.XtraRichEdit
DevExpress.XtraRichEdit.API.Layout
DevExpress.XtraRichEdit.API.Native
AbstractNumberingList
AbstractNumberingListCollection
ActiveXControlType
ActiveXFormat
AutoFitBehaviorType
Bookmark
BookmarkCollection
CanvasShapeCollection
Capture
CaptureCollection
CharacterProperties
CharacterPropertiesBase
CharacterPropertiesMask
CharacterStyle
CharacterStyleCollection
ChartFormat
ChartType
CheckBox
CheckBoxSizeMode
CheckBoxState
Comment
CommentCollection
CompatibilityMode
CompatibilitySettings
ConditionalTableStyleFormattingTypes
ConnectorFormat
ConnectorType
ContentControlAppearanceType
ContentControlBase
ContentControlBuildingBlockGallery
ContentControlCheckbox
ContentControlCollection
ContentControlComboBox
ContentControlDate
ContentControlDropDownList
ContentControlListBase
ContentControlListItem
ContentControlPicture
ContentControlPlainText
ContentControlRepeatingSection
ContentControlRepeatingSectionItem
ContentControlRichText
ContentControlType
CustomHyphenationDictionary
CustomMark
CustomMarkCollection
CustomXmlPartCollection
Document
Members
Properties
Methods
Events
DocumentBookmark
DocumentBookmarkEnd
DocumentBookmarkStart
DocumentCheckBox
DocumentCommentElement
DocumentCommentEnd
DocumentCommentStart
DocumentCustomProperties
DocumentElementBase
DocumentElementType
DocumentEncryption
DocumentEndnoteCustomMark
DocumentEndnoteEmptyReference
DocumentEndnoteReference
DocumentFieldCodeEnd
DocumentFieldCodeStart
DocumentFieldResultEnd
DocumentFootnoteCustomMark
DocumentFootnoteEmptyReference
DocumentFootnoteReference
DocumentFormFieldBase
DocumentHyperlink
DocumentHyperlinkEnd
DocumentHyperlinkStart
DocumentImage
DocumentImageCollection
DocumentImageSource
DocumentInlinePicture
DocumentIterator
DocumentParagraphEnd
DocumentParagraphStart
DocumentPicture
DocumentPosition
DocumentProperties
DocumentProtectionType
DocumentRange
DocumentRangeExtensions
DocumentRangePermissionEnd
DocumentRangePermissionStart
DocumentSectionEnd
DocumentSectionStart
DocumentTableCellBorder
DocumentText
DocumentTextBox
DocumentTheme
DocumentTrackChangesOptions
DocumentVisitorBase
DrawingObject
EncryptionSettings
EncryptionType
EndnoteOptions
EndnotePosition
Field
FieldCollection
FillType
FixedRange
FootnoteOptions
FootnotePosition
FormField
FormFieldCollection
FormFieldTextType
FormFieldType
GradientFill
GradientStop
GradientStopCollection
GradientType
Group
GroupCollection
GroupShapeCollection
GutterPosition
HeaderFooterType
HeightType
Hyperlink
HyperlinkCollection
HyphenationDictionaryBase
ICustomXmlPart
IDocumentElement
IDocumentTheme
IDocumentVisitor
IHyphenationDictionary
ImageWatermarkOptions
InsertOptions
IRegexSearchResult
ISearchResult
LineAlignment
LineArrowSize
LineArrowType
LineCapType
LineCompoundType
LineDashType
LineFillFormat
LineJoinType
LineNumberingRestart
ListLevel
ListLevelProperties
MailMergeNumberingRestart
MailMergeOptions
MarginType
Match
MergeFieldName
MergeMode
NestedShape
NestedShapeCollection
Note
NoteCollection
NoteRestartType
NoteSeparatorType
NumberingFormat
NumberingList
NumberingListBase
NumberingListCollection
NumberingType
ObjectFormatBase
OleFormat
OleInsertType
OleObjectRepresentationType
OleObjectType
OlePackage
OpenOfficeHyphenationDictionary
OverrideListLevel
Paragraph
ParagraphAlignment
ParagraphCollection
ParagraphFirstLineIndent
ParagraphLineSpacing
ParagraphProperties
ParagraphPropertiesBase
ParagraphPropertiesMask
ParagraphPropertiesWithTabs
ParagraphStyle
ParagraphStyleCollection
PatternFill
PatternFillType
PictureFill
PictureFormat
RangePermission
RangePermissionCollection
ReadOnlyBookmarkCollection
ReadOnlyCheckBoxProperties
ReadOnlyCommentCollection
ReadOnlyCustomMarkCollection
ReadOnlyDocumentBuiltInProperties
ReadOnlyDocumentCustomProperties
ReadOnlyDocumentImageCollection
ReadOnlyDocumentProperties
ReadOnlyEndnoteOptions
ReadOnlyFieldCollection
ReadOnlyFootnoteOptions
ReadOnlyFormFieldProperties
ReadOnlyHyperlinkCollection
ReadOnlyParagraphCollection
ReadOnlyParagraphProperties
ReadOnlyParagraphPropertiesBase
ReadOnlyParagraphStyle
ReadOnlySectionLineNumbering
ReadOnlySectionMargins
ReadOnlySectionPage
ReadOnlySectionPageNumbering
ReadOnlySectionsProperties
ReadOnlyShapeCollection
ReadOnlyTableCellBorderProperties
ReadOnlyTableCollection
ReadOnlyTextProperties
ReadOnlyTextPropertiesBase
RectangleOffset
Revision
RevisionCollection
RevisionType
SearchDirection
SearchOptions
Section
SectionCollection
SectionColumn
SectionColumnCollection
SectionColumns
SectionLineNumbering
SectionMargins
SectionPage
SectionPageNumbering
SectionStartType
SelectionCollection
Shape
ShapeCollection
ShapeConnectionPoint
ShapeFill
ShapeFormat
ShapeGeometryPreset
ShapeHorizontalAlignment
ShapeLine
ShapeRelativeHorizontalPosition
ShapeRelativeHorizontalSize
ShapeRelativeVerticalPosition
ShapeRelativeVerticalSize
ShapeType
ShapeVerticalAlignment
SolidFill
StrikeoutType
SubDocument
SubDocumentType
SyntaxHighlightProperties
SyntaxHighlightToken
TabAlignmentType
TabInfo
TabInfoCollection
Table
TabLeaderType
TableBorder
TableBorderLineStyle
TableBorders
TableCell
TableCellBorder
TableCellBorders
TableCellCollection
TableCellProcessorDelegate
TableCellPropertiesBase
TableCellPropertiesMask
TableCellVerticalAlignment
TableCollection
TableConditionalStyle
TableConditionalStyleProperties
TableHorizontalAlignment
TableLayoutType
TableLookTypes
TablePropertiesBase
TablePropertiesMask
TableRelativeHorizontalPosition
TableRelativeVerticalPosition
TableRow
TableRowAlignment
TableRowCollection
TableRowProcessorDelegate
TableStyle
TableStyleCollection
TableTextWrappingType
TableVerticalAlignment
TemplateAbstractNumberingList
TextBox
TextBoxSizeRule
TextDirection
TextWatermarkOptions
TextWrappingSide
TextWrappingType
ThemeFont
TileAlignType
TileFlipType
UnderlineType
VerticalMergingState
VerticalTextAlignmentType
WatermarkFormat
WatermarkLayout
WatermarkManager
WatermarkType
WidthType
DevExpress.XtraRichEdit.API.Native.Implementation
DevExpress.XtraRichEdit.Commands
DevExpress.XtraRichEdit.Export
DevExpress.XtraRichEdit.Export.Html
DevExpress.XtraRichEdit.Export.Image
DevExpress.XtraRichEdit.Export.PlainText
DevExpress.XtraRichEdit.Export.Rtf
DevExpress.XtraRichEdit.Forms
DevExpress.XtraRichEdit.Import
DevExpress.XtraRichEdit.Localization
DevExpress.XtraRichEdit.Services
DevExpress.XtraRichEdit.Utils
DevExpress.XtraSpreadsheet
DevExpress.XtraSpreadsheet.Export
DevExpress.XtraSpreadsheet.Export.Html
DevExpress.XtraSpreadsheet.Import
DevExpress.XtraSpreadsheet.Localization
DevExpress.XtraSpreadsheet.Services
Download CHM

Document Members

An interface that exposes the specific functionality of the document.

Properties

Name Description
AbstractNumberingLists Provides access to a collection of abstract numbering lists in the document.
Bookmarks Provides access to the collection of document bookmarks. Inherited from SubDocument.
CaretPosition Gets or sets the position of the caret within the document.
CharacterStyles Provides access to a collection of character styles in the current document.
Comments Provides access to a collection of comments in the current SubDocument. Inherited from SubDocument.
CompatibilitySettings Provides access to the document compatibility settings.
ContentControls Obtains content controls obtained in a document. Inherited from SubDocument.
CustomMarks Provides access to a collection of custom marks. Inherited from SubDocument.
CustomProperties Provides access to a collection of the document’s custom properties.
CustomXmlParts Provides access to a document’s collection of custom XML parts.
DefaultCharacterProperties Provides access to default character formatting for the current document.
DefaultParagraphProperties Provides access to default paragraph formatting for the current document.
DefaultTableProperties Provides access to the default properties for document tables.
DefaultTabWidth Gets or sets the default value of a tab stop width.
DifferentOddAndEvenPages Gets or sets whether the document has different odd and even pages.
DocBytes Gets or sets the document content as an array of bytes in Microsoft Word 97-2003 format (Doc) format.
DocmBytes Gets or sets the document content as an array of bytes in DOCM (Microsoft Office Open XML macro-enabled document) format.
DocumentProperties Provides access to the collection of document’s core properties.
DotBytes Gets or sets the document content as an array of bytes in DOT (Microsoft Word 97-2007 Template) format.
DotmBytes Gets or sets the document content as an array of bytes in DOTM (Microsoft Office Open XML Macro-Enabled Template) format.
DotxBytes Gets or sets the document content as an array of bytes in DOTX (Microsoft Office Open XML macro-free template) format.’
EmbedFonts Gets or sets whether to embed fonts used in the document.
Encryption Provides access for the document’s encryption options.
EndnotePosition Gets or set the position of endnotes in the document.
Endnotes Provides access to document endnotes.
Fields Provides access to the collection of fields in the current document. Inherited from SubDocument.
FlatOpcBytes Gets or sets the document content as an array of bytes in FlatOpc (Microsoft Word XML Document, .xml) format.
FlatOpcMacroEnabledBytes Gets or sets the document content as an array of bytes in FlatOpcMacroEnabled (Microsoft Word XML Macro-Enabled Document, .xml) format.
FlatOpcMacroEnabledTemplateBytes Gets or sets the document content as an array of bytes in FlatOpcMacroEnabledTemplate (Microsoft Word XML Macro-Enabled Template, .xml) format.
FlatOpcTemplateBytes Gets or sets the document content as an array of bytes in FlatOpcTemplate (Microsoft Word XML Template, .xml) format.
Footnotes Provides access to the document’s footnotes.
FormFields Provides access to the collection of the document’s FormField objects. Inherited from SubDocument.
GutterAtTop Gets or sets whether to position the gutter margin at the top of the page.
HtmlText Gets or sets the document content as HTML text.
Hyperlinks Provides access to a collection of hyperlinks in the document. Inherited from SubDocument.
HyphenateCaps Gets or sets whether to hyphenate words in CAPS.
Hyphenation Gets or sets whether to enable hyphenation in a document.
Images Provides access to the collection of all images (inline and floating pictures) in the document . Inherited from SubDocument.
IsDocumentProtected Gets whether document protection is enabled.
IsEmpty Indicates whether the document is empty, i.e. contains only default content.
Length Gets the character length of the document. Inherited from SubDocument.
MarginType Specifies the type of margins used in the document.
MhtText Gets or sets the document content as MHT text.
NumberingLists Provides access to a collection of definitions for numbering lists instantiated in the document.
OpenDocumentBytes Gets or sets the document content as an array of bytes in Open Office Text (.odt) format.
OpenXmlBytes Gets or sets the document content as an array of bytes in Office Open XML (Docx) format.
PageBackColor Gets the background color of the page. Inherited from SubDocument.
Paragraphs Provides access to a collection of paragraphs. Inherited from SubDocument.
ParagraphStyles Provides access to a collection of paragraph styles in the current document.
ProtectionType Gets the protection type for the document.
Range Gets the range for the current document. Inherited from SubDocument.
RequiredExportCapabilities Obtains information on the formatting capabilities required to export the current document correctly.
Revisions Provides access to the collection of revisions made in the current document.
RtfText Gets or sets the formatted text content of the document.
Sections Provides access to a collection of sections.
Selection Gets or sets the selected range in the document.
Selections Retrieves a collection of selections in the document.
Shapes Returns the collection of drawing objects in the document. Inherited from SubDocument.
ShowPageBackground Gets whether the page background color is shown. Inherited from SubDocument.
Tables Provides access to a collection of tables contained in the current document. Inherited from SubDocument.
TableStyles Provides access to a collection of styles defined for tables in the document.
Text Gets or sets the document’s text (plain text).
Theme Gets or sets the theme used in the document.
TrackChanges Provides access to the document’s track changes options.
Unit Gets or sets a document’s measure units.
UpdateDocVariablesBeforePrint Gets or sets whether DOCVARIABLE fields are automatically updated before a document is printed or exported to PDF.
Variables Provides access to the collection of string values associated with document variables.
WatermarkManager Gets a manager that allows you to organize watermarks.
WordMLText Gets or sets the document content as the text in WordProcessingML (Microsoft Office Word 2003 XML) format.

Methods

Name Description
AppendDocumentContent(DocumentRange, InsertOptions) Appends content from the specified range. Inherited from SubDocument.
AppendDocumentContent(DocumentRange) Appends content from the specified range. Inherited from SubDocument.
AppendDocumentContent(Stream, DocumentFormat, String, InsertOptions) Appends content from the stream. Inherited from SubDocument.
AppendDocumentContent(Stream, DocumentFormat, String) Appends content from the stream. Inherited from SubDocument.
AppendDocumentContent(Stream, DocumentFormat) Appends content from the stream. Inherited from SubDocument.
AppendDocumentContent(Stream) Appends content from stream. Inherited from SubDocument.
AppendDocumentContent(String, DocumentFormat, String, InsertOptions) Appends content from the file. Inherited from SubDocument.
AppendDocumentContent(String, DocumentFormat, String) Appends content from the file. Inherited from SubDocument.
AppendDocumentContent(String, DocumentFormat) Appends content from the file. Inherited from SubDocument.
AppendDocumentContent(String) Appends content from the file. Inherited from SubDocument.
AppendHtmlText(String, InsertOptions) Appends HTML formatted text. Inherited from SubDocument.
AppendHtmlText(String) Appends HTML formatted text. Inherited from SubDocument.
AppendRtfText(String, InsertOptions) Appends formatted text. Inherited from SubDocument.
AppendRtfText(String) Appends formatted text. Inherited from SubDocument.
AppendSection() Appends a new empty section and returns the section to which this section is appended.
AppendSingleLineText(String) Appends text as a single line. Inherited from SubDocument.
AppendText(String) Appends the specified text. Inherited from SubDocument.
ApplySyntaxHighlight(List<SyntaxHighlightToken>) Performs a batch update of text formatting for document ranges corresponding to specified tokens. Inherited from SubDocument.
BeginUpdate() Locks the SubDocument object. Prevents visual updates until the EndUpdate method calls. Inherited from SubDocument.
BeginUpdateCharacters(DocumentPosition, Int32) Starts modifying properties of the specified number of characters starting at the specified document position. Inherited from SubDocument.
BeginUpdateCharacters(DocumentRange) Starts modifying properties of characters that fall within a specified document range. Inherited from SubDocument.
BeginUpdateCharacters(Int32, Int32) Starts modifying properties of the specified number of characters starting at the specified document position. Inherited from SubDocument.
BeginUpdateParagraphs(DocumentRange) Starts modifying properties of the paragraphs that fall within a specified document range. Inherited from SubDocument.
BeginUpdateRangePermissions() Gets the collection of all range permissions in the current document. Inherited from SubDocument.
CancelUpdateRangePermissions(RangePermissionCollection) Finalizes the update process, leaving range permissions intact. Inherited from SubDocument.
ChangeActiveDocument(SubDocument) Enables you to operate on selections in documents other than the main document, such as headers and footers.
Copy() Copies the currently selected text to the Clipboard.
Copy(DocumentRange) Copies the specified range of text to the Clipboard.
CreateMailMergeOptions() Enables customizing the mail merge options.
CreatePosition(Int32) Creates a new position in the current document. Inherited from SubDocument.
CreateRange(DocumentPosition, Int32) Creates a new document range using the specified start position and range length. Inherited from SubDocument.
CreateRange(Int32, Int32) Creates a new document range using the specified start position and range length. Inherited from SubDocument.
Cut() Removes the currently selected text and copies it to the Clipboard.
Cut(DocumentRange) Removes the specified range of text and copies it to the Clipboard.
Delete(DocumentRange) Removes content from the specified range. Inherited from SubDocument.
EndUpdate() Unlocks the SubDocument object after you call BeginUpdate. It also causes an immediate visual update. Inherited from SubDocument.
EndUpdateCharacters(CharacterProperties) Finalizes the modification of character formatting after calling the SubDocument.BeginUpdateCharacters method. Inherited from SubDocument.
EndUpdateParagraphs(ParagraphProperties) Finalizes the modification of paragraph formatting after the BeginUpdateParagraphs method call. Inherited from SubDocument.
EndUpdateRangePermissions(RangePermissionCollection) Finalizes the update and applies the changes to range permissions. Inherited from SubDocument.
FindAll(String, SearchOptions, DocumentRange) Finds all text ranges that match the specified string in the specified document range. Inherited from SubDocument.
FindAll(String, SearchOptions) Finds all text ranges that match the specified string in the specific part of the document (main body, text box, header, footer, comment, footnote, and endnote). Inherited from SubDocument.
FindAll(Regex, DocumentRange) Finds all occurrences of a character pattern specified by the regular expression. Inherited from SubDocument.
FindAll(Regex) Finds all occurrences of a character pattern specified by the regular expression. Inherited from SubDocument.
GetAuthors() Returns the list of the document’s authors.
GetDocBytes(DocumentRange, DocDocumentExporterOptions) Exports the range content in DOC (Microsoft Word 97-2003 Document) format and returns a byte array with this content. Inherited from SubDocument.
GetDocBytes(DocumentRange) Exports the range content in DOC (Microsoft Word 97-2003 Document) format and returns a byte array with this content. Inherited from SubDocument.
GetDocmBytes(DocumentRange, DocmDocumentExporterOptions) Exports the range content in DOCM (Microsoft Office Open XML Macro-Enabled Document) format and returns a byte array with this content. Inherited from SubDocument.
GetDocmBytes(DocumentRange) Exports the range content in DOCM (Microsoft Office Open XML Macro-Enabled Document) format and returns a byte array with this content. Inherited from SubDocument.
GetDotBytes(DocumentRange, DotDocumentExporterOptions) Exports the range content in DOT (Microsoft Word 97-2007 Template) format and returns a byte array with this content. Inherited from SubDocument.
GetDotBytes(DocumentRange) Exports the range content in DOT (Microsoft Word 97-2007 Template) format and returns a byte array with this content. Inherited from SubDocument.
GetDotmBytes(DocumentRange, DotmDocumentExporterOptions) Exports the range content in DOTM (Microsoft Office Open XML Macro-Enabled Template) format and returns a byte array with this content. Inherited from SubDocument.
GetDotmBytes(DocumentRange) Exports the range content in DOTM (Microsoft Office Open XML Macro-Enabled Template) format and returns a byte array with this content. Inherited from SubDocument.
GetDotxBytes(DocumentRange, DotxDocumentExporterOptions) Exports the range content in DOTX (Microsoft Office Open XML macro-free template) format and returns a byte array with this content. Inherited from SubDocument.
GetDotxBytes(DocumentRange) Exports the range content in DOTX (Microsoft Office Open XML macro-free template) format and returns a byte array with this content. Inherited from SubDocument.
GetFlatOpcBytes(DocumentRange, FlatOpcDocumentExporterOptions) Exports the range content in FlatOpc (Microsoft Word XML Document, .xml) format and returns a byte array with this content. Inherited from SubDocument.
GetFlatOpcBytes(DocumentRange) Exports the range content in FlatOpc (Microsoft Word XML Document, .xml) format and returns a byte array with this content. Inherited from SubDocument.
GetFlatOpcMacroEnabledBytes(DocumentRange, FlatOpcMacroEnabledDocumentExporterOptions) Exports the range content in FlatOpcMacroEnabled (Microsoft Word XML Macro-Enabled Document, .xml) format and returns a byte array with this content. Inherited from SubDocument.
GetFlatOpcMacroEnabledBytes(DocumentRange) Exports the range content in FlatOpcMacroEnabled (Microsoft Word XML Macro-Enabled Document, .xml) format and returns a byte array with this content. Inherited from SubDocument.
GetFlatOpcMacroEnabledTemplateBytes(DocumentRange, FlatOpcMacroEnabledTemplateDocumentExporterOptions) Exports the range content in FlatOpcMacroEnabledTemplate (Microsoft Word XML Macro-Enabled Template, .xml) format and returns a byte array with this content. Inherited from SubDocument.
GetFlatOpcMacroEnabledTemplateBytes(DocumentRange) Exports the range content in FlatOpcMacroEnabledTemplate (Microsoft Word XML Macro-Enabled Template, .xml) format and returns a byte array with this content. Inherited from SubDocument.
GetFlatOpcTemplateBytes(DocumentRange, FlatOpcTemplateDocumentExporterOptions) Exports the range content in FlatOpcTemplate (Microsoft Word XML Template, .xml) format and returns a byte array with this content. Inherited from SubDocument.
GetFlatOpcTemplateBytes(DocumentRange) Exports the range content in FlatOpcTemplate (Microsoft Word XML Template, .xml) format and returns a byte array with this content. Inherited from SubDocument.
GetHtmlText(DocumentRange, IUriProvider, HtmlDocumentExporterOptions) Gets the text contained in the specified range in HTML format. Inherited from SubDocument.
GetHtmlText(DocumentRange, IUriProvider) Gets the text contained in the specified range in HTML format. Inherited from SubDocument.
GetMhtText(DocumentRange, MhtDocumentExporterOptions) Gets the content of the specified document range in MHT format. Inherited from SubDocument.
GetMhtText(DocumentRange) Gets the content of the specified document range in MHT format. Inherited from SubDocument.
GetOpenDocumentBytes(DocumentRange, OpenDocumentExporterOptions) Exports the content of the specified document range as a document in Open Document (ODT) format and returns a byte array with this document. Inherited from SubDocument.
GetOpenDocumentBytes(DocumentRange) Exports the content of the specified document range as a document in Open Document (ODT) format and returns a byte array with this document. Inherited from SubDocument.
GetOpenXmlBytes(DocumentRange, OpenXmlDocumentExporterOptions) Exports the content of the specified document range as a document in Office Open XML (Docx) format and returns a byte array with this document. Inherited from SubDocument.
GetOpenXmlBytes(DocumentRange) Exports the content of the specified document range as a document in Office Open XML (Docx) format and returns a byte array with this document. Inherited from SubDocument.
GetRtfText(DocumentRange, RtfDocumentExporterOptions) Gets the formatted string of the text contained in the specified range. Inherited from SubDocument.
GetRtfText(DocumentRange) Gets the formatted string of the text contained in the specified range. Inherited from SubDocument.
GetSection(DocumentPosition) Gets the section encompassing the specified position.
GetSubDocumentType() Returns the subdocument type. Inherited from SubDocument.
GetText(DocumentRange, TextFragmentOptions) Returns the plain text of the specified document range. Inherited from SubDocument.
GetText(DocumentRange, PlainTextDocumentExporterOptions, TextFragmentOptions) Returns the plain text of the specified document range. Inherited from SubDocument.
GetText(DocumentRange, PlainTextDocumentExporterOptions) Returns the plain text of the specified document range. Inherited from SubDocument.
GetText(DocumentRange) Returns the plain text of the specified document range. Inherited from SubDocument.
GetWordMLText(DocumentRange, WordMLDocumentExporterOptions) Gets the text contained in the specified range in WordML format. Inherited from SubDocument.
GetWordMLText(DocumentRange) Gets the text contained in the specified range in WordML format. Inherited from SubDocument.
InsertDocumentContent(DocumentPosition, DocumentRange, InsertOptions) Inserts content from the specified range in the current document at the specified position. Inherited from SubDocument.
InsertDocumentContent(DocumentPosition, DocumentRange) Inserts content from the specified range in the current document at the specified position. Inherited from SubDocument.
InsertDocumentContent(DocumentPosition, Stream, DocumentFormat, InsertOptions) Inserts content from the specified stream in the specified format, at the specified position, in the current document. Inherited from SubDocument.
InsertDocumentContent(DocumentPosition, Stream, DocumentFormat, String, InsertOptions) Inserts content from the specified stream in the specified format, at the specified position, in the current document. Inherited from SubDocument.
InsertDocumentContent(DocumentPosition, Stream, DocumentFormat, String) Insert content from the stream in the current document at the specified position. Inherited from SubDocument.
InsertDocumentContent(DocumentPosition, Stream, DocumentFormat) Inserts content from the stream in the current document at the specified position. Inherited from SubDocument.
InsertDocumentContent(DocumentPosition, Stream) Inserts content from the stream in the current document at the specified position. Inherited from SubDocument.
InsertDocumentContent(DocumentPosition, String, DocumentFormat, InsertOptions) Inserts content from the file in the current document at the specified position. Inherited from SubDocument.
InsertDocumentContent(DocumentPosition, String, DocumentFormat, String, InsertOptions) Inserts content from the file in the current document at the specified position. Inherited from SubDocument.
InsertDocumentContent(DocumentPosition, String, DocumentFormat, String) Inserts content from the file in the current document at the specified position. Inherited from SubDocument.
InsertDocumentContent(DocumentPosition, String, DocumentFormat) Inserts content from the file in the current document at the specified position. Inherited from SubDocument.
InsertDocumentContent(DocumentPosition, String) Inserts content from the file in the current document at the specified position. Inherited from SubDocument.
InsertHtmlText(DocumentPosition, String, InsertOptions) Inserts the specified HTML text into the specified position. Inherited from SubDocument.
InsertHtmlText(DocumentPosition, String) Inserts the specified HTML text into the specified position. Inherited from SubDocument.
InsertRtfText(DocumentPosition, String, InsertOptions) Inserts the specified formatted text into the specified position. Inherited from SubDocument.
InsertRtfText(DocumentPosition, String) Inserts the specified formatted text into the specified position. Inherited from SubDocument.
InsertSection(DocumentPosition) Inserts a new section into the document’s Document.Sections collection at a specified position.
InsertSingleLineText(DocumentPosition, String) Inserts a single line of text (text without line breaks) at the specified position. Inherited from SubDocument.
InsertText(DocumentPosition, String) Inserts the specified text at the specified position. Inherited from SubDocument.
LoadDocument(Byte[], DocumentFormat, String) Loads a document in the specified format from a byte array. You can use this method to load HTML documents with connected files.
LoadDocument(Byte[], DocumentFormat) Loads a document in the specified format from a byte array.
LoadDocument(Byte[]) Loads a document from a byte array. The file format is determined based on document content.
LoadDocument(Stream, DocumentFormat, String) Loads a document from the stream in the specified format. External content for HTML format is retrieved using the specified source (base) URI.
LoadDocument(Stream, DocumentFormat) Loads a document from a stream, specifying the document format.
LoadDocument(Stream) Loads a document from the stream.
LoadDocument(String, DocumentFormat, String) Loads a document from the file in the specified format. External content for HTML format is retrieved using the specified source (base) URI.
LoadDocument(String, DocumentFormat) Loads a document from a file, specifying the document format.
LoadDocument(String) Loads a document from the specified file. The file format is determined by its content.
MailMerge(Document) Merges data to the current document and sends the result to the specified Document instance.
MailMerge(MailMergeOptions, Document) Merges data to the current document and sends the result to the specified Document instance. Allows you to set the mail merge options.
MailMerge(MailMergeOptions, Stream, DocumentFormat) Merges data to the current document and sends the result in the specified format to a stream. Allows you to set mail merge options.
MailMerge(MailMergeOptions, String, DocumentFormat) Merges data to the current document and saves the result to a file in the specified format. Allows you to set mail merge options.
MailMerge(Stream, DocumentFormat) Merges data to the current document, and sends the result in the specified format to a stream.
MailMerge(String, DocumentFormat) Merges data to the current document and sends the result to a file in the specified format.
MakeAllTablesWordCompatible() Merges all columns with indexes greater than 63 into a single column for all tables in a document.
Paste() Insert a text from the Clipboard into the current CaretPosition.
Paste(DocumentFormat) Inserts the contents of the Clipboard in the specified format at the caret position.
Protect(String, DocumentProtectionType) Enforces document protection and sets the specified password.
Protect(String) Protects a document with a given password.
Replace(DocumentRange, String) Replaces the specified document range with the specified text string. Inherited from SubDocument.
ReplaceAll(String, String, SearchOptions, DocumentRange) Finds all occurrences of the search string in the specified range, and replaces them with the replacement string. Inherited from SubDocument.
ReplaceAll(String, String, SearchOptions) Finds all occurrences of the search string in the current document, and replaces them with the replacement string. Inherited from SubDocument.
ReplaceAll(Regex, String, DocumentRange) Replaces all occurrences of a character pattern defined by a regular expression with a specified replacement string. Inherited from SubDocument.
ReplaceAll(Regex, String) Replaces all occurrences of a character pattern defined by a regular expression with a specified replacement string. Inherited from SubDocument.
SaveDocument(DocumentFormat, EncryptionSettings) Saves the document to a byte array in the specified file format and encrypts it with a password.
SaveDocument(DocumentFormat) Saves the document to a byte array in the specified file format.
SaveDocument(Stream, DocumentFormat, EncryptionSettings) Saves the document to a stream, specifying the document’s format and encryption options.
SaveDocument(Stream, DocumentFormat) Saves the document to a stream, specifying the document’s format.
SaveDocument(String, DocumentFormat, EncryptionSettings) Saves the document to a stream, specifying the document’s format and encryption options.
SaveDocument(String, DocumentFormat) Saves the document to a file, specifying the document’s format.
SelectAll() Selects all the content in the document. Inherited from SubDocument.
SetPageBackground(Boolean) Shows the background color of the page. Inherited from SubDocument.
SetPageBackground(Color, Boolean) Sets the background color of the page and specifies whether it is shown. Inherited from SubDocument.
SetPageBackground(Color) Set the background color of the page. Inherited from SubDocument.
StartSearch(String, SearchOptions, SearchDirection, DocumentRange) Provides a search interface for a search in the specified range in the specified direction, using the specified options. Inherited from SubDocument.
StartSearch(String, SearchOptions, SearchDirection) Provides a search interface for a search in the current document in the specified direction, using the specified options. Inherited from SubDocument.
StartSearch(String) Provides a search interface with default parameters. Inherited from SubDocument.
StartSearch(Regex, DocumentRange) Provides a search interface for a search in the specified range using a regular expression pattern. Inherited from SubDocument.
StartSearch(Regex) Provides a search interface for a search in the document, using a regular expression pattern. Inherited from SubDocument.
UnlinkAllFields() Replaces all document fields with field values.
Unprotect() Removes document protection.
UpdateAllFields() Updates all fields in the document.

Events

Name Description
CalculateDocumentVariable Fires when the DOCVARIABLE field is updated.
ContentChanged Occurs when the document content was changed.
ModifiedChanged Occurs when the document content has been modified since it was last saved.
TrackedMovesConflict Occurs when moved text has been changed since it was moved.
See Also