com.spire.doc.interfaces
Interface IDocument

All Superinterfaces:

ICompositeObject, IDocumentObject

All Known Implementing Classes:

Document

public interface IDocument
extends ICompositeObject

Represents the MS Word Document.

Method Summary

ListStyle	addListStyle(ListType listType, java.lang.String styleName) Adds new list style to document.
ParagraphStyle	addParagraphStyle(java.lang.String styleName) Adds new paragraph style to document.
Section	addSection() Adds new section to document.
Style	addStyle(BuiltinStyle builtinStyle) Adds the style to the document style.
void	createMinialDocument() If the document contains no sections, creates one section with one paragraph.
Paragraph	createParagraph() Creates the paragraph.
Document	deepClone() Make deep copy of word document.
void	encrypt(java.lang.String password) Encrypts the document.
TextSelection[]	findAllPattern(java.util.regex.Pattern pattern) Finds and returns all entries of specified regular expression along with formatting.
TextSelection[]	findAllString(java.lang.String given, boolean caseSensitive, boolean wholeWord) Finds and returns all entries of specified string along with formatting, taking into consideration caseSensitive and wholeWord options.
TextSelection	findPattern(BodyRegion startBodyItem, java.util.regex.Pattern pattern) Finds the next entry of matchString pattern.
TextSelection	findPattern(java.util.regex.Pattern pattern) Finds and returns entry of specified regular expression along with formatting.
TextSelection[]	findPatternInLine(BodyRegion startBodyItem, java.util.regex.Pattern pattern) Finds the next text which fit the specified pattern starting from start BodyRegion using single-line mode.
TextSelection[]	findPatternInLine(java.util.regex.Pattern pattern) Finds the first entry of specified pattern in single-line mode.
TextSelection	findString(BodyRegion startTextBodyItem, java.lang.String given, boolean caseSensitive, boolean wholeWord) Finds the next entry of matchString string, taking into consideration caseSensitive and wholeWord options.
TextSelection	findString(java.lang.String given, boolean caseSensitive, boolean wholeWord) Finds and returns entry of specified string along with formatting, taking into consideration caseSensitive and wholeWord options.
TextSelection[]	findStringInLine(BodyRegion startTextBodyItem, java.lang.String given, boolean caseSensitive, boolean wholeWord) Finds the next matchString text starting from specified.
TextSelection[]	findStringInLine(java.lang.String given, boolean caseSensitive, boolean wholeWord) Finds the first entry of matchString text in single-line mode.
Background	getBackground() Gets background for the document.
BookmarkCollection	getBookmarks() Gets collection of bookmarks of the document
BuiltinDocumentProperties	getBuiltinDocumentProperties() Gets document's built-in properties.
CommentsCollection	getComments() Gets Collection of Comments of the document.
CustomDocumentProperties	getCustomDocumentProperties() Gets document's custom properties.
Paragraph	getLastParagraph() Gets the last paragraph.
Section	getLastSection() Gets last section object.
ListStyleCollection	getListStyles() Gets collection of list styles.
MailMerge	getMailMerge() Gets mail merge engine.
DocumentProperties	getProperties() Gets the document properties.
ProtectionType	getProtectionType() Gets the type of protection of the document.
SectionCollection	getSections() Gets collection of sections of this document.
StyleCollection	getStyles() Gets collection of styles.
java.lang.String	getText() Gets the document's text.
TextBoxCollection	getTextBoxes() Gets the textboxes of the document.
TableOfContent	getTOC() Gets the TOC element of the document.
VariableCollection	getVariables() Gets the document variables.
ViewSetup	getViewSetup() Returns type in MSWord.
WatermarkBase	getWatermark() Gets watermark for the document.
boolean	hasChanges() Gets a value indicating whether the document has tracked changes.
void	importContent(IDocument doc) Imports all content into the document.
void	importContent(IDocument doc, boolean importStyles) Imports all content into document.
boolean	isUpdateFields() Gets a value indicating whether to update fields in the document.
void	isUpdateFields(boolean value) Sets a value indicating whether to update fields in the document.
void	loadFromFile(java.lang.String fileName) Opens the document from file in Microsoft Word format.
void	loadFromFile(java.lang.String fileName, FileFormat fileFormat) Opens the document from file in Xml or Microsoft Word format.
void	loadFromFileInReadMode(java.lang.String strFileName, FileFormat fileFormat) LoadFromStream new document in read-only mode.
void	loadFromStream(java.io.InputStream stream, FileFormat fileFormat) Opens the document from stream in Xml or Microsoft Word format.
void	protect(ProtectionType type) Protects the document.
void	protect(ProtectionType type, java.lang.String password) Protects the document.
void	removeEncryption() Removes the encryption.
int	replace(java.util.regex.Pattern pattern, java.lang.String replace) Replaces all occurrences of a character pattern specified by a regular expression with newValue string.
int	replace(java.util.regex.Pattern pattern, TextSelection textSelection) Replaces all entries of matchString regular expression with TextRangesHolder.
int	replace(java.lang.String given, java.lang.String replace, boolean caseSensitive, boolean wholeWord) Replaces all entries of matchString string with newValue string, taking into consideration caseSensitive and wholeWord options.
int	replace(java.lang.String given, TextSelection textSelection, boolean caseSensitive, boolean wholeWord) Replaces all entries of matchString string with TextSelection, taking into consideration caseSensitive and wholeWord options.
int	replaceInLine(java.util.regex.Pattern pattern, java.lang.String replace) Replaces all entries with specified pattern with newValue text in single-line mode.
int	replaceInLine(java.util.regex.Pattern pattern, TextSelection replacement) Replaces the matchString pattern with matchSelection in single-line mode.
int	replaceInLine(java.lang.String given, java.lang.String replace, boolean caseSensitive, boolean wholeWord) Replaces all entries of matchString text with newValue text in single-line mode.
int	replaceInLine(java.lang.String given, TextSelection replacement, boolean caseSensitive, boolean wholeWord) Replaces the matchString text with matchSelection in single-line mode.
void	resetFindState() Resets the FindPattern.
void	saveToFile(java.io.OutputStream stream, FileFormat fileFormat) Saves the document to a stream in Xml or Microsoft Word format.
void	saveToFile(java.lang.String fileName) Saves the document to file in Microsoft Word format.
void	saveToFile(java.lang.String fileName, FileFormat fileFormat) Saves the document to file in Xml or Microsoft Word format.
java.awt.image.BufferedImage[]	saveToImages(ImageType type) Converts the whole document into images Layouting of the pages is not exactly the same as the layouting made by Microsoft Word.
java.awt.image.BufferedImage	saveToImages(int pageIndex, ImageType type) Converts the specified page into image.
java.awt.image.BufferedImage[]	saveToImages(int pageIndex, int noOfPages, ImageType type) Converts the specified range of pages into images Layouting of the pages is not exactly the same as the layouting made by MS-Word.
void	setProtectionType(ProtectionType value) Sets the type of protection of the document.
void	setTOC(TableOfContent value) Sets the TOC element of the document.
void	setWatermark(WatermarkBase value) Sets watermark for the document.
void	updateWordCount() Update Paragraphs count, Word count and Character count

