IDocument Interface |
Represents the MS Word Document.
Namespace: Spire.Doc.Interface
Assembly: Spire.Doc (in Spire.Doc.dll) Version: 13.2.3.0 (13.2.3.3046)
Syntax
The IDocument type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
|
Background |
Gets background for the document.
|
|
|
Bookmarks |
Gets collection of bookmarks of the document
|
|
|
BuiltinDocumentProperties |
Gets document's built-in properties.
|
|
|
ChildObjects |
Gets the child entities.
(Inherited from
ICompositeObject
.)
|
|
|
Comments |
Gets Collection of Comments of the document.
|
|
|
CustomDocumentProperties |
Gets document's custom properties.
|
|
|
Document |
Gets document of this entity.
(Inherited from
IDocumentObject
.)
|
|
|
DocumentObjectType |
Gets the type of the document object.
(Inherited from
IDocumentObject
.)
|
|
|
HasChanges |
Gets a value indicating whether the document has tracked changes.
|
|
|
IsComposite |
Gets a value indicating whether this instance is composite.
(Inherited from
IDocumentObject
.)
|
|
|
IsUpdateFields |
Gets or sets a value indicating whether to update fields in the document.
On the moment only DOCVARIABLE fields can be updated.
|
|
|
LastParagraph |
Gets the last paragraph.
|
|
|
LastSection |
Gets last section object.
|
|
|
ListStyles |
Gets collection of list styles.
|
|
|
MailMerge |
Gets mail merge engine.
|
|
|
NextSibling |
Gets the next sibling.
(Inherited from
IDocumentObject
.)
|
|
|
Owner |
Gets owner of this document object.
(Inherited from
IDocumentObject
.)
|
|
|
PreviousSibling |
Gets the previous sibling.
(Inherited from
IDocumentObject
.)
|
|
|
Properties |
Gets the document properties.
|
|
|
ProtectionType |
Gets or sets the type of protection of the document.
|
|
|
Sections |
Gets collection of sections of this document.
|
|
|
Styles |
Gets collection of styles.
|
|
|
TextBoxes |
Gets the textboxes of the document.
|
|
|
TOC |
Gets or sets the TOC element of the document.
|
|
|
Variables |
Gets or sets the document variables.
|
|
|
ViewSetup |
Returns or setsview type in MSWord.
|
|
|
Watermark |
Gets or sets watermark for the document.
|
Methods
| Name | Description | |
|---|---|---|
|
AddListStyle |
Adds new list style to document.
|
|
|
AddParagraphStyle |
Adds new paragraph style to document.
|
|
|
AddSection |
Adds new section to document.
|
|
|
AddStyle |
Adds the style to the document style.
|
|
|
Clone |
Make deep copy of word document.
|
|
|
CreateMinialDocument |
If the document contains no sections, creates one section
with one paragraph.
|
|
|
CreateParagraph |
Creates the paragraph.
|
|
|
Encrypt |
Encrypts the document.
|
|
|
FindAllPattern |
Finds and returns all entries of specified regular expression along with formatting.
|
|
|
FindAllString |
Finds and returns all entries of specified string along with formatting,
taking into consideration caseSensitive and wholeWord options.
|
|
|
FindPattern(Regex) |
Finds and returns entry of specified regular expression along with formatting.
|
|
|
FindPattern(BodyRegion, Regex) |
Finds the next entry of matchString pattern.
|
|
|
FindPatternInLine(Regex) |
Finds the first entry of specified pattern in single-line mode.
|
|
|
FindPatternInLine(BodyRegion, Regex) |
Finds the next text which fit the specified pattern starting from start BodyRegion
using single-line mode.
|
|
|
FindString(String, Boolean, Boolean) |
Finds and returns entry of specified string along with formatting,
taking into consideration caseSensitive and wholeWord options.
|
|
|
FindString(BodyRegion, String, Boolean, Boolean) |
Finds the next entry of matchString string, taking into consideration caseSensitive
and wholeWord options.
|
|
|
FindStringInLine(String, Boolean, Boolean) |
Finds the first entry of matchString text in single-line mode.
|
|
|
FindStringInLine(BodyRegion, String, Boolean, Boolean) |
Finds the next matchString text starting from specified.
BodyRegion using single-line mode.
|
|
|
GetNextWidgetSibling |
Gets the next widget sibling.
(Inherited from
IDocumentObject
.)
|
|
|
GetPreviousWidgetSibling |
Gets the previous sibling.
(Inherited from
IDocumentObject
.)
|
|
|
GetText |
Gets the document's text.
|
|
|
ImportContent(IDocument) |
Imports all content into the document.
|
|
|
ImportContent(IDocument, Boolean) |
Imports all content into document.
|
|
|
LoadFromFile(String) |
Opens the document from file in Microsoft Word format.
|
|
|
LoadFromFile(String, FileFormat) |
Opens the document from file in Xml or Microsoft Word format.
|
|
|
LoadFromFileInReadMode |
LoadFromStream new document in read-only mode.
|
|
|
LoadFromStream |
Opens the document from stream in Xml or Microsoft Word format.
|
|
|
Protect(ProtectionType) |
Protects the document.
|
|
|
Protect(ProtectionType, String) |
Protects the document.
|
|
|
RemoveEncryption |
Removes the encryption.
|
|
|
Replace(Regex, TextSelection) |
Replaces all entries of matchString regular expression with TextRangesHolder.
|
|
|
Replace(Regex, String) |
Replaces all occurrences of a character pattern specified
by a regular expression with newValue string.
|
|
|
Replace(String, TextSelection, Boolean, Boolean) |
Replaces all entries of matchString string with TextSelection, taking into
consideration caseSensitive and wholeWord options.
|
|
|
Replace(String, String, Boolean, Boolean) |
Replaces all entries of matchString string with newValue string, taking into
consideration caseSensitive and wholeWord options.
|
|
|
ReplaceInLine(Regex, TextSelection) |
Replaces the matchString pattern with matchSelection in single-line mode.
|
|
|
ReplaceInLine(Regex, String) |
Replaces all entries with specified pattern with newValue text in single-line mode.
|
|
|
ReplaceInLine(String, TextSelection, Boolean, Boolean) |
Replaces the matchString text with matchSelection in single-line mode.
|
|
|
ReplaceInLine(String, String, Boolean, Boolean) |
Replaces all entries of matchString text with newValue text in single-line mode.
|
|
|
ResetFindState |
Resets the FindPattern.
|
|
|
SaveToFile(String) |
Saves the document to file in Microsoft Word format.
|
|
|
SaveToFile(Stream, FileFormat) |
Saves the document to a stream in Xml or Microsoft Word format.
|
|
|
SaveToFile(String, FileFormat) |
Saves the document to file in Xml or Microsoft Word format.
|
|
|
SaveToFile(String, FileFormat, HttpResponse, HttpContentType) |
Streams the document to the client browser.
|
|
|
SaveToImages(ImageType) |
Converts the whole document into images
|
|
|
SaveToImages(Int32, ImageType) |
Converts the specified page into image
|
|
|
SaveToImages(Int32, ImageFormat) |
Converts the specified page into image
|
|
|
SaveToImages(Int32, Int32, ImageType) |
Converts the specified range of pages into images
|
|
|
UpdateWordCount |
Update Paragraphs count, Word count and Character count
|
See Also
