Document

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.spire.doc
Class Document

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.DocumentObject
              com.spire.doc.DocumentBase
                  com.spire.doc.DocumentContainer
                      com.spire.doc.Document

All Implemented Interfaces:: ICompositeObject, IDocument, IDocumentObject, IDocumentSerializable

public class Document
extends DocumentContainer
implements IDocument
extends DocumentContainer
implements IDocument

Field Summary
`BookmarkLevelHandler`	`BookmarkLayout` Occurs when draw a bookmark.
`PageLayoutHandler`	`PageLayout` Occurs when creating a new page.
`UpdateFieldsHandler`	`UpdateFields` Occurs when update field.

Constructor Summary
	`Document()`
	`Document(boolean useNewEngine)`
`protected`	`Document(Document doc)`
	`Document(java.io.InputStream stream)` Initializes a new instance of the Document class from the stream.
	`Document(java.io.InputStream stream, boolean useNewEngine)`
	`Document(java.io.InputStream inputStream, FileFormat type)` Initializes a new instance of the Document class from the stream of specified type protected with password.
	`Document(java.io.InputStream inputStream, FileFormat type, boolean useNewEngine)` Initializes a new instance of the Document class from the stream of specified type protected with password.
	`Document(java.io.InputStream inputStream, FileFormat type, java.lang.String password)` Initializes a new instance of the Document class from the stream of specified type protected with password.
	`Document(java.io.InputStream inputStream, FileFormat type, java.lang.String password, boolean useNewEngine)` Initializes a new instance of the Document class from the stream of specified type protected with password.
	`Document(java.io.InputStream stream, FileFormat type, XHTMLValidationType validationType)` Initializes a new instance of the Document class example:Loading an existing word document.
	`Document(java.io.InputStream stream, FileFormat type, XHTMLValidationType validationType, boolean useNewEngine)` Initializes a new instance of the Document class example:Loading an existing word document.
	`Document(java.io.InputStream inputStream, java.lang.String password)` Initializes a new instance of the Document class from the Word document�s stream, which is protected with password.
	`Document(java.io.InputStream inputStream, java.lang.String password, boolean useNewEngine)` Initializes a new instance of the Document class from the Word document�s stream, which is protected with password.
	`Document(java.lang.String fileName)`
	`Document(java.lang.String fileName, boolean useNewEngine)`
	`Document(java.lang.String fileName, FileFormat type)`
	`Document(java.lang.String fileName, FileFormat type, boolean useNewEngine)`
	`Document(java.lang.String fileName, FileFormat type, java.lang.String password)`
	`Document(java.lang.String fileName, FileFormat type, java.lang.String password, boolean useNewEngine)`
	`Document(java.lang.String fileName, FileFormat type, XHTMLValidationType validationType)`
	`Document(java.lang.String fileName, FileFormat type, XHTMLValidationType validationType, boolean useNewEngine)`
	`Document(java.lang.String fileName, java.lang.String password)`
	`Document(java.lang.String fileName, java.lang.String password, boolean useNewEngine)`

