HtmlInsertOptions

Inheritance: java.lang.Object

public class HtmlInsertOptions

Specifies options for the M:Aspose.Words.DocumentBuilder.InsertHtml(System.String,Aspose.Words.HtmlInsertOptions) method.

Examples:

Shows how to allows better preserve borders and margins seen.


 final String HTML = "\n                \n                    \n                    \n                        paragraph 1\n                        paragraph 2\n                    \n                    \n                ";

 // Set the new mode of import HTML block-level elements.
 int insertOptions = HtmlInsertOptions.PRESERVE_BLOCKS;

 DocumentBuilder builder = new DocumentBuilder();
 builder.insertHtml(HTML, insertOptions);
 builder.getDocument().save(getArtifactsDir() + "DocumentBuilder.PreserveBlocks.docx");

Fields

Field	Description
NONE	Use the default options when inserting HTML.
PRESERVE_BLOCKS	Preserve properties of block-level elements.
REMOVE_LAST_EMPTY_PARAGRAPH	Remove the empty paragraph that is normally inserted after HTML that ends with a block-level element.
USE_BUILDER_FORMATTING	Use font and paragraph formatting specified in DocumentBuilder as base formatting for text inserted from HTML.
length

Methods

Method	Description
fromName(String htmlInsertOptionsName)
fromNames(Set htmlInsertOptionsNames)
getName(int htmlInsertOptions)
getNames(int htmlInsertOptions)
getValues()
toString(int htmlInsertOptions)
toStringSet(int attr)

NONE

public static int NONE

Use the default options when inserting HTML.

PRESERVE_BLOCKS

public static int PRESERVE_BLOCKS

Preserve properties of block-level elements.

Remarks:

By default, properties of parent blocks are merged and stored on their child elements (i.e. paragraphs or tables). If this option is specified, properties of each block are stored separately in a special logical structure. As a result, this option allows to better preserve individual borders and margins seen in the HTML document and get better conversion results. The downside is that the resulting document gets harder to modify, since borders and margins stored in the logical structure are not available for editing.

Only margins and borders of ‘body’, ‘div’, and ‘blockquote’ HTML elements are preserved. Properties of each HTML element are stored separately.

If this option is specified, Aspose.Words mimics MS Word’s behavior regarding import of block properties.

REMOVE_LAST_EMPTY_PARAGRAPH

public static int REMOVE_LAST_EMPTY_PARAGRAPH

Remove the empty paragraph that is normally inserted after HTML that ends with a block-level element.

Remarks:

By default, DocumentBuilder makes sure that the last block-level element imported from HTML is closed after import and inserts a paragraph break after the element. This paragraph break separates content imported from HTML from content of the template document. However, if a HTML fragment is inserted into an empty paragraph, that paragraph break will create an extra empty paragraph. If this behavior is undesired, specify this option.

USE_BUILDER_FORMATTING

public static int USE_BUILDER_FORMATTING

Use font and paragraph formatting specified in DocumentBuilder as base formatting for text inserted from HTML.

Remarks:

If this option is not specified, formatting of DocumentBuilder is ignored and text is inserted with default HTML formatting. As a result, the text looks as it is rendered in browsers.

If this option is specified, formatting of inserted text is based on formatting specified in DocumentBuilder, and the text looks as if it were inserted using DocumentBuilder.write(java.lang.String).

length

public static int length

fromName(String htmlInsertOptionsName)

public static int fromName(String htmlInsertOptionsName)

Parameters:

Parameter	Type	Description
htmlInsertOptionsName	java.lang.String

Returns: int

fromNames(Set htmlInsertOptionsNames)

public static int fromNames(Set htmlInsertOptionsNames)

Parameters:

Parameter	Type	Description
htmlInsertOptionsNames	java.util.Set

Returns: int

getName(int htmlInsertOptions)

public static String getName(int htmlInsertOptions)

Parameters:

Parameter	Type	Description
htmlInsertOptions	int

Returns: java.lang.String

getNames(int htmlInsertOptions)

public static Set getNames(int htmlInsertOptions)

Parameters:

Parameter	Type	Description
htmlInsertOptions	int

Returns: java.util.Set

getValues()

public static int[] getValues()

Returns: int[]

toString(int htmlInsertOptions)

public static String toString(int htmlInsertOptions)

Parameters:

Parameter	Type	Description
htmlInsertOptions	int

Returns: java.lang.String

toStringSet(int attr)

public static String toStringSet(int attr)

Parameters:

Parameter	Type	Description
attr	int

Returns: java.lang.String

HtmlFixedSaveOptions HtmlLoadOptions