wordprocessingloadoptions

Packages

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>, Serializable
```
public class WordProcessingLoadOptions
extends LoadOptions
implements Serializable
```
Options for loading WordProcessing documents.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

WordProcessingLoadOptions()
Initializes new instance of WordProcessingLoadOptions class.

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

Method Summary

All Methods Instance Methods Concrete Methods
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.
`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`	`isEmbedTrueTypeFonts()` If EmbedTrueTypeFonts is true, GroupDocs.Conversion embed true type fonts in the output document.
`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`	`setPassword(String value)` Set password to unprotect protected document.
`void`	`setPreserveFontFields(boolean preserveFontFields)` Sets preserveFontFields flag
`void`	`setUpdateFields(boolean updateFields)`
`void`	`setUpdatePageLayout(boolean updatePageLayout)`
`void`	`setUseTextShaper(boolean isUseTextShaper)` Specifies whether to use a text shaper for better kerning display.

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
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WordProcessingLoadOptions
```
public WordProcessingLoadOptions()
```
    Initializes new instance of WordProcessingLoadOptions class.
- Method Detail
  - getFormat
```
public final WordProcessingFileType getFormat()
```
    Description copied from class: LoadOptions
    
    Input document file type
    
    Overrides:
    
    getFormat in class LoadOptions
  - getDefaultFont
```
public final String getDefaultFont()
```
    Default font for Words document. The following font will be used if a font is missing.
  - setDefaultFont
```
public final void setDefaultFont(String value)
```
    Default font for Words document. The following font will be used if a font is missing.
  - 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.
  - 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.
  - getFontSubstitutes
```
public final List<FontSubstitute> getFontSubstitutes()
```
    Substitute specific fonts when converting Words document.
  - isEmbedTrueTypeFonts
```
public boolean isEmbedTrueTypeFonts()
```
    If EmbedTrueTypeFonts is true, GroupDocs.Conversion embed true type fonts in the output document. Default: false
  - setEmbedTrueTypeFonts
```
public void setEmbedTrueTypeFonts(boolean embedTrueTypeFonts)
```
  - isUpdatePageLayout
```
public boolean isUpdatePageLayout()
```
    Update page layout after loading. Default: false
  - setUpdatePageLayout
```
public void setUpdatePageLayout(boolean updatePageLayout)
```
  - isUpdateFields
```
public boolean isUpdateFields()
```
    Update fields after loading. Default: false
  - setUpdateFields
```
public void setUpdateFields(boolean updateFields)
```
  - setFontSubstitutes
```
public final void setFontSubstitutes(List<FontSubstitute> value)
```
    Substitute specific fonts when converting Words document.
  - getPassword
```
public final String getPassword()
```
    Set password to unprotect protected document.
  - setPassword
```
public final void setPassword(String value)
```
    Set password to unprotect protected document.
  - getHideWordTrackedChanges
```
public final boolean getHideWordTrackedChanges()
```
    Hide markup and track changes for Word documents.
  - setHideWordTrackedChanges
```
public final void setHideWordTrackedChanges(boolean value)
```
    Hide markup and track changes for Word documents.
  - getHideComments
```
public final boolean getHideComments()
```
    Hide comments.
  - setHideComments
```
public final void setHideComments(boolean value)
```
    Hide comments.
  - getBookmarkOptions
```
public final WordProcessingBookmarksOptions getBookmarkOptions()
```
    Bookmarks options
  - setBookmarkOptions
```
public final void setBookmarkOptions(WordProcessingBookmarksOptions value)
```
    Bookmarks options
  - 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
  - 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
  - isUseTextShaper
```
public boolean isUseTextShaper()
```
    Specifies whether to use a text shaper for better kerning display. Default is false.
  - setUseTextShaper
```
public void setUseTextShaper(boolean isUseTextShaper)
```
    Specifies whether to use a text shaper for better kerning display. Default is false.
    
    Parameters:
    
    isUseTextShaper - isUseTextShaper flag

Packages

com.groupdocs.conversion.options.load

Classes

Class WordProcessingLoadOptions

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

getFormat

getDefaultFont

setDefaultFont

getAutoFontSubstitution

setAutoFontSubstitution

getFontSubstitutes

isEmbedTrueTypeFonts

setEmbedTrueTypeFonts

isUpdatePageLayout

setUpdatePageLayout

isUpdateFields

setUpdateFields

setFontSubstitutes

getPassword

setPassword

getHideWordTrackedChanges

setHideWordTrackedChanges

getHideComments

setHideComments

getBookmarkOptions

setBookmarkOptions

isPreserveFontFields

setPreserveFontFields

isUseTextShaper

setUseTextShaper