Method Summary
`void`	`acceptChanges()` Accepts changes tracked from the moment of last change acceptance.
`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 the document.
`Section`	`addSection()` Adds new section to document.
`Style`	`addStyle(BuiltinStyle builtinStyle)` Adds the style to the document style.
`boolean`	`checkProtectionPassWord(java.lang.String password)` Check that the password entered is the same as the permission protection password
`void`	`cleanup()`
`void`	`cleanup(CleanupOptions options)`
`void`	`clearCustomFontsFolders()` Clear the path of the folder where the custom font is located.
`static void`	`clearGlobalCustomFontsFolders()` Clear the path of the folder where the global custom font is located.
`void`	`clearMacros()` Removes the macros from the document.
`static void`	`clearSystemFontCache()` Clears the memory used by cached system fonts.
`void`	`cloneCompatibilityTo(Document destDoc)` Clones the current document compatibility to the destination document.
`void`	`cloneDefaultStyleTo(Document destDoc)` Clones the current document default style to the destination document.
`void`	`cloneSettingsTo(Document destDoc)` Clones the current document settings to the destination document.
`void`	`cloneThemesTo(Document destDoc)` Clones the current document theme style to the destination document.
`void`	`cloneWebSettingsTo(Document destDoc)` clone Websettings to other document
`void`	`close()` Closes this instance.
`void`	`compare(Document document, java.lang.String author)` Compares this document with another document.
`void`	`compare(Document document, java.lang.String author, CompareOptions options)` Compares this document with another document.
`void`	`compare(Document document, java.lang.String author, java.util.Date date)` Compares this document with another document.
`void`	`compare(Document document, java.lang.String author, java.util.Date date, CompareOptions options)` Compares this document with another document.
`void`	`createMinialDocument()` Create a minial document, one empty section to the document and one empty paragraph to created section.
`Paragraph`	`createParagraph()` Creates the paragraph.
`ParagraphBase`	`createParagraphItem(ParagraphItemType itemType)` Creates new paragraph item instance.
`Document`	`deepClone()` Clones itself.
`void`	`dispose()` Prerforms application-defined tasks associated with freeing,releasing, or resetting unmanaged resources.
`void`	`encrypt(java.lang.String password)` Encrypts the document.
`TextSelection[]`	`findAllPattern(java.util.regex.Pattern pattern)` Returns all entries of matchString regex.
`TextSelection[]`	`findAllPattern(java.util.regex.Pattern pattern, boolean isAdvancedSearch)` Returns all entries of matchString regex.
`TextSelection[]`	`findAllString(java.lang.String matchString, boolean caseSensitive, boolean wholeWord)` Returns all entries of matchString string, taking into consideration caseSensitive and wholeWord options.
`TextSelection`	`findPattern(BodyRegion start, 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 start, java.util.regex.Pattern pattern)` Finds the text which fit the specified pattern starting from start.
`TextSelection[]`	`findPatternInLine(java.util.regex.Pattern pattern)` Finds the first entry of specified pattern in single-line mode.
`TextSelection`	`findString(BodyRegion start, java.lang.String matchString, boolean caseSensitive, boolean wholeWord)` Finds the next entry of matchString string, taking into consideration caseSensitive and wholeWord options.
`TextSelection`	`findString(java.lang.String stringValue, boolean caseSensitive, boolean wholeWord)` Finds and returns string along with formatting.
`TextSelection[]`	`findStringInLine(BodyRegion start, java.lang.String matchString, boolean caseSensitive, boolean wholeWord)` Finds the next matchString text starting from specified using single-line mode.
`TextSelection[]`	`findStringInLine(java.lang.String given, boolean caseSensitive, boolean wholeWord)` Finds the first entry of matchString text in single-line mode.
`boolean`	`getAutoUpdateStylesByTemplate()` Gets a value indicating whether updating the styles in this document to match the styles in the attached template each time you open .
`Background`	`getBackground()` Gets document's background
`BookmarkCollection`	`getBookmarks()` Gets document bookmarks.
`BuiltinDocumentProperties`	`getBuiltinDocumentProperties()` Gets document built-in properties object.
`DocumentObjectCollection`	`getChildObjects()` Gets the child entities.
`CommentsCollection`	`getComments()` Gets comments item of the document.
`CustomDocumentProperties`	`getCustomDocumentProperties()` Gets document custom properties object.
`FileFormat`	`getDetectedFormatType()` Returns the detected format type of the document which was loaded.
`DocumentObjectType`	`getDocumentObjectType()` Gets the type of the document object.
`boolean`	`getEmbedFontsInFile()`
`boolean`	`getEmbedSystemFonts()`
`FootEndnoteOptions`	`getEndnoteOptions()` Gets options that control numbering and positioning of endnotes in this document.
`java.util.List<Footnote>`	`getEndnotes()` Gets document endnotes.
`FieldCollection`	`getFields()` Gets fields of the documnet.
`FootEndnoteOptions`	`getFootnoteOptions()` Gets options that control numbering and positioning of footnotes in this document.
`java.util.List<Footnote>`	`getFootnotes()` Gets document footnotes.
`boolean`	`getForceTableRelayout()` Gets or set a value indicating whether force table to relayout..
`java.lang.String`	`getHtmlBaseUrl()` Gets the Base path which is used to convert the relative path to absolute path.
`boolean`	`getHTMLCustomComment()` Gets a value specifying whether parsing and writing comment of document in HTML.
`HtmlExportOptions`	`getHtmlExportOptions()` Gets the save options.
`java.util.List`	`getHTMLIdentifierPunctuations()` Gets the custom punctuation as sentence indentifier.
`boolean`	`getHTMLSentenceIdentifier()` Gets a value specifying whether to add identifier to a sentence when writing to HTML.
`boolean`	`getHTMLTrackChanges()` Gets a value specifying whether parsing and writing custom Change_Tracking HTML Tags are supported.
`int`	`getJPEGQuality()` Gets the quality (Q%) of the image of JPEG format, this property is only used for doc to pdf.
`boolean`	`getKeepSameFormat()` Gets a value that indicates whether to keep same formatting when it is merged to other document.
`Paragraph`	`getLastParagraph()` Gets last section object.
`Section`	`getLastSection()` Gets last section of the document.
`ListStyleCollection`	`getListStyles()` Gets document list styles.
`MailMerge`	`getMailMerge()` Gets mail merge engine.
`FileFormat`	`getOriginalFileFormat()`
`int`	`getPageCount()` Gets total number of pages for document.
`int`	`getPageCountEx()` Gets total number of pages for document.
`PrintDocument`	`getPrintDocument()`
`com.spire.ms.System.Collections.Generic.List`	`getPrivateFontList()`
`DocumentProperties`	`getProperties()` Gets the document properties.
`ProtectionType`	`getProtectionType()` Gets the type of protection of the document.
`boolean`	`getQuiteMode()` Gets whether is quite mode.
`boolean`	`getReplaceFirst()` Gets a value indicating whether need first replacing.
`SectionCollection`	`getSections()` Gets document sections.
`StyleCollection`	`getStyles()` Gets document styles
`java.lang.String`	`getText()` Gets the document's text.
`TextBoxCollection`	`getTextBoxes()` Get textbox items of main document
`TableOfContent`	`getTOC()` Gets the TOC element of the document.
`boolean`	`getTrackChanges()` Gets a value indicating whether tracking changes is turn on.
`int`	`getUrlConnectTimeOut()`
`VariableCollection`	`getVariables()` Gets the document variables.
`ViewSetup`	`getViewSetup()` Gets view setup options in Microsoft word.
`WatermarkBase`	`getWatermark()` Gets document's watermark.
`XHTMLValidationType`	`getXHTMLValidateOption()` Gets the HTML validate option.the default value is None.
`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.
`void`	`importSection(ISection section)` Imports section into document.
`void`	`insertTextFromFile(java.lang.String fileName, FileFormat fileFormat)` Insert text from a file.
`void`	`insertTextFromStream(java.io.InputStream stream, FileFormat fileFormat)` Insert text from stream.
`boolean`	`isContainMacro()` Indicates whether the document has macros.
`static boolean`	`isEncrypted(java.io.InputStream stream)` Check that the document is encrypted
`static boolean`	`isEncrypted(java.lang.String fileName)` Check that the document is encrypted
`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`	`loadFontFallbackRuleSettings(java.lang.String fileName)` Load the font fallback rules from the xml
`void`	`loadFromFile(java.lang.String fileName)` Opens doc file.
`void`	`loadFromFile(java.lang.String fileName, FileFormat fileFormat)` Opens the document from file in Xml or Microsoft Word format.
`void`	`loadFromFile(java.lang.String fileName, FileFormat fileFormat, java.lang.String password)` Opens the document from file in Xml or Microsoft Word format.
`void`	`loadFromFile(java.lang.String fileName, FileFormat fileFormat, XHTMLValidationType validationType)` Opens the HTML document from stream .
`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`	`loadFromStream(java.io.InputStream stream, FileFormat fileFormat, java.lang.String password)` Opens the document from stream in Xml or Microsoft Word format.
`void`	`loadFromStream(java.io.InputStream stream, FileFormat fileFormat, XHTMLValidationType validationType)` Opens the HTML document from stream .
`void`	`loadRtf(java.io.InputStream stream)`
`void`	`loadRtf(java.io.InputStream stream, com.spire.ms.System.Text.Encoding encoding)` Opens the rtf document with specified encoding from a stream.
`void`	`loadRtf(java.lang.String fileName)` Opens the rtf document from a file.
`void`	`loadRtf(java.lang.String fileName, com.spire.ms.System.Text.Encoding encoding)` Opens the rtf document with specified encoding from a file.
`void`	`loadText(java.io.InputStream stream)` Opens the text document from a stream with default encoding utf-8.
`void`	`loadText(java.io.InputStream stream, java.nio.charset.Charset charset)` Opens the text document with specified encoding from a stream.
`void`	`loadText(java.lang.String fileName)` Opens the text document from a file with default encoding utf-8.
`void`	`loadText(java.lang.String fileName, java.nio.charset.Charset charset)` Opens the text document with specified encoding from a file.
`void`	`printMultipageToOneSheet(PagesPreSheet pagesPerSheet)` Print multipage to one sheet
`void`	`printMultipageToOneSheet(PagesPreSheet pagesPerSheet, boolean printPageBorders)` Print multipage to one sheet
`void`	`protect(ProtectionType type)` Protects the document.
`void`	`protect(ProtectionType type, java.lang.String password)` Protects the document.
`void`	`rejectChanges()` Rejects changes tracked from the moment of last change acceptance.
`void`	`removeEncryption()` Removes the encryption.
`int`	`replace(java.util.regex.Pattern pattern, java.lang.String replace)` Replaces all entries of matchString 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 matchString, IDocument matchDoc, boolean caseSensitive, boolean wholeWord)` Replaces the specified matchString.
`int`	`replace(java.lang.String matchString, java.lang.String newValue, 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 matchString, 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 newValue)` Replaces all entries with specified pattern with newValue text in single-line mode.
`int`	`replaceInLine(java.util.regex.Pattern pattern, TextSelection matchSelection)` Replaces the matchString pattern with matchSelection in single-line mode.
`int`	`replaceInLine(java.lang.String matchString, java.lang.String newValue, boolean caseSensitive, boolean wholeWord)` Replaces all entries of matchString text with newValue text in single-line mode.
`int`	`replaceInLine(java.lang.String matchString, TextSelection matchSelection, boolean caseSensitive, boolean wholeWord)` Replaces the matchString text with matchSelection in single-line mode.
`void`	`resetFindState()` Resets the FindPattern.
`void`	`resetPageLayoutCache()` Reset the page layout cache data of the new engine.
`void`	`saveFontFallbackRuleSettings(java.lang.String fileName)` Save the default font fallback rules to the xml
`void`	`saveToEpub(com.spire.ms.System.IO.Stream stream, DocPicture coverImage)` aves the EPUB document.
`void`	`saveToEpub(java.lang.String fileName, DocPicture coverImage)` Saves the EPUB document.
`void`	`saveToFile(java.io.OutputStream stream, FileFormat fileFormat)` Saves the document into stream in Xml or Microsoft Word format.
`void`	`saveToFile(java.lang.String fileName)` Saves 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.
`void`	`saveToFile(java.lang.String fileName, FileFormat fileFormat, byte[] certificateData, java.lang.String securePassword)` Saves document to file and digitally sign, Only DOC and DOCX are supported.
`void`	`saveToFile(java.lang.String fileName, FileFormat fileFormat, com.spire.ms.System.Net.HttpWebResponse response, HttpContentType contentType)` Saves the specified file name.
`void`	`saveToFile(java.lang.String fileName, FileFormat fileFormat, java.lang.String certificatePath, java.lang.String securePassword)` Saves document to file and digitally sign, Only DOC and DOCX are supported.
`void`	`saveToFile(java.lang.String fileName, ToPdfParameterList paramList)` Saves the document to PDF file.
`java.awt.image.BufferedImage[]`	`saveToImages(ImageType type)` Save the whole document into images
`java.awt.image.BufferedImage`	`saveToImages(int pageIndex, ImageType type)` Converts the specified page into image.
`java.awt.image.BufferedImage[]`	`saveToImages(int pageIndex, int pageCount, ImageType type, int dpiX, int dpiY)` Save the specified range of pages into images
`void`	`saveToStream(java.io.OutputStream stream, FileFormat fileFormat)` Saves the document into stream in Xml or Microsoft Word format.
`void`	`saveToStream(java.io.OutputStream stream, FileFormat fileFormat, byte[] certificateData, java.lang.String securePassword)` Saves document to stream and digitally sign, Only DOC and DOCX are supported.
`void`	`saveToStream(java.io.OutputStream stream, FileFormat fileFormat, java.lang.String certificatePath, java.lang.String securePassword)` Saves document to stream and digitally sign, Only DOC and DOCX are supported.
`void`	`saveToStream(java.io.OutputStream stream, ToPdfParameterList paramList)` Saves document to stream and digitally sign, Only DOC and DOCX are supported.
`java.util.List<byte[]>`	`saveToSVG()` Saves the SVG.
`java.util.List<byte[]>`	`saveToSVG(boolean outputToOneSvg)` Saves the SVG.
`void`	`saveToSVG(java.lang.String fileName)` Saves the SVG.
`void`	`saveToSVG(java.lang.String fileName, boolean outputToOneSvg)` Saves the SVG.
`void`	`saveToTiff(java.lang.String tiffFilename)` save doc to tiff.
`void`	`saveToTxt(java.lang.String fileName, java.nio.charset.Charset charset)` Saves to text document with specified encoding.
`void`	`setAutoUpdateStylesByTemplate(boolean value)` Sets a value indicating whether updating the styles in this document to match the styles in the attached template each time you open .
`void`	`setCustomFontsFolders(java.lang.String fontPath)` Set the path to the folder where the custom font is located.
`void`	`setDateTimeOfUnitTest(java.util.Date dateTime)` Sets date and time of the unit test.
`void`	`setEmbedFontsInFile(boolean value)`
`void`	`setEmbedSystemFonts(boolean value)`
`void`	`setForceTableRelayout(boolean value)`
`static void`	`setGlobalCustomFontsFolders(java.io.InputStream[] fontStreamList)` Sets the path to the folder where the global custom font is located.
`static void`	`setGlobalCustomFontsFolders(java.lang.String fontPath)` Sets the path to the folder where the global custom font is located.
`void`	`setHtmlBaseUrl(java.lang.String value)` Sets the Base path which is used to convert the relative path to absolute path.
`void`	`setHTMLCustomComment(boolean value)` Sets a value specifying whether parsing and writing comment of document in HTML.
`void`	`setHTMLIdentifierPunctuations(java.util.List value)` Sets the custom punctuation as sentence indentifier.
`void`	`setHTMLSentenceIdentifier(boolean value)` Sets a value specifying whether to add identifier to a sentence when writing to HTML.
`void`	`setHTMLTrackChanges(boolean value)` sets a value specifying whether parsing and writing custom Change_Tracking HTML Tags are supported.
`void`	`setJPEGQuality(int value)` sets the quality (Q%) of the image of JPEG format, this property is only used for doc to pdf.
`void`	`setKeepSameFormat(boolean value)` Sets a value that indicates whether to keep same formatting when it is merged to other document.
`void`	`setProtectionType(ProtectionType value)` Sets the type of protection of the document.
`void`	`setQuiteMode(boolean value)` Sets whether is quite mode.
`void`	`setReplaceFirst(boolean value)` Sets a value indicating whether need first replacing.
`void`	`setTextBoxes(TextBoxCollection value)` Set textbox items of main document
`void`	`setTOC(TableOfContent value)` Sets the TOC element of the document.
`void`	`setTrackChanges(boolean value)` Sets a value indicating whether tracking changes is turn on.
`void`	`setUrlConnectTimeOut(int value)` set timeout.
`void`	`setWatermark(PictureWatermark value, int sectionIndex)` Sets document's Picturewatermark.
`void`	`setWatermark(WatermarkBase value)` Sets document's watermark.
`void`	`setXHTMLValidateOption(XHTMLValidationType value)` Sets the HTML validate option.the default value is None.
`static byte[]`	`sign(java.io.InputStream sourceStream, byte[] certificateData, java.lang.String securePassword)` Create digitally signed word document.
`static byte[]`	`sign(java.io.InputStream sourceStream, java.lang.String certificatePath, java.lang.String securePassword)` Create digitally signed word document.
`void`	`updatePageLayout()` Updates the page layout of the document.
`void`	`updateTableLayout()` Update table grid before saving the document when using the new engine.
`void`	`updateTableOfContents()` Update Table of contents in the document.
`void`	`updateTableOfContents(TableOfContent toc)` Update specified Table of content in the document.
`void`	`updateTOCPageNumbers()` Update Table of contents page numbers in the document.
`void`	`updateTOCPageNumbers(TableOfContent toc)` Update specified Table of content page numbers in the document.
`void`	`updateWordCount()` Update Paragraphs count, Word count and Character count
`void`	`updateWordCount(char[] splitchar)` Update Paragraphs count, Word count and Character count.
`void`	`updateWordCount(char[] splitchar, boolean includeTbFnEn)` Update Paragraphs count, Word count and Character count.

Methods inherited from class com.spire.doc.DocumentContainer
`getCount, getIndex`

Methods inherited from class com.spire.doc.DocumentObject
`getFirstChild, getLastChild, getNextSibling, getNextWidgetSibling, getOwner, getPreviousSibling, getPreviousWidgetSibling, isComposite, prependChild, toString`

Methods inherited from class com.spire.doc.OwnerHolder
`getDocument`

Methods inherited from interface com.spire.doc.interfaces.IDocument
`saveToImages`

Methods inherited from interface com.spire.doc.interfaces.IDocumentObject
`getDocument, getNextSibling, getOwner, getPreviousSibling, isComposite`

Field Detail

BookmarkLayout

public BookmarkLevelHandler BookmarkLayout

Occurs when draw a bookmark.

PageLayout

public PageLayoutHandler PageLayout

Occurs when creating a new page.

UpdateFields

public UpdateFieldsHandler UpdateFields

Occurs when update field.

Constructor Detail

Document

public Document(java.lang.String fileName)

Document

public Document(java.lang.String fileName,
                boolean useNewEngine)

Document

public Document(java.lang.String fileName,
                java.lang.String password)

Document

public Document(java.lang.String fileName,
                java.lang.String password,
                boolean useNewEngine)

Document

public Document(java.lang.String fileName,
                FileFormat type)

Document

public Document(java.lang.String fileName,
                FileFormat type,
                boolean useNewEngine)

Document

public Document(java.lang.String fileName,
                FileFormat type,
                XHTMLValidationType validationType)

Document

public Document(java.lang.String fileName,
                FileFormat type,
                XHTMLValidationType validationType,
                boolean useNewEngine)

Document

public Document(java.lang.String fileName,
                FileFormat type,
                java.lang.String password)

Document

public Document(java.lang.String fileName,
                FileFormat type,
                java.lang.String password,
                boolean useNewEngine)

Document

public Document(java.io.InputStream stream,
                FileFormat type,
                XHTMLValidationType validationType)

Initializes a new instance of the Document class example:Loading an existing word document. Stream file2 = new FileStream(dataPath, FileMode.LoadFromStream, FileAccess.Read, FileShare.Read); Document docSource1 = new Document(file2,FormatType.Doc,XHTMLValidationType.Strict);

Parameters:: stream - The file stream.; type - The type of the opened document.; validationType - Type of the validation.

Document

public Document(java.io.InputStream stream,
                FileFormat type,
                XHTMLValidationType validationType,
                boolean useNewEngine)

Parameters:: stream - The file stream.; type - The type of the opened document.; validationType - Type of the validation.; useNewEngine - Use new engine.

Document

public Document()

Document

public Document(boolean useNewEngine)

Parameters:: useNewEngine -

Document

public Document(java.io.InputStream stream)

Initializes a new instance of the Document class from the stream. example:Stream file2 = new FileStream(dataPath, FileMode.LoadFromStream, FileAccess.Read, FileShare.Read); Document docSource1 = new Document(file2);

Parameters:: stream - The stream.

Document

public Document(java.io.InputStream stream,
                boolean useNewEngine)

Document

public Document(java.io.InputStream inputStream,
                FileFormat type)

Initializes a new instance of the Document class from the stream of specified type protected with password. example:Stream file2 = new FileStream(dataPath, FileMode.LoadFromStream, FileAccess.Read, FileShare.Read); Document docSource1 = new Document(file2, FormatType.doc, "password");

Parameters:: inputStream - The stream.; type - The type.

Document

public Document(java.io.InputStream inputStream,
                FileFormat type,
                boolean useNewEngine)

Parameters:: inputStream - The stream.; type - The type.; useNewEngine - use new engine.

Document

public Document(java.io.InputStream inputStream,
                java.lang.String password)

Initializes a new instance of the Document class from the Word document�s stream, which is protected with password. example:Stream file2 = new FileStream(dataPath, FileMode.LoadFromStream, FileAccess.Read, FileShare.Read); Document docSource1 = new Document(file2, "password");

Parameters:: inputStream - The stream.; password - The password.

Document

public Document(java.io.InputStream inputStream,
                java.lang.String password,
                boolean useNewEngine)

Parameters:: inputStream - The stream.; password - The password.; useNewEngine - use new engine.

Document

public Document(java.io.InputStream inputStream,
                FileFormat type,
                java.lang.String password)

Parameters:: inputStream - The stream.; type - The type.; password - The password.

Document

public Document(java.io.InputStream inputStream,
                FileFormat type,
                java.lang.String password,
                boolean useNewEngine)

Parameters:: inputStream - The stream.; type - The type.; password - The password.; useNewEngine - use new engine.

Document

protected Document(Document doc)

Method Detail

getTOC

public TableOfContent getTOC()

Description copied from interface: IDocument

Gets the TOC element of the document.

Specified by:: getTOC in interface IDocument

Returns:: TableOfContent

setTOC

public void setTOC(TableOfContent value)

Description copied from interface: IDocument

Sets the TOC element of the document.

Specified by:: setTOC in interface IDocument

Parameters:: value - TableOfContent

getEmbedFontsInFile

public boolean getEmbedFontsInFile()

setEmbedFontsInFile

public void setEmbedFontsInFile(boolean value)

getPrivateFontList

public com.spire.ms.System.Collections.Generic.List getPrivateFontList()

getEmbedSystemFonts

public boolean getEmbedSystemFonts()

setEmbedSystemFonts

public void setEmbedSystemFonts(boolean value)

loadFontFallbackRuleSettings

public void loadFontFallbackRuleSettings(java.lang.String fileName)

Load the font fallback rules from the xml

Parameters:: fileName - the xml file name

saveFontFallbackRuleSettings

public void saveFontFallbackRuleSettings(java.lang.String fileName)

Save the default font fallback rules to the xml

Parameters:: fileName - the xml file name

getHtmlBaseUrl

public java.lang.String getHtmlBaseUrl()

Gets the Base path which is used to convert the relative path to absolute path.

Returns:: String

setHtmlBaseUrl

public void setHtmlBaseUrl(java.lang.String value)

Sets the Base path which is used to convert the relative path to absolute path.

Parameters:: value - String

getHTMLTrackChanges

public boolean getHTMLTrackChanges()

Gets a value specifying whether parsing and writing custom Change_Tracking HTML Tags are supported. Supported HTML Tag : insert / delete. Supported HTML Tag Attribytes : data-username / data-time.

Returns:: boolean

setHTMLTrackChanges

public void setHTMLTrackChanges(boolean value)

sets a value specifying whether parsing and writing custom Change_Tracking HTML Tags are supported. Supported HTML Tag : insert / delete. Supported HTML Tag Attribytes : data-username / data-time.

Parameters:: value - boolean

getHTMLSentenceIdentifier

public boolean getHTMLSentenceIdentifier()

Gets a value specifying whether to add identifier to a sentence when writing to HTML. Writed HTML Attribyte : sentence. Writed HTML Value Of Attribyte : start / end / (start,end).

Returns:: boolean

setHTMLSentenceIdentifier

public void setHTMLSentenceIdentifier(boolean value)

Sets a value specifying whether to add identifier to a sentence when writing to HTML. Writed HTML Attribyte : sentence. Writed HTML Value Of Attribyte : start / end / (start,end).

Parameters:: value - boolean value

getHTMLCustomComment

public boolean getHTMLCustomComment()

Gets a value specifying whether parsing and writing comment of document in HTML. Supported HTML Tag : span ,when the value of class attribute is comment Supported HTML Tag Attribytes : data-comment / data-user / data-cid / data-date.

Returns:: boolean

setHTMLCustomComment

public void setHTMLCustomComment(boolean value)

Sets a value specifying whether parsing and writing comment of document in HTML. Supported HTML Tag : span ,when the value of class attribute is comment Supported HTML Tag Attribytes : data-comment / data-user / data-cid / data-date.

Parameters:: value - boolean value

getHTMLIdentifierPunctuations

public java.util.List getHTMLIdentifierPunctuations()

Gets the custom punctuation as sentence indentifier. Full stop, qusetion mark, exclamatory mark are default values.

Returns:: java.util.List

setHTMLIdentifierPunctuations

public void setHTMLIdentifierPunctuations(java.util.List value)

Sets the custom punctuation as sentence indentifier. Full stop, qusetion mark, exclamatory mark are default values.

Parameters:: value - List

getFootnotes

public java.util.List<Footnote> getFootnotes()

Gets document footnotes.

Returns:: List

getEndnotes

public java.util.List<Footnote> getEndnotes()

Gets document endnotes.

Returns:: list of Footnote

getDocumentObjectType

public DocumentObjectType getDocumentObjectType()

Gets the type of the document object.

Specified by:: getDocumentObjectType in interface IDocumentObject
Specified by:: getDocumentObjectType in class DocumentObject

Returns:: DocumentObjectType

getBuiltinDocumentProperties

public BuiltinDocumentProperties getBuiltinDocumentProperties()

Gets document built-in properties object.

Specified by:: getBuiltinDocumentProperties in interface IDocument

Returns:: BuiltinDocumentProperties

getCustomDocumentProperties

public CustomDocumentProperties getCustomDocumentProperties()

Gets document custom properties object.

Specified by:: getCustomDocumentProperties in interface IDocument

Returns:: CustomDocumentProperties

getSections

public SectionCollection getSections()

Gets document sections.

Specified by:: getSections in interface IDocument

Returns:: SectionCollection

getStyles

public StyleCollection getStyles()

Gets document styles

Specified by:: getStyles in interface IDocument

Returns:: StyleCollection

getListStyles

public ListStyleCollection getListStyles()

Gets document list styles.

Specified by:: getListStyles in interface IDocument

Returns:: ListStyleCollection

getBookmarks

public BookmarkCollection getBookmarks()

Gets document bookmarks.

Specified by:: getBookmarks in interface IDocument

Returns:: BookmarkCollection

getFields

public FieldCollection getFields()

Gets fields of the documnet.

Returns:: FieldCollection

getComments

public CommentsCollection getComments()

Gets comments item of the document.

Specified by:: getComments in interface IDocument

Returns:: CommentsCollection

getTextBoxes

public TextBoxCollection getTextBoxes()

Get textbox items of main document

Specified by:: getTextBoxes in interface IDocument

Returns:: TextBoxCollection

setTextBoxes

public void setTextBoxes(TextBoxCollection value)

Set textbox items of main document

Parameters:: value - TextBoxCollection

getLastSection

public Section getLastSection()

Gets last section of the document.

Specified by:: getLastSection in interface IDocument

Returns:: Section

getLastParagraph

public Paragraph getLastParagraph()

Gets last section object.

Specified by:: getLastParagraph in interface IDocument

Returns:: Paragraph

getEndnoteOptions

public FootEndnoteOptions getEndnoteOptions()

Gets options that control numbering and positioning of endnotes in this document.

Returns:: FootEndnoteOptions

getFootnoteOptions

public FootEndnoteOptions getFootnoteOptions()

Gets options that control numbering and positioning of footnotes in this document.

Returns:: FootEndnoteOptions

getWatermark

public WatermarkBase getWatermark()

Gets document's watermark.

Specified by:: getWatermark in interface IDocument

Returns:: WatermarkBase

setWatermark

public void setWatermark(WatermarkBase value)

Sets document's watermark.

Specified by:: setWatermark in interface IDocument

Parameters:: value - WatermarkBase

setWatermark

public void setWatermark(PictureWatermark value,
                         int sectionIndex)

Sets document's Picturewatermark.

Parameters:: value -; sectionIndex -

getBackground

public Background getBackground()

Gets document's background

Specified by:: getBackground in interface IDocument

Returns:: Background

getMailMerge

public MailMerge getMailMerge()

Gets mail merge engine.

Specified by:: getMailMerge in interface IDocument

Returns:: the mail merge object.

getProtectionType

public ProtectionType getProtectionType()

Gets the type of protection of the document.

Specified by:: getProtectionType in interface IDocument

Returns:: ProtectionType

setProtectionType

public void setProtectionType(ProtectionType value)

Sets the type of protection of the document.

Specified by:: setProtectionType in interface IDocument

Parameters:: value - ProtectionType

getViewSetup

public ViewSetup getViewSetup()

Gets view setup options in Microsoft word.

Specified by:: getViewSetup in interface IDocument

Returns:: ViewSetup

getQuiteMode

public boolean getQuiteMode()

Gets whether is quite mode.

Returns:: boolean

setQuiteMode

public void setQuiteMode(boolean value)

Sets whether is quite mode.

Parameters:: value - boolean

getChildObjects

public DocumentObjectCollection getChildObjects()

Gets the child entities.

Specified by:: getChildObjects in interface ICompositeObject
Specified by:: getChildObjects in class DocumentObject

Returns:: The child entities

getXHTMLValidateOption

public XHTMLValidationType getXHTMLValidateOption()

Gets the HTML validate option.the default value is None.

Returns:: The HTML validate option.

setXHTMLValidateOption

public void setXHTMLValidateOption(XHTMLValidationType value)

Sets the HTML validate option.the default value is None.

Parameters:: value - The HTML validate option.

getVariables

public VariableCollection getVariables()

Gets the document variables.

Specified by:: getVariables in interface IDocument

Returns:: The variables.

getProperties

public DocumentProperties getProperties()

Gets the document properties.

Specified by:: getProperties in interface IDocument

Returns:: The properties.

hasChanges

public boolean hasChanges()

Gets a value indicating whether the document has tracked changes.

Specified by:: hasChanges in interface IDocument

Returns:: if the document has tracked changes, set to true

getTrackChanges

public boolean getTrackChanges()

Gets a value indicating whether tracking changes is turn on.

Returns:: if track changes in on, set to true

setTrackChanges

public void setTrackChanges(boolean value)

Sets a value indicating whether tracking changes is turn on.

Parameters:: value - if track changes in on, set to true

getAutoUpdateStylesByTemplate

public boolean getAutoUpdateStylesByTemplate()

Gets a value indicating whether updating the styles in this document to match the styles in the attached template each time you open . if update document styles automatically, set to true.

setAutoUpdateStylesByTemplate

public void setAutoUpdateStylesByTemplate(boolean value)

Sets a value indicating whether updating the styles in this document to match the styles in the attached template each time you open . if update document styles automatically, set to true.

getReplaceFirst

public boolean getReplaceFirst()

Gets a value indicating whether need first replacing.

Returns:: True indciates need first replacing.

setReplaceFirst

public void setReplaceFirst(boolean value)

Sets a value indicating whether need first replacing.

Parameters:: value - True indciates need first replacing.

getHtmlExportOptions

public HtmlExportOptions getHtmlExportOptions()

Gets the save options.

Returns:: The save options.

isUpdateFields

public boolean isUpdateFields()

Gets a value indicating whether to update fields in the document.

Specified by:: isUpdateFields in interface IDocument

Returns:: boolean

isUpdateFields

public void isUpdateFields(boolean value)

Sets a value indicating whether to update fields in the document.

Specified by:: isUpdateFields in interface IDocument

Parameters:: value - if update fields, set to true

getDetectedFormatType

public FileFormat getDetectedFormatType()

Returns the detected format type of the document which was loaded. .

Returns:: FileFormat

getJPEGQuality

public int getJPEGQuality()

Gets the quality (Q%) of the image of JPEG format, this property is only used for doc to pdf. The default value is 80.

Returns:: int

setJPEGQuality

public void setJPEGQuality(int value)

sets the quality (Q%) of the image of JPEG format, this property is only used for doc to pdf. The default value is 80.

Parameters:: value - int

getUrlConnectTimeOut

public int getUrlConnectTimeOut()

setUrlConnectTimeOut

public void setUrlConnectTimeOut(int value)

set timeout. default value = 3000ms

Parameters:: value -

getPageCount

public int getPageCount()

Gets total number of pages for document.

Returns:: int

getPrintDocument

public PrintDocument getPrintDocument()

isContainMacro

public boolean isContainMacro()

Indicates whether the document has macros.

Returns:: booelan

getKeepSameFormat

public boolean getKeepSameFormat()

Gets a value that indicates whether to keep same formatting when it is merged to other document.

Returns:: boolean

setKeepSameFormat

public void setKeepSameFormat(boolean value)

Sets a value that indicates whether to keep same formatting when it is merged to other document.

Parameters:: value - boolean

createParagraph

public Paragraph createParagraph()

Creates the paragraph.

Specified by:: createParagraph in interface IDocument

Returns:

createMinialDocument

public void createMinialDocument()

Create a minial document, one empty section to the document and one empty paragraph to created section.

Specified by:: createMinialDocument in interface IDocument

addSection

public Section addSection()

Adds new section to document.

Specified by:: addSection in interface IDocument

Returns:

addParagraphStyle

public ParagraphStyle addParagraphStyle(java.lang.String styleName)

Adds new paragraph style to the document.

Specified by:: addParagraphStyle in interface IDocument

Parameters:: styleName - Paragraph style name
Returns:

addListStyle

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

Adds new list style to document.

Specified by:: addListStyle in interface IDocument

Parameters:: listType - List type; styleName - Paragraph style name
Returns:

getText

public java.lang.String getText()

Gets the document's text.

Specified by:: getText in interface IDocument

Returns:: String

sign

public static byte[] sign(java.io.InputStream sourceStream,
                          java.lang.String certificatePath,
                          java.lang.String securePassword)

Create digitally signed word document. Digital signature of documents support only DOC and DOCX formats.

Parameters:: sourceStream - Source file stream; certificatePath - Path to the file certificate; securePassword - Password of the certificate.
Returns:: Bytes of signed word document

sign

public static byte[] sign(java.io.InputStream sourceStream,
                          byte[] certificateData,
                          java.lang.String securePassword)

Create digitally signed word document. Digital signature of documents support only DOC and DOCX formats.

Parameters:: sourceStream - Source file stream.; certificateData - the certificate data.; securePassword - Password of the certificate.
Returns:: Bytes of signed word document

deepClone

public Document deepClone()

Clones itself.

Specified by:: deepClone in interface IDocument
Specified by:: deepClone in interface IDocumentObject
Overrides:: deepClone in class DocumentObject

Returns:

cloneDefaultStyleTo

public void cloneDefaultStyleTo(Document destDoc)

Clones the current document default style to the destination document.

Parameters:: destDoc -

cloneThemesTo

public void cloneThemesTo(Document destDoc)

Clones the current document theme style to the destination document.

Parameters:: destDoc - The destination document.

cloneCompatibilityTo

public void cloneCompatibilityTo(Document destDoc)

Clones the current document compatibility to the destination document.

Parameters:: destDoc - The destination document.

cloneSettingsTo

public void cloneSettingsTo(Document destDoc)

Clones the current document settings to the destination document.

Parameters:: destDoc - The destination document.

importSection

public void importSection(ISection section)

Imports section into document.

Parameters:: section - The section.

importContent

public void importContent(IDocument doc)

Imports all content into the document.

Specified by:: importContent in interface IDocument

Parameters:: doc - IDocument

importContent

public void importContent(IDocument doc,
                          boolean importStyles)

Imports all content into document.

Specified by:: importContent in interface IDocument

Parameters:: doc - IDocument; importStyles -

addStyle

public Style addStyle(BuiltinStyle builtinStyle)

Adds the style to the document style.

Specified by:: addStyle in interface IDocument

Parameters:: builtinStyle - BuiltinStyle
Returns:

acceptChanges

public void acceptChanges()

Accepts changes tracked from the moment of last change acceptance.

rejectChanges

public void rejectChanges()

Rejects changes tracked from the moment of last change acceptance.

checkProtectionPassWord

public boolean checkProtectionPassWord(java.lang.String password)

Check that the password entered is the same as the permission protection password

Parameters:: password - The enter password
Returns:: whether the password entered is the same as the permission protection password

protect

public void protect(ProtectionType type)

Protects the document.

Specified by:: protect in interface IDocument

Parameters:: type - ProtectionType

protect

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

Protects the document.

Specified by:: protect in interface IDocument

Parameters:: type - The type of the protection; password - The password used for protection.

isEncrypted

public static boolean isEncrypted(java.lang.String fileName)

Check that the document is encrypted

Parameters:: fileName - File name
Returns:: whether the document is encrypted

isEncrypted

public static boolean isEncrypted(java.io.InputStream stream)

Check that the document is encrypted

Parameters:: stream - stream
Returns:: whether the document is encrypted

encrypt

public void encrypt(java.lang.String password)

Encrypts the document.

Specified by:: encrypt in interface IDocument

Parameters:: password - Password.

removeEncryption

public void removeEncryption()

Removes the encryption.

Specified by:: removeEncryption in interface IDocument

printMultipageToOneSheet

public void printMultipageToOneSheet(PagesPreSheet pagesPerSheet)

Print multipage to one sheet

Parameters:: pagesPerSheet - The number of pages per one sheet.

printMultipageToOneSheet

public void printMultipageToOneSheet(PagesPreSheet pagesPerSheet,
                                     boolean printPageBorders)

Print multipage to one sheet

Parameters:: pagesPerSheet - The number of pages per one sheet.; printPageBorders - The flag that indicates whether printed the page borders.

saveToTxt

public void saveToTxt(java.lang.String fileName,
                      java.nio.charset.Charset charset)

Saves to text document with specified encoding.

Parameters:: fileName - Name of the file.; charset - The charset.

loadText

public void loadText(java.lang.String fileName)

Opens the text document from a file with default encoding utf-8.

Parameters:: fileName - Name of the file.

loadText

public void loadText(java.io.InputStream stream)

Opens the text document from a stream with default encoding utf-8.

Parameters:: stream - The stream.

loadText

public void loadText(java.lang.String fileName,
                     java.nio.charset.Charset charset)

Opens the text document with specified encoding from a file.

Parameters:: fileName - Name of the file.; charset - The encoding

loadText

public void loadText(java.io.InputStream stream,
                     java.nio.charset.Charset charset)

Opens the text document with specified encoding from a stream.

Parameters:: stream - The text document stream.; charset - The encoding

loadFromFile

public void loadFromFile(java.lang.String fileName)

Opens doc file.

Specified by:: loadFromFile in interface IDocument

Parameters:: fileName -

loadFromFile

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

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

Specified by:: loadFromFile in interface IDocument

Parameters:: fileName -; fileFormat -

loadFromFile

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

Opens the HTML document from stream .

Parameters:: fileName - Name of the file.; fileFormat - Type of the format.; validationType - Type of the validation.

loadFromFile

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

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

Parameters:: fileName - Name of the file.; fileFormat - Type of the format.; password - The password.

loadFromFileInReadMode

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

LoadFromStream new document in read-only mode.

Specified by:: loadFromFileInReadMode in interface IDocument

Parameters:: strFileName - File to open.; fileFormat - Type of the format.

loadRtf

public void loadRtf(java.lang.String fileName)

Opens the rtf document from a file.

Parameters:: fileName - Name of the file.

loadRtf

public void loadRtf(java.io.InputStream stream)

loadRtf

public void loadRtf(java.lang.String fileName,
                    com.spire.ms.System.Text.Encoding encoding)

Opens the rtf document with specified encoding from a file.

Parameters:: fileName - Name of the file.; encoding - The encoding

loadRtf

public void loadRtf(java.io.InputStream stream,
                    com.spire.ms.System.Text.Encoding encoding)

Opens the rtf document with specified encoding from a stream.

Parameters:: stream - The rtf document stream.; encoding - The encoding

saveToFile

public void saveToFile(java.lang.String fileName)

Saves to file in Microsoft Word format.

Specified by:: saveToFile in interface IDocument

Parameters:: fileName -

saveToFile

public void saveToFile(java.lang.String fileName,
                       ToPdfParameterList paramList)

Saves the document to PDF file.

Parameters:: fileName - File name; paramList - Parameter list

saveToEpub

public void saveToEpub(java.lang.String fileName,
                       DocPicture coverImage)

Saves the EPUB document.

Parameters:: fileName - The file name.; coverImage - The cover image.

saveToEpub

public void saveToEpub(com.spire.ms.System.IO.Stream stream,
                       DocPicture coverImage)

aves the EPUB document.

Parameters:: stream - The stream.; coverImage - The cover image.

insertTextFromFile

public void insertTextFromFile(java.lang.String fileName,
                               FileFormat fileFormat)

Insert text from a file.

Parameters:: fileName - File name; fileFormat - Type of the format

insertTextFromStream

public void insertTextFromStream(java.io.InputStream stream,
                                 FileFormat fileFormat)

Insert text from stream.

Parameters:: stream - The stream.; fileFormat - Type of the format

saveToFile

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

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

Specified by:: saveToFile in interface IDocument

Parameters:: fileName - File name; fileFormat - Type of the format

saveToFile

public void saveToFile(java.lang.String fileName,
                       FileFormat fileFormat,
                       com.spire.ms.System.Net.HttpWebResponse response,
                       HttpContentType contentType)

Saves the specified file name.

Parameters:: fileName - Name of the file.; fileFormat - Type of the format.; response - The response.; contentType - The content disposition.

saveToSVG

public void saveToSVG(java.lang.String fileName)

Saves the SVG.

Parameters:: fileName - The file name.

saveToSVG

public void saveToSVG(java.lang.String fileName,
                      boolean outputToOneSvg)

Saves the SVG.

Parameters:: fileName - The file name.; outputToOneSvg - Output to one Svg.

saveToSVG

public java.util.List<byte[]> saveToSVG()

Saves the SVG.

Returns:

saveToSVG

public java.util.List<byte[]> saveToSVG(boolean outputToOneSvg)

Saves the SVG.

Returns:: Queue

saveToStream

public void saveToStream(java.io.OutputStream stream,
                         ToPdfParameterList paramList)

Saves document to stream and digitally sign, Only DOC and DOCX are supported.

Parameters:: stream - The stream.; paramList -

loadFromStream

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

Opens the HTML document from stream .

Parameters:: stream - The stream.; fileFormat - Type of the format.; validationType - Type of the validation.

loadFromStream

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

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

Specified by:: loadFromStream in interface IDocument

Parameters:: stream - stream; fileFormat - fileFormat

loadFromStream

public void loadFromStream(java.io.InputStream stream,
                           FileFormat fileFormat,
                           java.lang.String password)

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

Parameters:: stream - The stream.; fileFormat - Type of the format.; password - The password.

saveToStream

public void saveToStream(java.io.OutputStream stream,
                         FileFormat fileFormat,
                         java.lang.String certificatePath,
                         java.lang.String securePassword)

Saves document to stream and digitally sign, Only DOC and DOCX are supported.

Parameters:: stream - The stream.; fileFormat - The file format.; certificatePath - Path to the file certificate; securePassword - Password of the certificate.

saveToStream

public void saveToStream(java.io.OutputStream stream,
                         FileFormat fileFormat,
                         byte[] certificateData,
                         java.lang.String securePassword)

Saves document to stream and digitally sign, Only DOC and DOCX are supported.

Parameters:: stream - The stream.; fileFormat - The file format.; certificateData - The certificate data.; securePassword - Password of the certificate.

saveToFile

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

Saves document to file and digitally sign, Only DOC and DOCX are supported.

Parameters:: fileName - The file.; fileFormat - The file format.; certificatePath - Path to the file certificate; securePassword - Password of the certificate.

saveToFile

public void saveToFile(java.lang.String fileName,
                       FileFormat fileFormat,
                       byte[] certificateData,
                       java.lang.String securePassword)

Saves document to file and digitally sign, Only DOC and DOCX are supported.

Parameters:: fileName - The file.; fileFormat - The file format.; certificateData - The certificate data.; securePassword - Password of the certificate.

saveToStream

public void saveToStream(java.io.OutputStream stream,
                         FileFormat fileFormat)

Saves the document into stream in Xml or Microsoft Word format.

Parameters:: stream - The output stream; fileFormat - The file format

saveToFile

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

Saves the document into stream in Xml or Microsoft Word format.

Specified by:: saveToFile in interface IDocument

Parameters:: stream -; fileFormat -

close

public void close()

Closes this instance.

Overrides:: close in class DocumentBase

dispose

public void dispose()

Prerforms application-defined tasks associated with freeing,releasing, or resetting unmanaged resources.

saveToTiff

public void saveToTiff(java.lang.String tiffFilename)

save doc to tiff. lzw mode.

Parameters:: tiffFilename -

saveToImages

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

Save the whole document into images

Specified by:: saveToImages in interface IDocument

Parameters:: type - The ImageType
Returns:: the bufferedImages

saveToImages

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

Description copied from interface: IDocument

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.

Specified by:: saveToImages in interface IDocument

Parameters:: pageIndex - zero based page index; type - the ImageType
Returns:: the bufferedImages

saveToImages

public java.awt.image.BufferedImage[] saveToImages(int pageIndex,
                                                   int pageCount,
                                                   ImageType type,
                                                   int dpiX,
                                                   int dpiY)

Save the specified range of pages into images

Parameters:: pageIndex - Starting page index (Zero based); pageCount - Number of pages; type - The ImageType; dpiX - The resolution of X; dpiY - The resolution of Y
Returns:: the bufferedImages

findPattern

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

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

Specified by:: findPattern in interface IDocument

Parameters:: pattern - regex pattern
Returns:: Found text selection

findPatternInLine

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

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

Specified by:: findPatternInLine in interface IDocument

Parameters:: pattern - The pattern.
Returns:: list of TextSelection

findString

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

Finds and returns string along with formatting.

Specified by:: findString in interface IDocument

Parameters:: stringValue -; caseSensitive -; wholeWord -
Returns:

findStringInLine

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

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

Specified by:: findStringInLine in interface IDocument

Parameters:: given - The string to find.; caseSensitive - if set to true use case sensitive search.; wholeWord - if it search the whole word, set to true.
Returns:

findAllPattern

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

Returns all entries of matchString regex.

Specified by:: findAllPattern in interface IDocument

Parameters:: pattern - The pattern
Returns:: list of TextSelection

findAllPattern

public TextSelection[] findAllPattern(java.util.regex.Pattern pattern,
                                      boolean isAdvancedSearch)

Returns all entries of matchString regex.

Parameters:: pattern - The pattern; isAdvancedSearch - whether is advanced search. You can find "str" in more than one paragraph.
Returns:: list of TextSelection

findAllString

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

Returns all entries of matchString string, taking into consideration caseSensitive and wholeWord options.

Specified by:: findAllString in interface IDocument

Parameters:: matchString -; caseSensitive -; wholeWord -
Returns:

replace

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

Replaces all entries of matchString regular expression with newValue string.

Specified by:: replace in interface IDocument

Parameters:: pattern - pattern; replace - replace
Returns:: int

replace

public int replace(java.lang.String matchString,
                   java.lang.String newValue,
                   boolean caseSensitive,
                   boolean wholeWord)

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

Specified by:: replace in interface IDocument

Parameters:: matchString -; newValue -; caseSensitive -; wholeWord -
Returns:

replace

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

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

Specified by:: replace in interface IDocument

Parameters:: matchString - The matchString.; textSelection - The text selection.; caseSensitive - if it is case sensitive, set to true.; wholeWord - if it specifies whole word, set to true.
Returns:

replace

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

.Replaces all entries of matchString regular expression with TextRangesHolder.

Specified by:: replace in interface IDocument

Parameters:: pattern - The pattern.; textSelection - The text selection.
Returns:: int

cloneWebSettingsTo

public void cloneWebSettingsTo(Document destDoc)

clone Websettings to other document

Parameters:: destDoc - The other doc

replace

public int replace(java.lang.String matchString,
                   IDocument matchDoc,
                   boolean caseSensitive,
                   boolean wholeWord)

Replaces the specified matchString.

Parameters:: matchString - The matchString.; matchDoc - The newValue doc.; caseSensitive - if it is case sensitive, set to true.; wholeWord - if specifies whole word,set to true.
Returns:

updateWordCount

public void updateWordCount()

Update Paragraphs count, Word count and Character count

Specified by:: updateWordCount in interface IDocument

updateWordCount

public void updateWordCount(char[] splitchar)

Update Paragraphs count, Word count and Character count.

Parameters:: splitchar - The word separator.

updateWordCount

public void updateWordCount(char[] splitchar,
                            boolean includeTbFnEn)

Update Paragraphs count, Word count and Character count.

Parameters:: splitchar - The word separator.; includeTbFnEn - The include text boxes,footnotes and endnotes.

getPageCountEx

public int getPageCountEx()

Gets total number of pages for document.

Returns:

updateTableOfContents

public void updateTableOfContents()

Update Table of contents in the document.

updateTableOfContents

public void updateTableOfContents(TableOfContent toc)

Update specified Table of content in the document.

Parameters:: toc -

updateTOCPageNumbers

public void updateTOCPageNumbers()

Update Table of contents page numbers in the document.

updateTOCPageNumbers

public void updateTOCPageNumbers(TableOfContent toc)

Update specified Table of content page numbers in the document.

Parameters:: toc - specified Table of content

compare

public void compare(Document document,
                    java.lang.String author)

Compares this document with another document.

Parameters:: document - Document to compare; author - The author to use for revisions

compare

public void compare(Document document,
                    java.lang.String author,
                    CompareOptions options)

Compares this document with another document.

Parameters:: document - Document to compare; author - The author to use for revisions; options - The comparison parameter

compare

public void compare(Document document,
                    java.lang.String author,
                    java.util.Date date)

Compares this document with another document.

Parameters:: document - The document to compare; author - The author to use for revisions; date - The date and time to use for revisions

compare

public void compare(Document document,
                    java.lang.String author,
                    java.util.Date date,
                    CompareOptions options)

Compares this document with another document.

Parameters:: document - The document to compare; author - The author to use for revisions; date - The date and time to use for revisions; options - The comparison parameter

replaceInLine

public int replaceInLine(java.lang.String matchString,
                         java.lang.String newValue,
                         boolean caseSensitive,
                         boolean wholeWord)

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

Specified by:: replaceInLine in interface IDocument

Parameters:: matchString - The matchString.; newValue - The newValue.; caseSensitive - if it specifies case sensative newValue, set to true.; wholeWord - if it specifies only whole word will be replaced, set to true.
Returns:

replaceInLine

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

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

Specified by:: replaceInLine in interface IDocument

Parameters:: pattern - The pattern.; newValue - The newValue.
Returns:: int

replaceInLine

public int replaceInLine(java.lang.String matchString,
                         TextSelection matchSelection,
                         boolean caseSensitive,
                         boolean wholeWord)

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

Specified by:: replaceInLine in interface IDocument

Parameters:: matchString - The matchString.; matchSelection - The matchSelection.; caseSensitive - if it is case sensitive newValue, set to true.; wholeWord - if it replaces only whole word, set to true.
Returns:

replaceInLine

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

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

Specified by:: replaceInLine in interface IDocument

Parameters:: pattern - The pattern.; matchSelection - The matchSelection.
Returns:: The number of performed replaces.

findString

public TextSelection findString(BodyRegion start,
                                java.lang.String matchString,
                                boolean caseSensitive,
                                boolean wholeWord)

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

Specified by:: findString in interface IDocument

Parameters:: start - Search starts.; matchString - The string to find.; caseSensitive - if it specifies case sensitive search, set to true .; wholeWord - if it search for the whole word, set to true .
Returns:

findPattern

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

Finds the next entry of matchString pattern.

Specified by:: findPattern in interface IDocument

Parameters:: start - Search starts; pattern - The pattern.
Returns:: TextSelection

findStringInLine

public TextSelection[] findStringInLine(BodyRegion start,
                                        java.lang.String matchString,
                                        boolean caseSensitive,
                                        boolean wholeWord)

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

Specified by:: findStringInLine in interface IDocument

Parameters:: start - Search start.; matchString - The matchString.; caseSensitive - if it is case sensitive search, set to true.; wholeWord - if it search for whole word, set to true .
Returns:

findPatternInLine

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

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

Specified by:: findPatternInLine in interface IDocument

Parameters:: start - Search start.; pattern - The pattern.
Returns:: list of TextSelection

resetFindState

public void resetFindState()

Resets the FindPattern.

Specified by:: resetFindState in interface IDocument

createParagraphItem

public ParagraphBase createParagraphItem(ParagraphItemType itemType)

Creates new paragraph item instance.

Parameters:: itemType - Paragraph item type
Returns:

clearMacros

public void clearMacros()

Removes the macros from the document.

setDateTimeOfUnitTest

public void setDateTimeOfUnitTest(java.util.Date dateTime)

Sets date and time of the unit test. For unit testing use only.

Parameters:: dateTime - The date and time used in the test document.

resetPageLayoutCache

public void resetPageLayoutCache()

Reset the page layout cache data of the new engine.

setCustomFontsFolders

public void setCustomFontsFolders(java.lang.String fontPath)

Set the path to the folder where the custom font is located.

Parameters:: fontPath -

clearCustomFontsFolders

public void clearCustomFontsFolders()

Clear the path of the folder where the custom font is located.

setGlobalCustomFontsFolders

public static void setGlobalCustomFontsFolders(java.lang.String fontPath)

Sets the path to the folder where the global custom font is located.

Parameters:: fontPath - the folder path.

setGlobalCustomFontsFolders

public static void setGlobalCustomFontsFolders(java.io.InputStream[] fontStreamList)

Sets the path to the folder where the global custom font is located.

Parameters:: fontStreamList - The custom font stream array.

clearGlobalCustomFontsFolders

public static void clearGlobalCustomFontsFolders()

Clear the path of the folder where the global custom font is located.

clearSystemFontCache

public static void clearSystemFontCache()

Clears the memory used by cached system fonts.

updatePageLayout

public void updatePageLayout()

Updates the page layout of the document.

updateTableLayout

public void updateTableLayout()

Update table grid before saving the document when using the new engine.

getOriginalFileFormat

public FileFormat getOriginalFileFormat()

cleanup

public void cleanup()

cleanup

public void cleanup(CleanupOptions options)

getForceTableRelayout

public boolean getForceTableRelayout()

Gets or set a value indicating whether force table to relayout..

Returns:

setForceTableRelayout

public void setForceTableRelayout(boolean value)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.spire.doc Class Document

BookmarkLayout

PageLayout

UpdateFields

Document

Document

Document

Document

Document

Document

Document

Document

Document

Document

Document

Document

Document

Document

Document

Document

Document

Document

Document

Document

Document

Document

Document

getTOC

setTOC

getEmbedFontsInFile

setEmbedFontsInFile

getPrivateFontList

getEmbedSystemFonts

setEmbedSystemFonts

loadFontFallbackRuleSettings

saveFontFallbackRuleSettings

getHtmlBaseUrl

setHtmlBaseUrl

getHTMLTrackChanges

setHTMLTrackChanges

getHTMLSentenceIdentifier

setHTMLSentenceIdentifier

getHTMLCustomComment

setHTMLCustomComment

getHTMLIdentifierPunctuations

setHTMLIdentifierPunctuations

getFootnotes

getEndnotes

getDocumentObjectType

getBuiltinDocumentProperties

getCustomDocumentProperties

getSections

getStyles

getListStyles

getBookmarks

getFields

getComments

getTextBoxes

setTextBoxes

getLastSection

getLastParagraph

getEndnoteOptions

getFootnoteOptions

getWatermark

setWatermark

setWatermark

getBackground

getMailMerge

getProtectionType

setProtectionType

getViewSetup

getQuiteMode

setQuiteMode

getChildObjects

getXHTMLValidateOption

setXHTMLValidateOption

getVariables

getProperties

hasChanges

getTrackChanges

com.spire.doc
Class Document