The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+

SubDocument Members

Exposes properties and methods representing essential document functionality.

Properties

Name Description
Bookmarks

Provides access to the collection of document bookmarks.

Comments

Provides access to a collection of comments in the current SubDocument.

CustomMarks

Provides access to a collection of custom marks.

Fields

Provides access to the collection of fields in the current document.

FormFields

Provides access to the collection of the document's FormField objects.

Provides access to a collection of hyperlinks in the document.

Images

Provides access to the collection of all images (inline and floating pictures) in the document .

Length

Gets the character length of the document.

PageBackColor

Gets the background color of the page.

Paragraphs

Provides access to a collection of paragraphs.

Range

Gets the range for the current document.

Shapes

Provides access to a collection of Shapes (pictures, text boxes) in the current SubDocument.

ShowPageBackground

Gets whether the page background color is shown.

Tables

Provides access to a collection of tables contained in the current document.

Methods

Name Description
AddParagraphToList(Paragraph, Int32, Int32)

Obsolete. Apply the numbering list format specified by the NumberingList object to the specified paragraph.

AddParagraphToList(Paragraph, NumberingList, Int32)

Obsolete. Apply the numbering list format specified by the NumberingList object to the specified paragraph.

AddParagraphsToList(DocumentRange, NumberingList, Int32)

Obsolete. Apply the numbering list format specified by the NumberingList object to the paragraphs in the specified range.

AppendDocumentContent(DocumentRange)

Appends content from the specified range.

AppendDocumentContent(DocumentRange, InsertOptions)

Appends content from the specified range.

AppendDocumentContent(Stream)

Appends content from stream.

AppendDocumentContent(Stream, DocumentFormat)

Appends content from the stream.

AppendDocumentContent(Stream, DocumentFormat, String)

Appends content from the stream.

AppendDocumentContent(Stream, DocumentFormat, String, InsertOptions)

Appends content from the stream.

AppendDocumentContent(String)

Appends content from the string value.

AppendDocumentContent(String, DocumentFormat)

Appends content from the stream.

AppendDocumentContent(String, DocumentFormat, String)

Appends content from the file.

AppendDocumentContent(String, DocumentFormat, String, InsertOptions)

Appends content from the file.

AppendHtmlText(String)

Appends HTML formatted text.

AppendHtmlText(String, InsertOptions)

Appends HTML formatted text.

AppendImage(DocumentImageSource)

Obsolete. Appends a specified image.

AppendImage(Image)

Obsolete. Appends a specified image.

AppendParagraph()

Obsolete. Appends an empty paragraph.

AppendRtfText(String)

Appends formatted text.

AppendRtfText(String, InsertOptions)

Appends formatted text.

AppendSingleLineText(String)

Appends text as a single line.

AppendText(String)

Appends the specified text.

ApplySyntaxHighlight(List<SyntaxHighlightToken>)

Performs a batch update of text formatting for document ranges corresponding to specified tokens.

BeginUpdate()

Locks the SubDocument object by preventing visual updates until the EndUpdate method is called.

BeginUpdateCharacters(DocumentPosition, Int32)

Starts modifying properties of the specified number of characters starting at the specified document position.

BeginUpdateCharacters(DocumentRange)

Starts modifying properties of characters that fall within a specified document range.

BeginUpdateCharacters(Int32, Int32)

Starts modifying properties of the specified number of characters starting at the specified document position.

BeginUpdateParagraphs(DocumentRange)

Starts modifying properties of the paragraphs that fall within a specified document range.

BeginUpdateRangePermissions()

Gets the collection of all range permissions in the current document.

CancelUpdateRangePermissions(RangePermissionCollection)

Finalizes the update process, leaving range permissions intact.

CreateBookmark(DocumentPosition, Int32, String)

Obsolete. Creates a bookmark with the specified name for the range that starts at the specified position and has a specified length. Then, adds it to the SubDocument.Bookmarks collection.

CreateBookmark(DocumentRange, String)

Obsolete. Creates a bookmark for the specified range with the specified name and adds it to the SubDocument.Bookmarks collection.

CreateCustomMark(DocumentPosition, Object)

Obsolete. Creates a custom mark at the specified position and associates specified data with it.

Obsolete. Creates a hyperlink for the document range, starting at the specified position, and extending through a specified length.

Obsolete. Creates a hyperlink for the specified document range.

CreatePosition(Int32)

Creates a new position in the current document.

CreateRange(DocumentPosition, Int32)

Creates a new document range using the specified start position and range length.

CreateRange(Int32, Int32)