Methods inherited from interface com.spire.doc.interfaces.ICompositeObject

getChildObjects

Methods inherited from interface com.spire.doc.interfaces.IDocumentObject

getDocument, getDocumentObjectType, getNextSibling, getOwner, getPreviousSibling, isComposite

Method Detail

getBuiltinDocumentProperties

BuiltinDocumentProperties getBuiltinDocumentProperties()

Gets document's built-in properties.

Returns:

The built-in properties

getCustomDocumentProperties

CustomDocumentProperties getCustomDocumentProperties()

Gets document's custom properties.

Returns:

CustomDocumentProperties

getSections

SectionCollection getSections()

Gets collection of sections of this document.

Returns:

SectionCollection

getStyles

StyleCollection getStyles()

Gets collection of styles.

Returns:

StyleCollection

getListStyles

ListStyleCollection getListStyles()

Gets collection of list styles.

Returns:

ListStyleCollection

getBookmarks

BookmarkCollection getBookmarks()

Gets collection of bookmarks of the document

Returns:

BookmarkCollection

getTextBoxes

TextBoxCollection getTextBoxes()

Gets the textboxes of the document.

Returns:

TextBoxCollection

getTOC

TableOfContent getTOC()

Gets the TOC element of the document.

Returns:

TableOfContent

