com.groupdocs.editor.options

Class WordProcessingEditOptions

java.lang.Object

com.groupdocs.editor.options.WordProcessingEditOptions

All Implemented Interfaces:

IEditOptions

public class WordProcessingEditOptions
extends Object
implements IEditOptions

Allows to specify custom options for editing documents of all supportable WordProcessing (Words-compliant) formats like DOC(X), RTF, ODT etc.

Constructor Summary

Constructors

Constructor and Description
WordProcessingEditOptions() Creates and returns a new instance of the WordProcessingEditOptions class, where all options are set to their default values
WordProcessingEditOptions(boolean enablePagination) Creates and returns a new instance of the WordProcessingEditOptions class with specified pagination and default all other options

Method Summary

Modifier and Type	Method and Description
boolean	getEnableLanguageInformation() Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes.
boolean	getEnablePagination() Allows to enable or disable pagination in the resultant HTML document.
boolean	getExtractOnlyUsedFont() Gets or sets a value indicating whether extract only font resources that are used in the textual content of the document.
int	getFontExtraction() Responsible for extracting font resources, which are used in the input WordProcessing document.
String	getInputControlsClassName() Allows to specify a class name, which will be placed to the 'class' attributes in every HTML element, that represents some field in the input WordProcessing document.
boolean	getUseInlineStyles() Controls where to store the styling and formatting data of the input WordProcessing document: in external stylesheet (false) or as inline styles in the HTML markup (true).
void	setEnableLanguageInformation(boolean value) Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes.
void	setEnablePagination(boolean value) Allows to enable or disable pagination in the resultant HTML document.
void	setExtractOnlyUsedFont(boolean value) Gets or sets a value indicating whether extract only font resources that are used in the textual content of the document.
void	setFontExtraction(int value) Responsible for extracting font resources, which are used in the input WordProcessing document.
void	setInputControlsClassName(String value) Allows to specify a class name, which will be placed to the 'class' attributes in every HTML element, that represents some field in the input WordProcessing document.
void	setUseInlineStyles(boolean value) Controls where to store the styling and formatting data of the input WordProcessing document: in external stylesheet (false) or as inline styles in the HTML markup (true).

Methods inherited from class java.lang.Object

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

Constructor Detail

WordProcessingEditOptions

public WordProcessingEditOptions()

Creates and returns a new instance of the WordProcessingEditOptions class, where all options are set to their default values

WordProcessingEditOptions

public WordProcessingEditOptions(boolean enablePagination)

Creates and returns a new instance of the WordProcessingEditOptions class with specified pagination and default all other options

Parameters:

enablePagination - Pagination flag, that enables HTML output, adjusted for paged mode

Method Detail

getEnableLanguageInformation

public final boolean getEnableLanguageInformation()

Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes. This option may be useful for roundtrip conversion of the multi-language documents. By default it is disabled (false).

getEnablePagination

public final boolean getEnablePagination()

Allows to enable or disable pagination in the resultant HTML document. By default is disabled (false).

getExtractOnlyUsedFont

public final boolean getExtractOnlyUsedFont()

Gets or sets a value indicating whether extract only font resources that are used in the textual content of the document.

Value: true if it is required to extract only those font resources, which are used in text content of the document; otherwise, false. Default value is false.

Not all fonts, used in the WordProcessing document, are 100% used directly (applied to some text). There may be a situation, when font is referenced in the document and even may be embedded, but is not applied to any piece of text. For example, some font may be attached to some style, but this style is not applied to any part of text. This option controls how to process such cases.

getFontExtraction

public final int getFontExtraction()

Responsible for extracting font resources, which are used in the input WordProcessing document. By default doesn't extract any fonts (NotExtract).

getInputControlsClassName

public final String getInputControlsClassName()

Allows to specify a class name, which will be placed to the 'class' attributes in every HTML element, that represents some field in the input WordProcessing document. By default is NULL - 'class' attributes are not applied.

Almost all formats from WordProcessing format family contain fields — specific document entities, that allow to obtain input data from users. There are a wide variety of fields: text-boxes, checkboxes, combo-boxes, drop down lists, buttons, date/time pickers, etc. All of them are translated into the most appropriate HTML structures and elements, with preserving the entered user data, if they are present in the input document. In specific use-cases it is required only to gather entered data on a client-side instead of editing the entire document content. For such case it is required to identify input controls in some way for fetching them with their data on client-side. This property allows to specify a class name, that will be applied for every input control in HTML markup, so client code will be able to traverse over HTML document structure and gather data.

getUseInlineStyles

public final boolean getUseInlineStyles()

Controls where to store the styling and formatting data of the input WordProcessing document: in external stylesheet (false) or as inline styles in the HTML markup (true). By default external styles are used (false).

setEnableLanguageInformation

public final void setEnableLanguageInformation(boolean value)

Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes. This option may be useful for roundtrip conversion of the multi-language documents. By default it is disabled (false).

setEnablePagination

public final void setEnablePagination(boolean value)

Allows to enable or disable pagination in the resultant HTML document. By default is disabled (false).

setExtractOnlyUsedFont

public final void setExtractOnlyUsedFont(boolean value)

Gets or sets a value indicating whether extract only font resources that are used in the textual content of the document.

Value: true if it is required to extract only those font resources, which are used in text content of the document; otherwise, false. Default value is false.

Not all fonts, used in the WordProcessing document, are 100% used directly (applied to some text). There may be a situation, when font is referenced in the document and even may be embedded, but is not applied to any piece of text. For example, some font may be attached to some style, but this style is not applied to any part of text. This option controls how to process such cases.

setFontExtraction

public final void setFontExtraction(int value)

Responsible for extracting font resources, which are used in the input WordProcessing document. By default doesn't extract any fonts (NotExtract).

setInputControlsClassName

public final void setInputControlsClassName(String value)

Allows to specify a class name, which will be placed to the 'class' attributes in every HTML element, that represents some field in the input WordProcessing document. By default is NULL - 'class' attributes are not applied.

Almost all formats from WordProcessing format family contain fields — specific document entities, that allow to obtain input data from users. There are a wide variety of fields: text-boxes, checkboxes, combo-boxes, drop down lists, buttons, date/time pickers, etc. All of them are translated into the most appropriate HTML structures and elements, with preserving the entered user data, if they are present in the input document. In specific use-cases it is required only to gather entered data on a client-side instead of editing the entire document content. For such case it is required to identify input controls in some way for fetching them with their data on client-side. This property allows to specify a class name, that will be applied for every input control in HTML markup, so client code will be able to traverse over HTML document structure and gather data.

setUseInlineStyles

public final void setUseInlineStyles(boolean value)

Controls where to store the styling and formatting data of the input WordProcessing document: in external stylesheet (false) or as inline styles in the HTML markup (true). By default external styles are used (false).