.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

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.
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.
DocumentProperties Provides access to the collection of document's core properties.
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.
Footnotes Provides access to the document's footnotes.
FormFields Provides access to the collection of the document's FormField objects. Inherited from SubDocument.
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.
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 Provides access to a collection of selections in the document.
Shapes Provides access to the collection of shapes 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.
Variables Provides access to the collection of string values associated with document variables.
WordMLText Gets or sets the document content as the text in WordProcessingML (Microsoft Office Word 2003 XML) format.

Methods

Name Description
AppendDocumentContent(DocumentRange) Appends content from the specified range. Inherited from SubDocument.
AppendDocumentContent(DocumentRange, InsertOptions) Appends content from the specified range. Inherited from SubDocument.
AppendDocumentContent(Stream) Appends content from stream. Inherited from SubDocument.
AppendDocumentContent(Stream, DocumentFormat) Appends content from the stream. Inherited from SubDocument.
AppendDocumentContent(Stream, DocumentFormat, String) Appends content from the stream. Inherited from SubDocument.
AppendDocumentContent(Stream, DocumentFormat, String, InsertOptions) Appends content from the stream. Inherited from SubDocument.
AppendDocumentContent(String) Appends content from the string value. Inherited from SubDocument.
AppendDocumentContent(String, DocumentFormat) Appends content from the stream. Inherited from SubDocument.
AppendDocumentContent(String, DocumentFormat, String) Appends content from the file. Inherited from SubDocument.
AppendDocumentContent(String, DocumentFormat, String, InsertOptions) Appends content from the file. Inherited from SubDocument.
AppendHtmlText(String) Appends HTML formatted text. Inherited from SubDocument.
AppendHtmlText(String, InsertOptions) Appends HTML formatted text. Inherited from SubDocument.
AppendRtfText(String) Appends formatted text. Inherited from SubDocument.
AppendRtfText(String, InsertOptions) 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 by preventing visual updates until the EndUpdate method is called. 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 the specified range of text from the document. Inherited from SubDocument.
EndUpdate() Unlocks the SubDocument object after a call to the BeginUpdate method and 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 calling the SubDocument.BeginUpdateParagraphs method. Inherited from SubDocument.
EndUpdateRangePermissions(RangePermissionCollection) Finalizes the update and applies the changes to range permissions. Inherited from SubDocument.
FindAll(String, SearchOptions) Finds all text ranges that match the specified string in the current document. 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(Regex) Finds all occurrences of a character pattern specified by the regular expression. Inherited from SubDocument.
FindAll(Regex, DocumentRange) 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) Exports the range's content in DOC (Microsoft Word 97-2003 format) format and returns a byte array with this document. Inherited from SubDocument.
GetDocBytes(DocumentRange, DocDocumentExporterOptions) Exports the range's content in DOC (Microsoft Word 97-2003 format) format and returns a byte array with this document. Inherited from SubDocument.
GetHtmlText(DocumentRange, IUriProvider) Gets the text contained in the specified range in HTML format. Inherited from SubDocument.
GetHtmlText(DocumentRange, IUriProvider, HtmlDocumentExporterOptions) Gets the text contained in the specified range in HTML format. Inherited from SubDocument.
GetMhtText(DocumentRange) Gets the content of the specified document range in MHT format. Inherited from SubDocument.
GetMhtText(DocumentRange, MhtDocumentExporterOptions) Gets the content of the specified document range in MHT format. 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.
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.
GetRtfText(DocumentRange) Gets the formatted string of the text contained in the specified range. Inherited from SubDocument.
GetRtfText(DocumentRange, RtfDocumentExporterOptions) 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) Returns the plain text of the specified document range. Inherited from SubDocument.
GetText(DocumentRange, 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, PlainTextDocumentExporterOptions, TextFragmentOptions) Returns the plain text of the specified document range. Inherited from SubDocument.
GetWordMLText(DocumentRange) Gets the text contained in the specified range in WordML format. Inherited from SubDocument.
GetWordMLText(DocumentRange, WordMLDocumentExporterOptions) Gets the text contained in the specified range in WordML format. 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, DocumentRange, InsertOptions) Inserts content from the specified range 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, Stream, DocumentFormat) Inserts content from the stream 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) Insert content from the stream in the current document at the specified position. 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, 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, DocumentFormat, 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, String, InsertOptions) Inserts content from the file in the current document at the specified position. Inherited from SubDocument.
InsertHtmlText(DocumentPosition, String) Inserts the specified HTML text into the specified position. Inherited from SubDocument.
InsertHtmlText(DocumentPosition, String, InsertOptions) Inserts the specified HTML text into the specified position. Inherited from SubDocument.
InsertRtfText(DocumentPosition, String) Inserts the specified formatted text into the specified position. Inherited from SubDocument.
InsertRtfText(DocumentPosition, String, InsertOptions) 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(Stream) Loads a document from the stream.
LoadDocument(Stream, DocumentFormat) Loads a document from a stream, specifying the document format.
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(String) Loads a document from the specified file. The file format is determined by its content.
LoadDocument(String, DocumentFormat) Loads a document from a file, specifying the document format.
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.
MailMerge(Document) Merges the current document and sends the result to the specified Document.
MailMerge(MailMergeOptions, Document) Merges the current document using the specified options, and sends the result to the specified Document.
MailMerge(MailMergeOptions, Stream, DocumentFormat) Merges the current document using the specified options and sends the result to the specified stream in a specified format.
MailMerge(MailMergeOptions, String, DocumentFormat) Merges the current document using the specified options and sends the result to the specified file in a specified format.
MailMerge(Stream, DocumentFormat) Merges the current document and sends the result to the specified stream in a specified format.
MailMerge(String, DocumentFormat) Merges the current document and sends the result to the specified file in a 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) Protects a document with a given password.
Protect(String, DocumentProtectionType) Enforces document protection and sets the specified password.
Replace(DocumentRange, String) Replaces the specified document range with the specified text 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(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(Regex, String) Replaces all occurrences of a character pattern defined by a regular expression with a specified 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.
SaveDocument(Stream, DocumentFormat) Saves the document to a stream, specifying the document's format.
SaveDocument(Stream, 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.
SaveDocument(String, DocumentFormat, EncryptionSettings) Saves the document to a stream, specifying the document's format and encryption options.
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) Set 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.
StartSearch(String) Provides a search interface with default parameters. 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, 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(Regex) Provides a search interface for a search in the document, using a regular expression pattern. 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.
Unprotect() Removes document protection.

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