setTOC

void setTOC(TableOfContent value)

Sets the TOC element of the document.

Parameters:

value - TableOfContent

getComments

CommentsCollection getComments()

Gets Collection of Comments of the document.

Returns:

CommentsCollection

getLastSection

Section getLastSection()

Gets last section object.

Returns:

Section

getLastParagraph

Paragraph getLastParagraph()

Gets the last paragraph.

Returns:

the last paragraph.

getProtectionType

ProtectionType getProtectionType()

Gets the type of protection of the document.

Returns:

ProtectionType

setProtectionType

void setProtectionType(ProtectionType value)

Sets the type of protection of the document.

Parameters:

value - ProtectionType

getViewSetup

ViewSetup getViewSetup()

Returns type in MSWord.

Returns:

ViewSetup

getWatermark

WatermarkBase getWatermark()

Gets watermark for the document.

Returns:

WatermarkBase

setWatermark

void setWatermark(WatermarkBase value)

Sets watermark for the document.

Parameters:

value - WatermarkBase

getMailMerge

MailMerge getMailMerge()

Gets mail merge engine.

Returns:

MailMerge

getBackground

Background getBackground()

Gets background for the document.

Returns:

Background

getVariables

VariableCollection getVariables()

Gets the document variables.

Returns:

the variables.

getProperties

DocumentProperties getProperties()

Gets the document properties.

Returns:

the properties.

hasChanges

boolean hasChanges()

Gets a value indicating whether the document has tracked changes.

Returns:

if the document has tracked changes, set to true

isUpdateFields

boolean isUpdateFields()

Gets a value indicating whether to update fields in the document. On the moment only DOCVARIABLE fields can be updated.

Returns:

if update fields, set to true

isUpdateFields

void isUpdateFields(boolean value)

Sets a value indicating whether to update fields in the document. On the moment only DOCVARIABLE fields can be updated.

Parameters:

value - if update fields, set to true

createMinialDocument

void createMinialDocument()

If the document contains no sections, creates one section with one paragraph.

addSection

Section addSection()

Adds new section to document.

Returns:

Section

addParagraphStyle

ParagraphStyle addParagraphStyle(java.lang.String styleName)

Adds new paragraph style to document.

Parameters:

styleName - paragraph style name

Returns:

ParagraphStyle

addListStyle

ListStyle addListStyle(ListType listType,
                       java.lang.String styleName)

Adds new list style to document.

Parameters:

listType - type of the list style.

styleName - list style name

Returns:

ListStyle

getText

java.lang.String getText()

Gets the document's text.

Returns:

String

saveToImages

java.awt.image.BufferedImage[] saveToImages(ImageType type)

Converts the whole document into images Layouting of the pages is not exactly the same as the layouting made by Microsoft Word. The total number of pages and layouting of the elements may vary.

Parameters:

type - the ImageType

Returns:

the bufferedImages

saveToImages

java.awt.image.BufferedImage saveToImages(int pageIndex,
                                          ImageType type)

Converts the specified page into image. Layouting of the pages is not exactly the same as the layouting made by MS-Word. The total number of pages and layouting of the elements may vary.

Parameters:

pageIndex - zero based page index

type - the ImageType

Returns:

the bufferedImages

saveToImages

java.awt.image.BufferedImage[] saveToImages(int pageIndex,
                                            int noOfPages,
                                            ImageType type)

Converts the specified range of pages into images Layouting of the pages is not exactly the same as the layouting made by MS-Word. The total number of pages and layouting of the elements may vary.

Parameters:

pageIndex - starting page index (Zero based)

noOfPages - number of pages

type - the ImageType

Returns:

the bufferedImages

createParagraph

Paragraph createParagraph()

Creates the paragraph.

Returns:

The paragraph

deepClone

Document deepClone()

Make deep copy of word document.

Specified by:

deepClone in interface IDocumentObject

Returns:

The new Document

addStyle

