Property

Method

Event

Enterprise

 

CleanupOptions

Specifies the options for the HTML tags cleanup. The default values in the HTML Tags CleanUp dialog box appear irrespective of the options specified here.

Syntax

    [get]HRESULT CleanupOptions(
    BSTR* pVal
    );
    [put]HRESULT CleanupOptions(
    BSTR newVal
    );

Parameters

[get]pVal

[out, retval] Returns the existing option values.

[put]newVal

[in] Specifies the options for the HTML tags cleanup.

The options are as follows. You can set multiple options using the pipe(|).

msword2000

Removes the MS Word 2000 tags.

empty

Removes empty tags.

redundant_nested

Removes the redundantly nested tags.

optional_end

Removes the unnecessary tags such as optional closing tags.

nested_font

Removes the overlapped <font> tags.

comment

Removes the comment.

specific

Removes a specific tag. You can specify several tags, seperating them with a colon.

e. g.) specific : warp

wrap

Specifies at what number of characters the line breaking occurs.

e. g.) wrap : 75

indent

Specifies the indentation of the HTML source.

e. g.) indent : 4

wrap_tag

Allows line breaking in the middle of a tag.

upper_tag

Changes all the tags to the uppercase. If this option is not specified, all the tags appear in lowercase.

upper_attr

Changes all the tag attributes to the uppercase. If this option is not specified, all the tag attributes appear in lowercase.

 

Return Values

0 (Always)

Remark

You cannot specify multiple values for one option at once. For example, if you use the specific option twice like "specific: p | specific : table", only the last specification, specific : table, works.

Sample Codes

VBScript

dim object
set object = Document.editForm
'Specification of the HTML tags cleanup. You can set multiple options using the pipe(|).
object.wec.CleanupOptions = "msword2000 | empty |
redundant_nested | specific : p"  
'Starts the HTML tags cleanup.
object.textbox.value=object.wec.CleanupHtml(object.wec.Value)

See Also

CleanupHTML