SnapSubDocument Members

Provides the essential Snap document functionality.

Properties

Name Description
ActiveEntity Specifies a Snap field for which the SnapEntity.Active property is enabled. Inherited from ISnapFieldOwner.
Bookmarks Provides access to the collection of document bookmarks. Inherited from SubDocument.
Comments Provides access to a collection of comments in the current SubDocument. Inherited from SubDocument.
CustomMarks Provides access to a collection of custom marks. Inherited from SubDocument.
Fields Provides access to the collection of fields in the current document. Inherited from SubDocument.
FormFields Provides access to the collection of the document's FormField objects. Inherited from SubDocument.
Hyperlinks Provides access to a collection of hyperlinks in the document. Inherited from SubDocument.
Images Provides access to the collection of all images (inline and floating pictures) in the document . Inherited from SubDocument.
Length Gets the character length of the document. Inherited from SubDocument.
PageBackColor Gets the background color of the page. Inherited from SubDocument.
Paragraphs Provides access to a collection of paragraphs. Inherited from SubDocument.
Range Gets the range for the current Snap 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.

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.
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.
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.
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.
FindListByName(String) Searches for a Snap list by its name. Inherited from ISnapFieldOwner.
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.
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.
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.
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.
RemoveField(Int32) Removes a Snap field at the specified position. Inherited from ISnapFieldOwner.
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) 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.
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.
See Also