Style addStyle(BuiltinStyle builtinStyle)

Adds the style to the document style.

Parameters:

builtinStyle - the built-in style.

Returns:

The Style

protect

void protect(ProtectionType type)

Protects the document.

Parameters:

type - the type of the protection.

protect

void protect(ProtectionType type,
             java.lang.String password)

Protects the document.

Parameters:

type - the type of the protection

password - the password used for protection.

encrypt

void encrypt(java.lang.String password)

Encrypts the document.

Parameters:

password - the password

removeEncryption

void removeEncryption()

Removes the encryption.

updateWordCount

void updateWordCount()

Update Paragraphs count, Word count and Character count

findPattern

TextSelection findPattern(java.util.regex.Pattern pattern)

Finds and returns entry of specified regular expression along with formatting.

Parameters:

pattern - pattern

Returns:

TextSelection

findString

TextSelection findString(java.lang.String given,
                         boolean caseSensitive,
                         boolean wholeWord)

Finds and returns entry of specified string along with formatting, taking into consideration caseSensitive and wholeWord options.

Parameters:

given - given

caseSensitive - caseSensitive

wholeWord - wholeWord

Returns:

TextSelection

findPatternInLine

TextSelection[] findPatternInLine(java.util.regex.Pattern pattern)

Finds the first entry of specified pattern in single-line mode.

Parameters:

pattern - the pattern.

Returns:

Array of TextSelection

findStringInLine

TextSelection[] findStringInLine(java.lang.String given,
                                 boolean caseSensitive,
                                 boolean wholeWord)

Finds the first entry of matchString text in single-line mode.

Parameters:

given - the string to find.

caseSensitive - if it specifies case sensitive, set to true

wholeWord - if it specifies to search a whole word, set to true

Returns:

array of TextSelection

findAllPattern

TextSelection[] findAllPattern(java.util.regex.Pattern pattern)

Finds and returns all entries of specified regular expression along with formatting.

Parameters:

pattern - pattern

Returns:

Array of TextSelection

findAllString

TextSelection[] findAllString(java.lang.String given,
                              boolean caseSensitive,
                              boolean wholeWord)

Finds and returns all entries of specified string along with formatting, taking into consideration caseSensitive and wholeWord options.

Parameters:

given - given

caseSensitive - caseSensitive

wholeWord - wholeWord

Returns:

Array of TextSelection

replace

int replace(java.util.regex.Pattern pattern,
            java.lang.String replace)

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

Parameters:

pattern - pattern

replace - replace

Returns:

int

replace

int replace(java.lang.String given,
            java.lang.String replace,
            boolean caseSensitive,
            boolean wholeWord)

Replaces all entries of matchString string with newValue string, taking into consideration caseSensitive and wholeWord options.

Parameters:

given - given

replace - replace

caseSensitive - caseSensitive

wholeWord - wholeWord

Returns:

int

replace

int replace(java.util.regex.Pattern pattern,
            TextSelection textSelection)

Replaces all entries of matchString regular expression with TextRangesHolder.

Parameters:

pattern - the pattern.

textSelection - the text selection.

Returns:

int

replace

int replace(java.lang.String given,
            TextSelection textSelection,
            boolean caseSensitive,
            boolean wholeWord)

Replaces all entries of matchString string with TextSelection, taking into consideration caseSensitive and wholeWord options.

Parameters:

given - the matchString.

textSelection - the text selection.

caseSensitive - if it specifies case sensitive, set to true

wholeWord - if it specifies to search whole word, set to true

Returns:

int

replaceInLine

int replaceInLine(java.lang.String given,
                  java.lang.String replace,
                  boolean caseSensitive,
                  boolean wholeWord)

Replaces all entries of matchString text with newValue text in single-line mode.

Parameters:

given - the matchString.

replace - the newValue.

caseSensitive - if it specifies case sensitive, set to true

wholeWord - if it specifies whole word to be newValue, set to true

Returns:

the number of performed replaces.

replaceInLine

int replaceInLine(java.util.regex.Pattern pattern,
                  java.lang.String replace)

Replaces all entries with specified pattern with newValue text in single-line mode.

Parameters:

pattern - the pattern.

