com.groupdocs.conversion.options.load

Class WordProcessingLoadOptions

java.lang.Object

com.groupdocs.conversion.contracts.ValueObject

com.groupdocs.conversion.options.load.LoadOptions

com.groupdocs.conversion.options.load.WordProcessingLoadOptions

All Implemented Interfaces:

com.aspose.ms.System.IEquatable<ValueObject>, com.groupdocs.conversion.options.load.IResourceLoadingOptions, Serializable

public class WordProcessingLoadOptions
extends LoadOptions
implements Serializable, com.groupdocs.conversion.options.load.IResourceLoadingOptions

Options for loading WordProcessing documents.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WordProcessingLoadOptions() Initializes new instance of WordProcessingLoadOptions class.

Method Summary

Modifier and Type	Method and Description
boolean	getAutoFontSubstitution() If AutoFontSubstitution is disabled, GroupDocs.Conversion uses the DefaultFont for the substitution of missing fonts.
WordProcessingBookmarksOptions	getBookmarkOptions() Bookmarks options
String	getDefaultFont() Default font for Words document.
protected List<Object>	getEqualityComponents() Gets equality components.
List<FontSubstitute>	getFontSubstitutes() Substitute specific fonts when converting Words document.
WordProcessingFileType	getFormat() Input document file type
boolean	getHideComments() Hide comments.
boolean	getHideWordTrackedChanges() Hide markup and track changes for Word documents.
String	getPassword() Set password to unprotect protected document.
boolean	getSkipExternalResources() If true all external resource will not be loading with exception of the resources in the
List<String>	getWhitelistedResources() External resources that will be always loaded
boolean	isEmbedTrueTypeFonts() If EmbedTrueTypeFonts is true, GroupDocs.Conversion embed true type fonts in the output document.
boolean	isKeepDateFieldOriginalValue() Keep original value of date field.
boolean	isPreserveDocumentStructure() Determines whether the document structure should be preserved when converting to PDF (default is false).
boolean	isPreserveFontFields() Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text.
boolean	isUpdateFields() Update fields after loading.
boolean	isUpdatePageLayout() Update page layout after loading.
boolean	isUseTextShaper() Specifies whether to use a text shaper for better kerning display.
void	setAutoFontSubstitution(boolean value) If AutoFontSubstitution is disabled, GroupDocs.Conversion uses the DefaultFont for the substitution of missing fonts.
void	setBookmarkOptions(WordProcessingBookmarksOptions value) Bookmarks options
void	setDefaultFont(String value) Default font for Words document.
void	setEmbedTrueTypeFonts(boolean embedTrueTypeFonts)
void	setFontSubstitutes(List<FontSubstitute> value) Substitute specific fonts when converting Words document.
void	setHideComments(boolean value) Hide comments.
void	setHideWordTrackedChanges(boolean value) Hide markup and track changes for Word documents.
void	setKeepDateFieldOriginalValue(boolean keepDateFieldOriginalValue) Sets Keep original value of date field.
void	setPassword(String value) Set password to unprotect protected document.
void	setPreserveDocumentStructure(boolean preserveDocumentStructure)
void	setPreserveFontFields(boolean preserveFontFields) Sets preserveFontFields flag
void	setSkipExternalResources(boolean skip)
void	setUpdateFields(boolean updateFields)
void	setUpdatePageLayout(boolean updatePageLayout)
void	setUseTextShaper(boolean isUseTextShaper) Specifies whether to use a text shaper for better kerning display.
void	setWhitelistedResources(List<String> whiteList)

Methods inherited from class com.groupdocs.conversion.options.load.LoadOptions

setFormat

Methods inherited from class com.groupdocs.conversion.contracts.ValueObject

equals, equals, hashCode, op_Equality, op_Inequality

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WordProcessingLoadOptions

public WordProcessingLoadOptions()

Initializes new instance of WordProcessingLoadOptions class.

Method Detail

getAutoFontSubstitution

public final boolean getAutoFontSubstitution()

If AutoFontSubstitution is disabled, GroupDocs.Conversion uses the DefaultFont for the substitution of missing fonts. If AutoFontSubstitution is enabled, GroupDocs.Conversion evaluates all the related fields in FontInfo (Panose, Sig etc) for the missing font and finds the closest match among the available font sources. Note that font substitution mechanism will override the DefaultFont in cases when FontInfo for the missing font is available in the document. The default value is True.

getBookmarkOptions

public final WordProcessingBookmarksOptions getBookmarkOptions()

Bookmarks options

getDefaultFont

public final String getDefaultFont()

Default font for Words document. The following font will be used if a font is missing.

getEqualityComponents

