Document Members
In This Article
#Properties
Name | Description |
---|---|
Abstract |
Provides access to a collection of abstract numbering lists in the document. |
Align |
Specifies whether to align paragraph borders and table edges with page borders. |
Bookmarks |
Provides access to the collection of document bookmarks.
Inherited from Sub |
Border |
Specifies whether the page border includes or excludes the footer. |
Border |
Specifies whether the page border includes or excludes the header. |
Caret |
Gets or sets the position of the caret within the document. |
Character |
Provides access to a collection of character styles in the current document. |
Comments |
Provides access to a collection of comments in the current Sub |
Compatibility |
Provides access to the document compatibility settings. |
Content |
Obtains content controls obtained in a document.
Inherited from Sub |
Custom |
Provides access to a collection of custom marks.
Inherited from Sub |
Custom |
Provides access to a collection of the document’s custom properties. |
Custom |
Provides access to a document’s collection of custom XML parts. |
Default |
Provides access to default character formatting for the current document. |
Default |
Provides access to default paragraph formatting for the current document. |
Default |
Provides access to the default properties for document tables. |
Default |
Gets or sets the default value of a tab stop width. |
Different |
Gets or sets whether the document has different odd and even pages. |
Doc |
Gets or sets the document content as an array of bytes in Microsoft Word 97-2003 format (Doc) format. |
Docm |
Gets or sets the document content as an array of bytes in DOCM (Microsoft Office Open XML macro-enabled document) format. |
Document |
Provides access to the collection of document’s core properties. |
Dot |
Gets or sets the document content as an array of bytes in DOT (Microsoft Word 97-2007 Template) format. |
Dotm |
Gets or sets the document content as an array of bytes in DOTM (Microsoft Office Open XML Macro-Enabled Template) format. |
Dotx |
Gets or sets the document content as an array of bytes in DOTX (Microsoft Office Open XML macro-free template) format.’ |
Embed |
Gets or sets whether to embed fonts used in the document. |
Encryption | Provides access for the document’s encryption options. |
Endnote |
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 Sub |
Flat |
Gets or sets the document content as an array of bytes in Flat |
Flat |
Gets or sets the document content as an array of bytes in Flat |
Flat |
Gets or sets the document content as an array of bytes in Flat |
Flat |
Gets or sets the document content as an array of bytes in Flat |
Footnotes | Provides access to the document’s footnotes. |
Form |
Provides access to the collection of the document’s Form |
Gutter |
Gets or sets whether to position the gutter margin at the top of the page. |
Html |
Gets or sets the document content as HTML text. |
Hyperlinks |
Provides access to a collection of hyperlinks in the document.
Inherited from Sub |
Hyphenate |
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 Sub |
Is |
Gets whether document protection is enabled. |
Is |
Indicates whether the document is empty, i. |
Length |
Gets the character length of the document.
Inherited from Sub |
Margin |
Specifies the type of margins used in the document. |
Mht |
Gets or sets the document content as MHT text. |
Numbering |
Provides access to a collection of definitions for numbering lists instantiated in the document. |
Open |
Gets or sets the document content as an array of bytes in Open Office Text (. |
Open |
Gets or sets the document content as an array of bytes in Office Open XML (Docx) format. |
Page |
Gets the background color of the page.
Inherited from Sub |
Paragraphs |
Provides access to a collection of paragraphs.
Inherited from Sub |
Paragraph |
Provides access to a collection of paragraph styles in the current document. |
Protection |
Gets the protection type for the document. |
Range |
Gets the range for the current document.
Inherited from Sub |
Required |
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. |
Rtf |
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 Sub |
Show |
Gets whether the page background color is shown.
Inherited from Sub |
Tables |
Provides access to a collection of tables contained in the current document.
Inherited from Sub |
Table |
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. |
Track |
Provides access to the document’s track changes options. |
Unit | Gets or sets a document’s measure units. |
Update |
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. |
Vba |
Obtains the VBA project stored in macro-enabled document. |
Watermark |
Gets a manager that allows you to organize watermarks. |
Word |
Gets or sets the document content as the text in Word |
#Methods
Name | Description |
---|---|
Append |
Appends content from the specified range.
Inherited from Sub |
Append |
Appends content from the specified range.
Inherited from Sub |
Append |
Appends content from the stream.
Inherited from Sub |
Append |
Appends content from the stream.
Inherited from Sub |
Append |
Appends content from the stream.
Inherited from Sub |
Append |
Appends content from stream.
Inherited from Sub |
Append |
Appends content from the file.
Inherited from Sub |
Append |
Appends content from the file.
Inherited from Sub |
Append |
Appends content from the file.
Inherited from Sub |
Append |
Appends content from the file.
Inherited from Sub |
Append |
Appends HTML formatted text.
Inherited from Sub |
Append |
Appends HTML formatted text.
Inherited from Sub |
Append |
Appends formatted text.
Inherited from Sub |
Append |
Appends formatted text.
Inherited from Sub |
Append |
Appends a new empty section and returns the section to which this section is appended. |
Append |
Appends text as a single line.
Inherited from Sub |
Append |
Appends the specified text.
Inherited from Sub |
Apply |
Performs a batch update of text formatting for document ranges corresponding to specified tokens.
Inherited from Sub |
Begin |
Locks the Sub object. Prevents visual updates until the End method calls.
Inherited from Sub |
Begin |
Starts modifying properties of the specified number of characters starting at the specified document position.
Inherited from Sub |
Begin |
Starts modifying properties of characters that fall within a specified document range.
Inherited from Sub |
Begin |
Starts modifying properties of the specified number of characters starting at the specified document position.
Inherited from Sub |
Begin |
Starts modifying properties of the paragraphs that fall within a specified document range.
Inherited from Sub |
Begin |
Gets the collection of all range permissions in the current document.
Inherited from Sub |
Cancel |
Finalizes the update process, leaving range permissions intact.
Inherited from Sub |
Change |
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 |
Copies the specified range of text to the Clipboard. |
Create |
Enables customizing the mail merge options. |
Create |
Creates a new position in the current document.
Inherited from Sub |
Create |
Creates a new document range using the specified start position and range length.
Inherited from Sub |
Create |
Creates a new document range using the specified start position and range length.
Inherited from Sub |
Cut() | Removes the currently selected text and copies it to the Clipboard. |
Cut |
Removes the specified range of text and copies it to the Clipboard. |
Delete |
Removes content from the specified range.
Inherited from Sub |
End |
Unlocks the Sub object after you call Begin . It also causes an immediate visual update.
Inherited from Sub |
End |
Finalizes the modification of character formatting after calling the Sub |
End |
Finalizes the modification of paragraph formatting after the Begin |
End |
Finalizes the update and applies the changes to range permissions.
Inherited from Sub |
Find |
Finds all text ranges that match the specified string in the specified document range.
Inherited from Sub |
Find |
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 Sub |
Find |
Finds all occurrences of a character pattern specified by the regular expression.
Inherited from Sub |
Find |
Finds all occurrences of a character pattern specified by the regular expression.
Inherited from Sub |
Get |
Returns the list of the document’s authors. |
Get |
Exports the range content in DOC (Microsoft Word 97-2003 Document) format and returns a byte array with this content.
Inherited from Sub |
Get |
Exports the range content in DOC (Microsoft Word 97-2003 Document) format and returns a byte array with this content.
Inherited from Sub |
Get |
Exports the range content in DOCM (Microsoft Office Open XML Macro-Enabled Document) format and returns a byte array with this content.
Inherited from Sub |
Get |
Exports the range content in DOCM (Microsoft Office Open XML Macro-Enabled Document) format and returns a byte array with this content.
Inherited from Sub |
Get |
Exports the range content in DOT (Microsoft Word 97-2007 Template) format and returns a byte array with this content.
Inherited from Sub |
Get |
Exports the range content in DOT (Microsoft Word 97-2007 Template) format and returns a byte array with this content.
Inherited from Sub |
Get |
Exports the range content in DOTM (Microsoft Office Open XML Macro-Enabled Template) format and returns a byte array with this content.
Inherited from Sub |
Get |
Exports the range content in DOTM (Microsoft Office Open XML Macro-Enabled Template) format and returns a byte array with this content.
Inherited from Sub |
Get |
Exports the range content in DOTX (Microsoft Office Open XML macro-free template) format and returns a byte array with this content.
Inherited from Sub |
Get |
Exports the range content in DOTX (Microsoft Office Open XML macro-free template) format and returns a byte array with this content.
Inherited from Sub |
Get |
Exports the range content in Flat |
Get |
Exports the range content in Flat |
Get |
Exports the range content in Flat |
Get |
Exports the range content in Flat |
Get |
Exports the range content in Flat |
Get |
Exports the range content in Flat |
Get |
Exports the range content in Flat |
Get |
Exports the range content in Flat |
Get |
Gets the text contained in the specified range in HTML format.
Inherited from Sub |
Get |
Gets the text contained in the specified range in HTML format.
Inherited from Sub |
Get |
Gets the content of the specified document range in MHT format.
Inherited from Sub |
Get |
Gets the content of the specified document range in MHT format.
Inherited from Sub |
Get |
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 Sub |
Get |
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 Sub |
Get |
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 Sub |
Get |
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 Sub |
Get |
Gets the formatted string of the text contained in the specified range.
Inherited from Sub |
Get |
Gets the formatted string of the text contained in the specified range.
Inherited from Sub |
Get |
Gets the section encompassing the specified position. |
Get |
Returns the subdocument type.
Inherited from Sub |
Get |
Returns the plain text of the specified document range.
Inherited from Sub |
Get |
Returns the plain text of the specified document range.
Inherited from Sub |
Get |
Returns the plain text of the specified document range.
Inherited from Sub |
Get |
Returns the plain text of the specified document range.
Inherited from Sub |
Get |
Gets the text contained in the specified range in Word |
Get |
Gets the text contained in the specified range in Word |
Insert |
Inserts content from the specified range in the current document at the specified position.
Inherited from Sub |
Insert |
Inserts content from the specified range in the current document at the specified position.
Inherited from Sub |
Insert |
Inserts content from the specified stream in the specified format, at the specified position, in the current document.
Inherited from Sub |
Insert |
Inserts content from the specified stream in the specified format, at the specified position, in the current document.
Inherited from Sub |
Insert |
Insert content from the stream in the current document at the specified position.
Inherited from Sub |
Insert |
Inserts content from the stream in the current document at the specified position.
Inherited from Sub |
Insert |
Inserts content from the stream in the current document at the specified position.
Inherited from Sub |
Insert |
Inserts content from the file in the current document at the specified position.
Inherited from Sub |
Insert |
Inserts content from the file in the current document at the specified position.
Inherited from Sub |
Insert |
Inserts content from the file in the current document at the specified position.
Inherited from Sub |
Insert |
Inserts content from the file in the current document at the specified position.
Inherited from Sub |
Insert |
Inserts content from the file in the current document at the specified position.
Inherited from Sub |
Insert |
Inserts the specified HTML text into the specified position.
Inherited from Sub |
Insert |
Inserts the specified HTML text into the specified position.
Inherited from Sub |
Insert |
Inserts the specified formatted text into the specified position.
Inherited from Sub |
Insert |
Inserts the specified formatted text into the specified position.
Inherited from Sub |
Insert |
Inserts a new section into the document’s Document. |
Insert |
Inserts a single line of text (text without line breaks) at the specified position.
Inherited from Sub |
Insert |
Inserts the specified text at the specified position.
Inherited from Sub |
Load |
Loads a document in the specified format from a byte array. You can use this method to load HTML documents with connected files. |
Load |
Loads a document in the specified format from a byte array. |
Load |
Loads a document from a byte array. The file format is determined based on document content. |
Load |
Loads a document from the stream in the specified format. External content for HTML format is retrieved using the specified source (base) URI. |
Load |
Loads a document from a stream, specifying the document format. |
Load |
Loads a document from the stream. |
Load |
Loads a document from the file in the specified format. External content for HTML format is retrieved using the specified source (base) URI. |
Load |
Loads a document from a file, specifying the document format. |
Load |
Loads a document from the specified file. The file format is determined by its content. |
Mail |
Merges data to the current document and sends the result to the specified Document instance. |
Mail |
Merges data to the current document and sends the result to the specified Document instance. Allows you to set the mail merge options. |
Mail |
Merges data to the current document and sends the result in the specified format to a stream. Allows you to set mail merge options. |
Mail |
Merges data to the current document and saves the result to a file in the specified format. Allows you to set mail merge options. |
Mail |
Merges data to the current document, and sends the result in the specified format to a stream. |
Mail |
Merges data to the current document and sends the result to a file in the specified format. |
Make |
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 Caret |
Paste |
Inserts the contents of the Clipboard in the specified format at the caret position. |
Protect |
Enforces document protection and sets the specified password. |
Protect |
Protects a document with a given password. |
Replace |
Replaces the specified document range with the specified text string.
Inherited from Sub |
Replace |
Finds all occurrences of the search string in the specified range, and replaces them with the replacement string.
Inherited from Sub |
Replace |
Finds all occurrences of the search string in the current document, and replaces them with the replacement string.
Inherited from Sub |
Replace |
Replaces all occurrences of a character pattern defined by a regular expression with a specified replacement string.
Inherited from Sub |
Replace |
Replaces all occurrences of a character pattern defined by a regular expression with a specified replacement string.
Inherited from Sub |
Save |
Saves the document to a byte array in the specified file format and encrypts it with a password. |
Save |
Saves the document to a byte array in the specified file format. |
Save |
Saves the document to a stream, specifying the document’s format and encryption options. |
Save |
Saves the document to a stream, specifying the document’s format. |
Save |
Saves the document to a stream, specifying the document’s format and encryption options. |
Save |
Saves the document to a file, specifying the document’s format. |
Select |
Selects all the content in the document.
Inherited from Sub |
Set |
Shows the background color of the page.
Inherited from Sub |
Set |
Sets the background color of the page and specifies whether it is shown.
Inherited from Sub |
Set |
Set the background color of the page.
Inherited from Sub |
Start |
Provides a search interface for a search in the specified range in the specified direction, using the specified options.
Inherited from Sub |
Start |
Provides a search interface for a search in the current document in the specified direction, using the specified options.
Inherited from Sub |
Start |
Provides a search interface with default parameters.
Inherited from Sub |
Start |
Provides a search interface for a search in the specified range using a regular expression pattern.
Inherited from Sub |
Start |
Provides a search interface for a search in the document, using a regular expression pattern.
Inherited from Sub |
Unlink |
Replaces all document fields with field values. |
Unprotect() | Removes document protection. |
Update |
Updates all fields in the document. |
#Events
Name | Description |
---|---|
Calculate |
Fires when the DOCVARIABLE field is updated. |
Content |
Occurs when the document content was changed. |
Modified |
Occurs when the document content has been modified since it was last saved. |
Tracked |
Occurs when moved text has been changed since it was moved. |
See Also