WordProcessingLoadOptions Leave feedback
On this page
Inheritance: java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
All Implemented Interfaces: java.io.Serializable, com.groupdocs.conversion.options.load.IResourceLoadingOptions, com.groupdocs.conversion.options.load.IPageNumberingLoadOptions, com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
public class WordProcessingLoadOptions extends LoadOptions implements Serializable, IResourceLoadingOptions, IPageNumberingLoadOptions, IDocumentsContainerLoadOptions
Options for loading WordProcessing documents.
| Constructor | Description |
|---|---|
| WordProcessingLoadOptions() | Initializes new instance of WordProcessingLoadOptions class. |
| Method | Description |
|---|---|
| getFormat() | |
| getDefaultFont() | Default font for Words document. |
| setDefaultFont(String value) | Default font for Words document. |
| getAutoFontSubstitution() | If AutoFontSubstitution is disabled, GroupDocs.Conversion uses the DefaultFont for the substitution of missing fonts. |
| setAutoFontSubstitution(boolean value) | If AutoFontSubstitution is disabled, GroupDocs.Conversion uses the DefaultFont for the substitution of missing fonts. |
| getFontSubstitutes() | Substitute specific fonts when converting Words document. |
| isEmbedTrueTypeFonts() | If EmbedTrueTypeFonts is true, GroupDocs.Conversion embed true type fonts in the output document. |
| setEmbedTrueTypeFonts(boolean embedTrueTypeFonts) | |
| isUpdatePageLayout() | Update page layout after loading. |
| setUpdatePageLayout(boolean updatePageLayout) | |
| isUpdateFields() | Update fields after loading. |
| setUpdateFields(boolean updateFields) | |
| isKeepDateFieldOriginalValue() | Keep original value of date field. |
| setKeepDateFieldOriginalValue(boolean keepDateFieldOriginalValue) | Sets Keep original value of date field. |
| setFontSubstitutes(List |
Substitute specific fonts when converting Words document. |
| getPassword() | Set password to unprotect protected document. |
| setPassword(String value) | Set password to unprotect protected document. |
| getHideWordTrackedChanges() | Hide markup and track changes for Word documents. |
| setHideWordTrackedChanges(boolean value) | Hide markup and track changes for Word documents. |
| setHideComments(boolean value) | Hide comments. |
| getBookmarkOptions() | Bookmarks options |
| setBookmarkOptions(WordProcessingBookmarksOptions value) | Bookmarks options |
| isPreserveFontFields() | Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text. |
| setPreserveFontFields(boolean preserveFontFields) | Sets preserveFontFields flag |
| isUseTextShaper() | Specifies whether to use a text shaper for better kerning display. |
| setUseTextShaper(boolean isUseTextShaper) | Specifies whether to use a text shaper for better kerning display. |
| isPreserveDocumentStructure() | Determines whether the document structure should be preserved when converting to PDF (default is false). |
| setPreserveDocumentStructure(boolean preserveDocumentStructure) | |
| getSkipExternalResources() | {@inheritDoc} |
| setSkipExternalResources(boolean skip) | {@inheritDoc} |
| getWhitelistedResources() | {@inheritDoc} |
| setWhitelistedResources(List |
{@inheritDoc} |
| getCommentDisplayMode() | Specifies how comments should be displayed in the output document. |
| setCommentDisplayMode(WordProcessingCommentDisplay commentDisplayMode) | |
| getShowFullCommenterName() | Show full commenter name in comments. |
| setShowFullCommenterName(boolean showFullCommenterName) | |
| isPageNumbering() | Enable or disable generation of page numbering in converted document. |
| setPageNumbering(boolean isPageNumbering) | |
| getHyphenationOptions() | Gets hyphenation options for WordProcessing documents. |
| setHyphenationOptions(HyphenationOptions hyphenationOptions) | Sets hyphenation options for WordProcessing documents. |
| isInterruptThreadIfImageExceptionThrown() | Gets InterruptThreadIfImageExceptionThrown flag Default: false If true then interrupt the main conversion thread if an exception in a image processing thread occurred |
| setInterruptThreadIfImageExceptionThrown(boolean interruptThreadIfImageExceptionThrown) | Sets InterruptThreadIfImageExceptionThrown flag |
| isAutoDetectRtlDirection() | When enabled (default), paragraphs and runs whose text is dominantly right-to-left (RTL) will have their bidi flags repaired before conversion. |
| setAutoDetectRtlDirection(boolean autoDetectRtlDirection) | Sets the autoDetectRtlDirection |
| isConvertOwner() | |
| setConvertOwner(boolean convertOwner) | |
| isConvertOwned() | |
| setConvertOwned(boolean convertOwned) | |
| getDepth() | |
| setDepth(int depth) |
public WordProcessingLoadOptions()
Initializes new instance of WordProcessingLoadOptions class.
public final WordProcessingFileType getFormat()
Input document file type
Returns: WordProcessingFileType
public final String getDefaultFont()
Default font for Words document. The following font will be used if a font is missing.
Returns: java.lang.String
public final void setDefaultFont(String value)
Default font for Words document. The following font will be used if a font is missing.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
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.
Returns: boolean
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final List<FontSubstitute> getFontSubstitutes()
Substitute specific fonts when converting Words document.
Returns: java.util.List<com.groupdocs.conversion.contracts.FontSubstitute>
public boolean isEmbedTrueTypeFonts()
If EmbedTrueTypeFonts is true, GroupDocs.Conversion embed true type fonts in the output document. Default: false
Returns: boolean
public void setEmbedTrueTypeFonts(boolean embedTrueTypeFonts)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| embedTrueTypeFonts | boolean |
public boolean isUpdatePageLayout()
Update page layout after loading. Default: false
Returns: boolean
public void setUpdatePageLayout(boolean updatePageLayout)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| updatePageLayout | boolean |
public boolean isUpdateFields()
Update fields after loading. Default: false
Returns: boolean
public void setUpdateFields(boolean updateFields)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| updateFields | boolean |
public boolean isKeepDateFieldOriginalValue()
Keep original value of date field. Default: false
Returns: boolean
public void setKeepDateFieldOriginalValue(boolean keepDateFieldOriginalValue)
Sets Keep original value of date field.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| keepDateFieldOriginalValue | boolean |
public final void setFontSubstitutes(List<FontSubstitute> value)
Substitute specific fonts when converting Words document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.util.List<com.groupdocs.conversion.contracts.FontSubstitute> |
public final String getPassword()
Set password to unprotect protected document.
Returns: java.lang.String
public final void setPassword(String value)
Set password to unprotect protected document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
public final boolean getHideWordTrackedChanges()
Hide markup and track changes for Word documents.
Returns: boolean
public final void setHideWordTrackedChanges(boolean value)
Hide markup and track changes for Word documents.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final void setHideComments(boolean value)
Hide comments.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final WordProcessingBookmarksOptions getBookmarkOptions()
Bookmarks options
Returns: WordProcessingBookmarksOptions
public final void setBookmarkOptions(WordProcessingBookmarksOptions value)
Bookmarks options
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | WordProcessingBookmarksOptions |
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: boolean - preserveFontFields flag
public void setPreserveFontFields(boolean preserveFontFields)
Sets preserveFontFields flag
Parameters:
| Parameter | Type | Description |
|---|---|---|
| preserveFontFields | boolean | preserve Microsoft Word form fields as form fields in PDF or convert them to text |
public boolean isUseTextShaper()
Specifies whether to use a text shaper for better kerning display. Default is false.
Returns: boolean
public void setUseTextShaper(boolean isUseTextShaper)
Specifies whether to use a text shaper for better kerning display. Default is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| isUseTextShaper | boolean | isUseTextShaper flag |
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.
Returns: boolean
public void setPreserveDocumentStructure(boolean preserveDocumentStructure)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| preserveDocumentStructure | boolean |
public boolean getSkipExternalResources()
If true all external resource will not be loading with exception of the resources in the
Returns: boolean
public void setSkipExternalResources(boolean skip)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| skip | boolean |
public List<String> getWhitelistedResources()
External resources that will be always loaded
Returns: java.util.List<java.lang.String>
public void setWhitelistedResources(List<String> whiteList)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| whiteList | java.util.List<java.lang.String> |
public WordProcessingCommentDisplay getCommentDisplayMode()
Specifies how comments should be displayed in the output document. Default is ShowInBalloons.
Returns: WordProcessingCommentDisplay
public void setCommentDisplayMode(WordProcessingCommentDisplay commentDisplayMode)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| commentDisplayMode | WordProcessingCommentDisplay |
public boolean getShowFullCommenterName()
Show full commenter name in comments. Default is false.
Returns: boolean
public void setShowFullCommenterName(boolean showFullCommenterName)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| showFullCommenterName | boolean |
public boolean isPageNumbering()
Enable or disable generation of page numbering in converted document. Default: false
Returns: boolean
public void setPageNumbering(boolean isPageNumbering)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| isPageNumbering | boolean |
public HyphenationOptions getHyphenationOptions()
Gets hyphenation options for WordProcessing documents.
Returns: HyphenationOptions
public void setHyphenationOptions(HyphenationOptions hyphenationOptions)
Sets hyphenation options for WordProcessing documents.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| hyphenationOptions | HyphenationOptions |
public boolean isInterruptThreadIfImageExceptionThrown()
Gets InterruptThreadIfImageExceptionThrown flag Default: false If true then interrupt the main conversion thread if an exception in a image processing thread occurred
Returns: boolean
public void setInterruptThreadIfImageExceptionThrown(boolean interruptThreadIfImageExceptionThrown)
Sets InterruptThreadIfImageExceptionThrown flag
Parameters:
| Parameter | Type | Description |
|---|---|---|
| interruptThreadIfImageExceptionThrown | boolean |
public boolean isAutoDetectRtlDirection()
When enabled (default), paragraphs and runs whose text is dominantly right-to-left (RTL) will have their bidi flags repaired before conversion.
This matches the heuristic applied by Microsoft Word and LibreOffice and fixes rendering of Arabic/Hebrew documents produced by generators (notably Google Docs) that emit OOXML without
and with
on runs containing only RTL script.
Set to false to preserve strict OOXML interpretation of the source markup.
Returns: boolean
public void setAutoDetectRtlDirection(boolean autoDetectRtlDirection)
Sets the autoDetectRtlDirection
Parameters:
| Parameter | Type | Description |
|---|---|---|
| autoDetectRtlDirection | boolean | autoDetectRtlDirection |
public boolean isConvertOwner()
Gets option to control whether the documents container itself must be converted
Returns: boolean
public void setConvertOwner(boolean convertOwner)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| convertOwner | boolean |
public boolean isConvertOwned()
Option to control whether the owned documents in the documents container must be converted
Returns: boolean
public void setConvertOwned(boolean convertOwned)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| convertOwned | boolean |
public int getDepth()
Option to control how many levels in depth to perform conversion
Returns: int
public void setDepth(int depth)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| depth | int |
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
