Skip to main content
A newer version of this page is available.

SnapSubDocument Methods

Provides the essential Snap document functionality.
Name Description
AddParagraphsToList(DocumentRange, NumberingList, Int32) Obsolete. Apply the numbering list format specified by the NumberingList object to the paragraphs in the specified range. Inherited from SubDocument.
AddParagraphToList(Paragraph, NumberingList, Int32) Obsolete. Apply the numbering list format specified by the NumberingList object to the specified paragraph. Inherited from SubDocument.
AddParagraphToList(Paragraph, Int32, Int32) Obsolete. Apply the numbering list format specified by the NumberingList object to the specified paragraph. Inherited from SubDocument.
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 stream. Inherited from SubDocument.
AppendDocumentContent(String) Appends content from the string value. Inherited from SubDocument.
AppendHtmlText(String, InsertOptions) Appends HTML formatted text. Inherited from SubDocument.
AppendHtmlText(String) Appends HTML formatted text. Inherited from SubDocument.
AppendImage(DocumentImageSource) Obsolete. Appends a specified image. Inherited from SubDocument.
AppendImage(Image) Obsolete. Appends a specified image. Inherited from SubDocument.
AppendParagraph() Obsolete. Appends an empty paragraph. Inherited from SubDocument.
AppendRtfText(String, InsertOptions) Appends formatted text. Inherited from SubDocument.
AppendRtfText(String) Appends formatted text. Inherited from SubDocument.
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.
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. Inherited from SubDocument.
CreateBookmark(DocumentRange, String) Obsolete. Creates a bookmark for the specified range with the specified name and adds it to the SubDocument.Bookmarks collection. Inherited from SubDocument.
CreateCustomMark(DocumentPosition, Object) Obsolete. Creates a custom mark at the specified position and associates specified data with it. Inherited from SubDocument.
CreateHyperlink(DocumentPosition, Int32) Obsolete. Creates a hyperlink for the document range, starting at the specified position, and extending through a specified length. Inherited from SubDocument.
CreateHyperlink(DocumentRange) Obsolete. Creates a hyperlink for the specified document range. Inherited from SubDocument.
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.
CreateSnBarCode(DocumentPosition) Adds a Bar Code to the specified position in a document. Inherited from ISnapFieldOwner.
CreateSnChart(DocumentPosition) Inserts a Chart into the specified position in a document. Inherited from ISnapFieldOwner.
CreateSnCheckBox(DocumentPosition, String) Adds a Check Box to the specified position in a document. Inherited from ISnapFieldOwner.
CreateSnHyperlink(DocumentPosition, String) Adds a Hyperlink to the specified position in a document. Inherited from ISnapFieldOwner.
CreateSnImage(DocumentPosition, String) Adds a Picture to the specified position in a document. Inherited from ISnapFieldOwner.
CreateSnList(DocumentPosition, String) Adds a Snap list to the specified position in a document. Inherited from ISnapFieldOwner.
CreateSnRowIndex(DocumentPosition) Adds a Row Index to the specified position in an document. Inherited from ISnapFieldOwner.
CreateSnSparkline(DocumentPosition, String) Adds a Sparkline to the specified position in a document. Inherited from ISnapFieldOwner.
CreateSnText(DocumentPosition, String) Adds a text box to the specified position in a document. Inherited from ISnapFieldOwner.
Delete(DocumentRange) Removes the specified range of text from the document. Inherited from SubDocument.
DeleteCustomMark(CustomMark) Obsolete. Delete specified custom mark from the document’s collection. 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, 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 current document. 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.
FindListByName(String) Searches for a Snap list by its name. Inherited from ISnapFieldOwner.
GetCustomMarkByVisualInfo(CustomMarkVisualInfo) Obsolete. Provides access to a custom mark in the RichEditControl.CustomMarkDraw event handler. 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.
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.
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.
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. 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.
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.
GetParagraph(DocumentPosition) Obsolete. Gets the paragraph encompassing the specified position. Inherited from SubDocument.
GetParagraphs(DocumentRange) Obsolete. Provides access to paragraphs to which the specified range belongs. 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.
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. Inherited from SubDocument.
GetSubDocumentType() Returns the subdocument type. Inherited from SubDocument.
GetTableCell(DocumentPosition) Obsolete. Gets a table cell in which the specified position is located. 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.
InsertImage(DocumentPosition, DocumentImageSource) Obsolete. Inserts an image into the specified position in the document. Inherited from SubDocument.
InsertImage(DocumentPosition, Image) Obsolete. Inserts an image into the specified position in the document. Inherited from SubDocument.
InsertParagraph(DocumentPosition, InsertOptions) Obsolete. Inserts a new paragraph into the document at a specified position. Inherited from SubDocument.
InsertParagraph(DocumentPosition) Obsolete. Inserts a new paragraph into the document’s SubDocument.Paragraphs collection at a specified position. Inherited from SubDocument.
InsertPicture(DocumentPosition, DocumentImageSource) Obsolete. Inserts a picture as a floating object. Inherited from SubDocument.
InsertPicture(DocumentPosition, Image) Obsolete. Inserts a picture as a floating object. 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.
InsertSingleLineText(DocumentPosition, String) Inserts a single line of text (text without line breaks) at the specified position. Inherited from SubDocument.
InsertTable(DocumentPosition, Int32, Int32, AutoFitBehaviorType, Int32) Obsolete. Inserts a blank table with the specified number of rows and columns at the specified position. Inherited from SubDocument.
InsertTable(DocumentPosition, Int32, Int32, AutoFitBehaviorType) Obsolete. Inserts a blank table with the specified number of rows and columns at the specified position. Inherited from SubDocument.
InsertTable(DocumentPosition, Int32, Int32) Obsolete. Inserts a blank table with the specified number of rows and columns at the specified position. Inherited from SubDocument.
InsertText(DocumentPosition, String) Inserts the specified text at the specified position. Inherited from SubDocument.
InsertTextBox(DocumentPosition) Obsolete. Inserts a floating text box. Inherited from SubDocument.
ParseField(Field) Converts the fields of a RichEditControl to Snap fields. Inherited from ISnapFieldOwner.
ParseField(Int32) Converts the fields of a RichEditControl to Snap fields. Inherited from ISnapFieldOwner.
RemoveBookmark(Bookmark) Obsolete. Removes the specified bookmark from the bookmark collection of the document. Inherited from SubDocument.
RemoveField(Int32) Removes a Snap field at the specified position. Inherited from ISnapFieldOwner.
RemoveHyperlink(Hyperlink) Obsolete. Converts a hyperlink to plain text. Inherited from SubDocument.
RemoveNumberingFromParagraph(Paragraph) Obsolete. Removes the numbering or bullet from the specified paragraph. Inherited from SubDocument.
RemoveNumberingFromParagraphs(DocumentRange) Obsolete. Remove the numbering or bullet from all paragraphs intersecting the specified range. Inherited from SubDocument.
RemoveSnList(String) Removes the specified Snap list from a document. Inherited from ISnapFieldOwner.
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.
SelectAll() Selects all the content in the document. Inherited from SubDocument.
SelectBookmark(Bookmark) Obsolete. Selects a range associated with the specified bookmark. 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.
See Also