Creates a new document range using the specified start position and range length.

Delete(DocumentRange)

Removes the specified range of text from the document.

DeleteCustomMark(CustomMark)

Obsolete. Delete specified custom mark from the document's collection.

EndUpdate()

Unlocks the SubDocument object after a call to the BeginUpdate method and causes an immediate visual update.

EndUpdateCharacters(CharacterProperties)

Finalizes the modification of character formatting after calling the SubDocument.BeginUpdateCharacters method.

EndUpdateParagraphs(ParagraphProperties)

Finalizes the modification of paragraph formatting after calling the SubDocument.BeginUpdateParagraphs method.

EndUpdateRangePermissions(RangePermissionCollection)

Finalizes the update and applies the changes to range permissions.

FindAll(Regex)

Finds all occurrences of a character pattern specified by the regular expression.

FindAll(Regex, DocumentRange)

Finds all occurrences of a character pattern specified by the regular expression.

FindAll(String, SearchOptions)

Finds all text ranges that match the specified string in the current document.

FindAll(String, SearchOptions, DocumentRange)

Finds all text ranges that match the specified string in the specified document range.

GetCustomMarkByVisualInfo(CustomMarkVisualInfo)

Obsolete. Provides access to a custom mark in the RichEditControl.CustomMarkDraw event handler.

GetDocBytes(DocumentRange)

Exports the range's content in DOC (Microsoft Word 97-2003 format) format and returns a byte array with this document.

GetDocBytes(DocumentRange, DocDocumentExporterOptions)

Exports the range's content in DOC (Microsoft Word 97-2003 format) format and returns a byte array with this document.

GetHtmlText(DocumentRange, IUriProvider)

Gets the text contained in the specified range in HTML format.

GetHtmlText(DocumentRange, IUriProvider, HtmlDocumentExporterOptions)

Gets the text contained in the specified range in HTML format.

GetImages(DocumentRange)

Obsolete. Gets all images (inline pictures and shapes) in the specified document range. Use a method accessible with the RichEditControl.Document.Images.Get(DocumentRange range) notation instead.

GetMhtText(DocumentRange)

Gets the content of the specified document range in MHT format.

GetMhtText(DocumentRange, MhtDocumentExporterOptions)

Gets the content of the specified document range in MHT format.

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.

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.

GetParagraph(DocumentPosition)

Obsolete. Gets the paragraph encompassing the specified position.

GetParagraphs(DocumentRange)

Obsolete. Provides access to paragraphs to which the specified range belongs.

GetRtfText(DocumentRange)

Gets the formatted string of the text contained in the specified range.

GetRtfText(DocumentRange, RtfDocumentExporterOptions)

Gets the formatted string of the text contained in the specified range.

GetShapes(DocumentRange)

Obsolete. Gets a collection of Shape objects contained in the specified document range. Use a method accessible with the RichEditControl.Document.Shapes.Get(DocumentRange range) notation instead.

GetSubDocumentType()

Returns the subdocument type.

GetTableCell(DocumentPosition)

Obsolete. Gets a table cell in which the specified position is located.

GetText(DocumentRange)

Returns the plain text of the specified document range.

GetText(DocumentRange, PlainTextDocumentExporterOptions)

Returns the plain text of the specified document range.

GetText(DocumentRange, PlainTextDocumentExporterOptions, TextFragmentOptions)

Returns the plain text of the specified document range.

GetText(DocumentRange, TextFragmentOptions)

Returns the plain text of the specified document range.

GetWordMLText(DocumentRange)

Gets the text contained in the specified range in WordML format.

GetWordMLText(DocumentRange, WordMLDocumentExporterOptions)

Gets the text contained in the specified range in WordML format.

InsertDocumentContent(DocumentPosition, DocumentRange)

Inserts content from the specified range in the current document at the specified position.

InsertDocumentContent(DocumentPosition, DocumentRange, InsertOptions)

Inserts content from the specified range in the current document at the specified position.

InsertDocumentContent(DocumentPosition, Stream)

Inserts content from the stream in the current document at the specified position.

InsertDocumentContent(DocumentPosition, Stream, DocumentFormat)

Inserts content from the stream in the current document at the specified position.

InsertDocumentContent(DocumentPosition, Stream, DocumentFormat, InsertOptions)

Inserts content from the specified stream in the specified format, at the specified position, in the current document.

InsertDocumentContent(DocumentPosition, Stream, DocumentFormat, String)

Insert content from the stream in the current document at the specified position.

InsertDocumentContent(DocumentPosition, Stream, DocumentFormat, String, InsertOptions)