protected List<Object> getEqualityComponents()

Description copied from class: ValueObject

Gets equality components.

Specified by:

getEqualityComponents in class ValueObject

Returns:

Collection of objects.

getFontSubstitutes

public final List<FontSubstitute> getFontSubstitutes()

Substitute specific fonts when converting Words document.

getFormat

public final WordProcessingFileType getFormat()

Description copied from class: LoadOptions

Input document file type

Overrides:

getFormat in class LoadOptions

getHideComments

public final boolean getHideComments()

Hide comments.

getHideWordTrackedChanges

public final boolean getHideWordTrackedChanges()

Hide markup and track changes for Word documents.

getPassword

public final String getPassword()

Set password to unprotect protected document.

getSkipExternalResources

public boolean getSkipExternalResources()

If true all external resource will not be loading with exception of the resources in the

Specified by:

getSkipExternalResources in interface com.groupdocs.conversion.options.load.IResourceLoadingOptions

getWhitelistedResources

public List<String> getWhitelistedResources()

External resources that will be always loaded

Specified by:

getWhitelistedResources in interface com.groupdocs.conversion.options.load.IResourceLoadingOptions

isEmbedTrueTypeFonts

public boolean isEmbedTrueTypeFonts()

If EmbedTrueTypeFonts is true, GroupDocs.Conversion embed true type fonts in the output document. Default: false

isKeepDateFieldOriginalValue

public boolean isKeepDateFieldOriginalValue()

Keep original value of date field. Default: false

isPreserveDocumentStructure

public boolean isPreserveDocumentStructure()

Determines whether the document structure should be preserved when converting to PDF (default is false). Note that exporting the document structure significantly increases the memory consumption, especially for the large documents.

isPreserveFontFields

public boolean isPreserveFontFields()

Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text. Default is false.

Returns:

preserveFontFields flag

isUpdateFields

public boolean isUpdateFields()

Update fields after loading. Default: false

isUpdatePageLayout

public boolean isUpdatePageLayout()

Update page layout after loading. Default: false

isUseTextShaper

public boolean isUseTextShaper()

Specifies whether to use a text shaper for better kerning display. Default is false.

setAutoFontSubstitution

public final void setAutoFontSubstitution(boolean value)

If AutoFontSubstitution is disabled, GroupDocs.Conversion uses the DefaultFont for the substitution of missing fonts. If AutoFontSubstitution is enabled, GroupDocs.Conversion evaluates all the related fields in FontInfo (Panose, Sig etc) for the missing font and finds the closest match among the available font sources. Note that font substitution mechanism will override the DefaultFont in cases when FontInfo for the missing font is available in the document. The default value is True.

setBookmarkOptions

public final void setBookmarkOptions(WordProcessingBookmarksOptions value)

Bookmarks options

setDefaultFont

public final void setDefaultFont(String value)

Default font for Words document. The following font will be used if a font is missing.

setEmbedTrueTypeFonts

public void setEmbedTrueTypeFonts(boolean embedTrueTypeFonts)

setFontSubstitutes

public final void setFontSubstitutes(List<FontSubstitute> value)

Substitute specific fonts when converting Words document.

setHideComments

public final void setHideComments(boolean value)

Hide comments.

setHideWordTrackedChanges

public final void setHideWordTrackedChanges(boolean value)

Hide markup and track changes for Word documents.

setKeepDateFieldOriginalValue

public void setKeepDateFieldOriginalValue(boolean keepDateFieldOriginalValue)

Sets Keep original value of date field.

setPassword

public final void setPassword(String value)

Set password to unprotect protected document.

setPreserveDocumentStructure

public void setPreserveDocumentStructure(boolean preserveDocumentStructure)

setPreserveFontFields

public void setPreserveFontFields(boolean preserveFontFields)

Sets preserveFontFields flag

Parameters:

preserveFontFields - preserve Microsoft Word form fields as form fields in PDF or convert them to text

setSkipExternalResources

public void setSkipExternalResources(boolean skip)

Specified by:

setSkipExternalResources in interface com.groupdocs.conversion.options.load.IResourceLoadingOptions

setUpdateFields

public void setUpdateFields(boolean updateFields)

setUpdatePageLayout

public void setUpdatePageLayout(boolean updatePageLayout)

setUseTextShaper

public void setUseTextShaper(boolean isUseTextShaper)

Specifies whether to use a text shaper for better kerning display. Default is false.

Parameters:

isUseTextShaper - isUseTextShaper flag

setWhitelistedResources

public void setWhitelistedResources(List<String> whiteList)

Specified by:

setWhitelistedResources in interface com.groupdocs.conversion.options.load.IResourceLoadingOptions