Skip to main content

Document Members

A document in the Rich Text Editor.

Properties

Name Description
Bookmarks Provides access to sub-document bookmarks. Inherited from SubDocument.
Fields Provides access to sub-document fields. Inherited from SubDocument.
Hyperlinks Provides access to sub-document hyperlinks. Inherited from SubDocument.
Images Provides access to the sub-document’s images. Inherited from SubDocument.
InlineImages Provides access to the sub-document’s inline images. Inherited from SubDocument.
Lists Provides access to document lists.
Paragraphs Provides access to the sub-document’s paragraphs. Inherited from SubDocument.
Sections Provides access to document sections.
Tables Provides access to sub-document tables. Inherited from SubDocument.
Type Returns the sub-document type. Inherited from SubDocument.

Methods

Name Description
AddHtmlAsync(Int32, String, CancellationToken) Parses HTML code and inserts the resulting content at the specified position in a sub-document. Inherited from SubDocument.
AddHtmlAsync(String, CancellationToken) Parses HTML code and inserts the resulting content at the end of a sub-document. Inherited from SubDocument.
AddRtfAsync(Int32, String, CancellationToken) Inserts text in Rich Text Format (RTF) into the sub-document at the specified position. Inherited from SubDocument.
AddRtfAsync(String, CancellationToken) Inserts text in Rich Text Format (RTF) at the end of a sub-document. Inherited from SubDocument.
AddTextAsync(Int32, String, CancellationToken) Inserts the text at the specified position. Inherited from SubDocument.
AddTextAsync(String, CancellationToken) Appends the specified text to the sub-document. Inherited from SubDocument.
BeginTransaction() Along with the EndTransaction() method, allows you to accumulate document changes on the server and send them to the client in a single transaction.
BeginUpdate(Boolean) Locks the Rich Text Editor to prevent its visual updates until the EndUpdate() method is called.
ChangeDefaultCharacterPropertiesAsync(Action<CharacterProperties>, CancellationToken) Sets the default character formatting in the document.
ClearFormattingAsync(Interval, CancellationToken) Resets character formatting in the sub-document’s interval to the default settings. Inherited from SubDocument.
ClearFormattingAsync(CancellationToken) Resets character formatting in the sub-document to the default settings. Inherited from SubDocument.
EndTransaction() Along with the BeginTransaction() method, allows you to accumulate document changes on the server and send them to the client in a single transaction.
EndUpdate() Unlocks the Rich Text Editor after a call to the BeginUpdate(Boolean) method and causes an immediate visual update.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
FindAllAsync(String, Boolean, CancellationToken) Finds all matches of the specified text in the sub-document. Inherited from SubDocument.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetHtmlAsync(Interval, CancellationToken) Returns the specified interval’s content in HTML format. Inherited from SubDocument.
GetHtmlAsync(Int32, Int32, CancellationToken) Returns the specified interval’s content in HTML format. The interval is specified by its start position and length. Inherited from SubDocument.
GetIntervalAsync(CancellationToken) Returns a sub-document’s interval. Inherited from SubDocument.
GetIsEmptyAsync(CancellationToken) Returns whether the document is empty.
GetRtfAsync(Interval, CancellationToken) Returns the specified interval’s content in Rich Text Format (RTF). Inherited from SubDocument.
GetRtfAsync(Int32, Int32, CancellationToken) Returns the interval content in Rich Text Format (RTF). The startPosition and length parameters define the interval. Inherited from SubDocument.
GetTextSpanAsync(Interval, CancellationToken) Gets the text span placed within the specified interval. Inherited from SubDocument.
GetTextSpanAsync(Int32, Int32, CancellationToken) Gets the text span at the specified position. Inherited from SubDocument.
GetType() Gets the Type of the current instance. Inherited from Object.
MailMergeAsync(DocumentFormat, MergeMode, Int32, Int32, CancellationToken) Merges the selected range of the data records to the document template, separates merge ranges with the specified delimeter, and generates the resulting document.
MailMergeAsync(DocumentFormat, MergeMode, Int32, CancellationToken) Merges records of the bound data source to the document template starting with the selected record, separates merge ranges with the specified delimeter, and generates the resulting document.
MailMergeAsync(DocumentFormat, MergeMode, CancellationToken) Merges all records of the bound data source to the document template, separates merge ranges with the selected delimeter, and generates the resulting document.
MailMergeAsync(DocumentFormat, CancellationToken) Merges all records of the bound data source to the document template, separates merge ranges with paragraphs, and generates the resulting document.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RemoveAsync(Interval, CancellationToken) Removes the specified text interval. Inherited from SubDocument.
RemoveAsync(Int32, Int32, CancellationToken) Removes the specified text interval. Inherited from SubDocument.
ReplaceAllAsync(String, String, Boolean, CancellationToken) Finds all matches of the specified string in the sub-document and replaces them with a specific string. Inherited from SubDocument.
ToString() Returns a string that represents the current object. Inherited from Object.
See Also