Inserts content from the specified stream in the specified format, at the specified position, in the current document.

InsertDocumentContent(DocumentPosition, String)

Inserts content from the file in the current document at the specified position.

InsertDocumentContent(DocumentPosition, String, DocumentFormat)

Inserts content from the file in the current document at the specified position.

InsertDocumentContent(DocumentPosition, String, DocumentFormat, InsertOptions)

Inserts content from the file in the current document at the specified position.

InsertDocumentContent(DocumentPosition, String, DocumentFormat, String)

Inserts content from the file in the current document at the specified position.

InsertDocumentContent(DocumentPosition, String, DocumentFormat, String, InsertOptions)

Inserts content from the file in the current document at the specified position.

InsertHtmlText(DocumentPosition, String)

Inserts the specified HTML text into the specified position.

InsertHtmlText(DocumentPosition, String, InsertOptions)

Inserts the specified HTML text into the specified position.

InsertImage(DocumentPosition, DocumentImageSource)

Obsolete. Inserts an image into the specified position in the document.

InsertImage(DocumentPosition, Image)

Obsolete. Inserts an image into the specified position in the document.

InsertParagraph(DocumentPosition)

Obsolete. Inserts a new paragraph into the document's SubDocument.Paragraphs collection at a specified position.

InsertParagraph(DocumentPosition, InsertOptions)

Obsolete. Inserts a new paragraph into the document at a specified position.

InsertPicture(DocumentPosition, DocumentImageSource)

Obsolete. Inserts a picture as a floating object.

InsertPicture(DocumentPosition, Image)

Obsolete. Inserts a picture as a floating object.

InsertRtfText(DocumentPosition, String)

Inserts the specified formatted text into the specified position.

InsertRtfText(DocumentPosition, String, InsertOptions)

Inserts the specified formatted text into the specified position.

InsertSingleLineText(DocumentPosition, String)

Inserts a single line of text (text without line breaks) at the specified position.

InsertTable(DocumentPosition, Int32, Int32)

Obsolete. Inserts a blank table with the specified number of rows and columns at the specified position.

InsertTable(DocumentPosition, Int32, Int32, AutoFitBehaviorType)

Obsolete. Inserts a blank table with the specified number of rows and columns at the specified position.

InsertTable(DocumentPosition, Int32, Int32, AutoFitBehaviorType, Int32)

Obsolete. Inserts a blank table with the specified number of rows and columns at the specified position.

InsertText(DocumentPosition, String)

Inserts the specified text at the specified position.

InsertTextBox(DocumentPosition)

Obsolete. Inserts a floating text box.

RemoveBookmark(Bookmark)

Obsolete. Removes the specified bookmark from the bookmark collection of the document.

Obsolete. Converts a hyperlink to plain text.

RemoveNumberingFromParagraph(Paragraph)

Obsolete. Removes the numbering or bullet from the specified paragraph.

RemoveNumberingFromParagraphs(DocumentRange)

Obsolete. Remove the numbering or bullet from all paragraphs intersecting the specified range.

Replace(DocumentRange, String)

Replaces the specified document range with the specified text string.

ReplaceAll(Regex, String)

Replaces all occurrences of a character pattern defined by a regular expression with a specified replacement string.

ReplaceAll(Regex, String, DocumentRange)

Replaces all occurrences of a character pattern defined by a regular expression with a specified replacement string.

ReplaceAll(String, String, SearchOptions)

Finds all occurrences of the search string in the current document, and replaces them with the replacement string.

ReplaceAll(String, String, SearchOptions, DocumentRange)

Finds all occurrences of the search string in the specified range, and replaces them with the replacement string.

SelectAll()

Selects all the content in the document.

SelectBookmark(Bookmark)

Obsolete. Selects a range associated with the specified bookmark.

SetPageBackground(Boolean)

Shows the background color of the page.

SetPageBackground(Color)

Set the background color of the page.

SetPageBackground(Color, Boolean)

Sets the background color of the page and specifies whether it is shown.

StartSearch(Regex)

Provides a search interface for a search in the document, using a regular expression pattern.

StartSearch(Regex, DocumentRange)

Provides a search interface for a search in the specified range using a regular expression pattern.

StartSearch(String)

Provides a search interface with default parameters.

StartSearch(String, SearchOptions, SearchDirection)

Provides a search interface for a search in the current document in the specified direction, using the specified options.

StartSearch(String, SearchOptions, SearchDirection, DocumentRange)

Provides a search interface for a search in the specified range in the specified direction, using the specified options.

See Also