com.aspose.words

Class ImportFormatOptions

java.lang.Object

com.aspose.words.ImportFormatOptions

public class ImportFormatOptions
extends java.lang.Object

Allows to specify various import options to format output.

To learn more, visit the Specify Load Options documentation article.

Method Summary

Modifier and Type	Method and Description
boolean	getForceCopyStyles() Gets a boolean value indicating either to copy conflicting styles in ImportFormatMode.KEEP_SOURCE_FORMATTING mode.
boolean	getIgnoreHeaderFooter() Gets a boolean value that specifies that source formatting of headers/footers content ignored if ImportFormatMode.KEEP_SOURCE_FORMATTING mode is used.
boolean	getIgnoreTextBoxes() Gets a boolean value that specifies that source formatting of textboxes content ignored if ImportFormatMode.KEEP_SOURCE_FORMATTING mode is used.
boolean	getKeepSourceNumbering() Gets a boolean value that specifies how the numbering will be imported when it clashes in source and destination documents.
boolean	getMergePastedLists() Gets a boolean value that specifies whether pasted lists will be merged with surrounding lists.
boolean	getSmartStyleBehavior() Gets a boolean value that specifies how styles will be imported when they have equal names in source and destination documents.
void	setForceCopyStyles(boolean value) Sets a boolean value indicating either to copy conflicting styles in ImportFormatMode.KEEP_SOURCE_FORMATTING mode.
void	setIgnoreHeaderFooter(boolean value) Sets a boolean value that specifies that source formatting of headers/footers content ignored if ImportFormatMode.KEEP_SOURCE_FORMATTING mode is used.
void	setIgnoreTextBoxes(boolean value) Sets a boolean value that specifies that source formatting of textboxes content ignored if ImportFormatMode.KEEP_SOURCE_FORMATTING mode is used.
void	setKeepSourceNumbering(boolean value) Sets a boolean value that specifies how the numbering will be imported when it clashes in source and destination documents.
void	setMergePastedLists(boolean value) Sets a boolean value that specifies whether pasted lists will be merged with surrounding lists.
void	setSmartStyleBehavior(boolean value) Sets a boolean value that specifies how styles will be imported when they have equal names in source and destination documents.

Methods inherited from class java.lang.Object

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

Method Detail

getSmartStyleBehavior

public boolean getSmartStyleBehavior()

Gets a boolean value that specifies how styles will be imported when they have equal names in source and destination documents. The default value is false.

When this option is enabled, the source style will be expanded into a direct attributes inside a destination document, if ImportFormatMode.KEEP_SOURCE_FORMATTING importing mode is used.

When this option is disabled, the source style will be expanded only if it is numbered. Existing destination attributes will not be overridden, including lists.

Returns:

A boolean value that specifies how styles will be imported when they have equal names in source and destination documents.

setSmartStyleBehavior

public void setSmartStyleBehavior(boolean value)

Sets a boolean value that specifies how styles will be imported when they have equal names in source and destination documents. The default value is false.

When this option is enabled, the source style will be expanded into a direct attributes inside a destination document, if ImportFormatMode.KEEP_SOURCE_FORMATTING importing mode is used.

When this option is disabled, the source style will be expanded only if it is numbered. Existing destination attributes will not be overridden, including lists.

Parameters:

value - A boolean value that specifies how styles will be imported when they have equal names in source and destination documents.

getKeepSourceNumbering

public boolean getKeepSourceNumbering()

Gets a boolean value that specifies how the numbering will be imported when it clashes in source and destination documents. The default value is false.

Returns:

A boolean value that specifies how the numbering will be imported when it clashes in source and destination documents.

setKeepSourceNumbering

public void setKeepSourceNumbering(boolean value)

Sets a boolean value that specifies how the numbering will be imported when it clashes in source and destination documents. The default value is false.

Parameters:

value - A boolean value that specifies how the numbering will be imported when it clashes in source and destination documents.

getIgnoreTextBoxes

public boolean getIgnoreTextBoxes()

Gets a boolean value that specifies that source formatting of textboxes content ignored if ImportFormatMode.KEEP_SOURCE_FORMATTING mode is used. The default value is true.

Returns:

A boolean value that specifies that source formatting of textboxes content ignored if ImportFormatMode.KEEP_SOURCE_FORMATTING mode is used.

setIgnoreTextBoxes

public void setIgnoreTextBoxes(boolean value)

Sets a boolean value that specifies that source formatting of textboxes content ignored if ImportFormatMode.KEEP_SOURCE_FORMATTING mode is used. The default value is true.

Parameters:

value - A boolean value that specifies that source formatting of textboxes content ignored if ImportFormatMode.KEEP_SOURCE_FORMATTING mode is used.

getIgnoreHeaderFooter

public boolean getIgnoreHeaderFooter()

Gets a boolean value that specifies that source formatting of headers/footers content ignored if ImportFormatMode.KEEP_SOURCE_FORMATTING mode is used. The default value is true.

Returns:

A boolean value that specifies that source formatting of headers/footers content ignored if ImportFormatMode.KEEP_SOURCE_FORMATTING mode is used.

setIgnoreHeaderFooter

public void setIgnoreHeaderFooter(boolean value)

Sets a boolean value that specifies that source formatting of headers/footers content ignored if ImportFormatMode.KEEP_SOURCE_FORMATTING mode is used. The default value is true.

Parameters:

value - A boolean value that specifies that source formatting of headers/footers content ignored if ImportFormatMode.KEEP_SOURCE_FORMATTING mode is used.

getMergePastedLists

public boolean getMergePastedLists()

Gets a boolean value that specifies whether pasted lists will be merged with surrounding lists. The default value is false.

Returns:

A boolean value that specifies whether pasted lists will be merged with surrounding lists.

setMergePastedLists

public void setMergePastedLists(boolean value)

Sets a boolean value that specifies whether pasted lists will be merged with surrounding lists. The default value is false.

Parameters:

value - A boolean value that specifies whether pasted lists will be merged with surrounding lists.

getForceCopyStyles

public boolean getForceCopyStyles()

Gets a boolean value indicating either to copy conflicting styles in ImportFormatMode.KEEP_SOURCE_FORMATTING mode. The default value is false.

By default, if a matching style already exists in a destination document, the source style formatting is expanded into direct node attributes and the style of this node is reset to a default.

When this option is set to true, the source style will be forcibly copied into destination document with unique name and applied to the imported node.

Note, in this case it is not guaranteed that formatting of the imported node in destination document will be preserved.

Returns:

A boolean value indicating either to copy conflicting styles in ImportFormatMode.KEEP_SOURCE_FORMATTING mode.

setForceCopyStyles

public void setForceCopyStyles(boolean value)

Sets a boolean value indicating either to copy conflicting styles in ImportFormatMode.KEEP_SOURCE_FORMATTING mode. The default value is false.

By default, if a matching style already exists in a destination document, the source style formatting is expanded into direct node attributes and the style of this node is reset to a default.

When this option is set to true, the source style will be forcibly copied into destination document with unique name and applied to the imported node.

Note, in this case it is not guaranteed that formatting of the imported node in destination document will be preserved.

Parameters:

value - A boolean value indicating either to copy conflicting styles in ImportFormatMode.KEEP_SOURCE_FORMATTING mode.