replace - the newValue.

Returns:

The number of performed replaces.

replaceInLine

int replaceInLine(java.lang.String given,
                  TextSelection replacement,
                  boolean caseSensitive,
                  boolean wholeWord)

Replaces the matchString text with matchSelection in single-line mode.

Parameters:

given - the matchString.

replacement - the matchSelection.

caseSensitive - if it specifies case sensitive newValue, set to true

wholeWord - if it specifies whole word to be newValue, set to true

Returns:

the number of performed replaces.

replaceInLine

int replaceInLine(java.util.regex.Pattern pattern,
                  TextSelection replacement)

Replaces the matchString pattern with matchSelection in single-line mode.

Parameters:

pattern - the pattern.

replacement - the matchSelection.

Returns:

the number of performed replaces.

findString

TextSelection findString(BodyRegion startTextBodyItem,
                         java.lang.String given,
                         boolean caseSensitive,
                         boolean wholeWord)

Finds the next entry of matchString string, taking into consideration caseSensitive and wholeWord options.

Parameters:

startTextBodyItem - the text body item at which search starts (paragraph or table)

given - the string to find.

caseSensitive - if it specifies case sensitive search, set to true

wholeWord - if it specifies whole word to be search, set to true

Returns:

TextSelection

findPattern

TextSelection findPattern(BodyRegion startBodyItem,
                          java.util.regex.Pattern pattern)

Finds the next entry of matchString pattern.

Parameters:

startBodyItem - the start body item at which search starts (paragraph or table).

pattern - the pattern.

Returns:

TextSelection

findStringInLine

TextSelection[] findStringInLine(BodyRegion startTextBodyItem,
                                 java.lang.String given,
                                 boolean caseSensitive,
                                 boolean wholeWord)

Finds the next matchString text starting from specified. BodyRegion using single-line mode.

Parameters:

startTextBodyItem - the start text body item.

given - the matchString.

caseSensitive - if it specifies case sensitive search, set to true

wholeWord - if it specifies whole word to be search, set to true

Returns:

array of TextSelection

findPatternInLine

TextSelection[] findPatternInLine(BodyRegion startBodyItem,
                                  java.util.regex.Pattern pattern)

Finds the next text which fit the specified pattern starting from start BodyRegion using single-line mode.

Parameters:

startBodyItem - the start body item.

pattern - the pattern.

Returns:

array of TextSelection

resetFindState

void resetFindState()

Resets the FindPattern.

loadFromStream

void loadFromStream(java.io.InputStream stream,
                    FileFormat fileFormat)

Opens the document from stream in Xml or Microsoft Word format.

Parameters:

stream - The input stream

fileFormat - The file format

saveToFile

void saveToFile(java.io.OutputStream stream,
                FileFormat fileFormat)

Saves the document to a stream in Xml or Microsoft Word format.

Parameters:

stream - The output stream

fileFormat - The file format

loadFromFile

void loadFromFile(java.lang.String fileName)

Opens the document from file in Microsoft Word format.

Parameters:

fileName - file name

loadFromFile

void loadFromFile(java.lang.String fileName,
                  FileFormat fileFormat)

Opens the document from file in Xml or Microsoft Word format.

Parameters:

fileName - fileName

fileFormat - fileformat

loadFromFileInReadMode

void loadFromFileInReadMode(java.lang.String strFileName,
                            FileFormat fileFormat)

LoadFromStream new document in read-only mode.

Parameters:

strFileName - file to open.

fileFormat - type of the format.

saveToFile

void saveToFile(java.lang.String fileName)

Saves the document to file in Microsoft Word format.

Parameters:

fileName - file name

saveToFile

void saveToFile(java.lang.String fileName,
                FileFormat fileFormat)

Saves the document to file in Xml or Microsoft Word format.

Parameters:

fileName - file name

fileFormat - type of the format

importContent

void importContent(IDocument doc)

Imports all content into the document.

Parameters:

doc - the doc.

importContent

void importContent(IDocument doc,
                   boolean importStyles)

Imports all content into document.

Parameters:

doc - the doc.

importStyles - if the document styles which have same names will be also imported to the destination document, set to true