com.levigo.jadice.server.msoffice

Enum MSWordNode.WdOpenFormat

java.lang.Object

java.lang.Enum<MSWordNode.WdOpenFormat>

com.levigo.jadice.server.msoffice.MSWordNode.WdOpenFormat

All Implemented Interfaces:

Serializable, Comparable<MSWordNode.WdOpenFormat>

Enclosing class:

MSWordNode

public static enum MSWordNode.WdOpenFormat
extends Enum<MSWordNode.WdOpenFormat>

Specifies which file converter MS Word will use to open the document.
The enum constant names and their javadoc descriptions are as defined in the MS Word COM interface and the MSDN library.

Those formats that indicate unformated files (i.e. plain text, xml) will use the page / font configuration as defined in server-config/ms-office/style-config.xml and marked with (configurable) in the javadoc.

Note: Only a subset of these values is available in versions earlier than Word 2007. For available values look at http://msdn.microsoft.com/en-us/library/aa174038%28office.11%29.aspx.

Since:

jadice server 4.2.0.0

See Also:

Word Developer Reference, WdOpenFormat, XML Reference, Open Method

Enum Constant Summary

Enum Constants

Enum Constant and Description
WD_OPEN_FORMAT_ALL_WORD A Microsoft Office Word format that is backward compatible with earlier versions of Word.
WD_OPEN_FORMAT_ALL_WORD_TEMPLATES Word template format.
WD_OPEN_FORMAT_AUTO MSDN says "The existing format.".
WD_OPEN_FORMAT_DOCUMENT Word format.
WD_OPEN_FORMAT_DOCUMENT_97 Microsoft Word 97 document format.
WD_OPEN_FORMAT_ENCODED_TEXT Encoded text format. (configurable)
WD_OPEN_FORMAT_RTF Rich text format (RTF).
WD_OPEN_FORMAT_TEMPLATE As a Word template.
WD_OPEN_FORMAT_TEMPLATE_97 Word 97 template format.
WD_OPEN_FORMAT_TEXT Unencoded text format. (configurable)
WD_OPEN_FORMAT_UNICODE_TEXT Unicode text format. (configurable)
WD_OPEN_FORMAT_WEB_PAGES HTML format.
WD_OPEN_FORMAT_XML XML format.
WD_OPEN_FORMAT_XML_DOCUMENT XML document format.
WD_OPEN_FORMAT_XML_DOCUMENT_MACRO_ENABLED XML document format with macros enabled.
WD_OPEN_FORMAT_XML_TEMPLATE XML template format.
WD_OPEN_FORMAT_XML_TEMPLATE_MACRO_ENABLED XML template format with macros enabled.

Method Summary

Methods

Modifier and Type	Method and Description
int	getValue()
boolean	isUseFormatConfig()
static MSWordNode.WdOpenFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static MSWordNode.WdOpenFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WD_OPEN_FORMAT_ALL_WORD

public static final MSWordNode.WdOpenFormat WD_OPEN_FORMAT_ALL_WORD

A Microsoft Office Word format that is backward compatible with earlier versions of Word.

WD_OPEN_FORMAT_AUTO

public static final MSWordNode.WdOpenFormat WD_OPEN_FORMAT_AUTO

MSDN says "The existing format.". Ask in Redmond what that might mean...

WD_OPEN_FORMAT_DOCUMENT

public static final MSWordNode.WdOpenFormat WD_OPEN_FORMAT_DOCUMENT

Word format.

WD_OPEN_FORMAT_ENCODED_TEXT

public static final MSWordNode.WdOpenFormat WD_OPEN_FORMAT_ENCODED_TEXT

Encoded text format.
(configurable)

WD_OPEN_FORMAT_RTF

public static final MSWordNode.WdOpenFormat WD_OPEN_FORMAT_RTF

Rich text format (RTF).

WD_OPEN_FORMAT_TEMPLATE

public static final MSWordNode.WdOpenFormat WD_OPEN_FORMAT_TEMPLATE

As a Word template.

WD_OPEN_FORMAT_TEXT

public static final MSWordNode.WdOpenFormat WD_OPEN_FORMAT_TEXT

Unencoded text format.
(configurable)

This value replaces the behavior of MSWord2003TextNode which was dropped in release 4.2.0.0 of jadice server.

WD_OPEN_FORMAT_UNICODE_TEXT

public static final MSWordNode.WdOpenFormat WD_OPEN_FORMAT_UNICODE_TEXT

Unicode text format.
(configurable)

WD_OPEN_FORMAT_WEB_PAGES

public static final MSWordNode.WdOpenFormat WD_OPEN_FORMAT_WEB_PAGES

HTML format.

WD_OPEN_FORMAT_XML

public static final MSWordNode.WdOpenFormat WD_OPEN_FORMAT_XML

XML format.

WD_OPEN_FORMAT_ALL_WORD_TEMPLATES

public static final MSWordNode.WdOpenFormat WD_OPEN_FORMAT_ALL_WORD_TEMPLATES

Word template format.

WD_OPEN_FORMAT_DOCUMENT_97

public static final MSWordNode.WdOpenFormat WD_OPEN_FORMAT_DOCUMENT_97

Microsoft Word 97 document format.

WD_OPEN_FORMAT_TEMPLATE_97

public static final MSWordNode.WdOpenFormat WD_OPEN_FORMAT_TEMPLATE_97

Word 97 template format.

WD_OPEN_FORMAT_XML_DOCUMENT

public static final MSWordNode.WdOpenFormat WD_OPEN_FORMAT_XML_DOCUMENT

XML document format.

WD_OPEN_FORMAT_XML_DOCUMENT_MACRO_ENABLED

public static final MSWordNode.WdOpenFormat WD_OPEN_FORMAT_XML_DOCUMENT_MACRO_ENABLED

XML document format with macros enabled.

WD_OPEN_FORMAT_XML_TEMPLATE

public static final MSWordNode.WdOpenFormat WD_OPEN_FORMAT_XML_TEMPLATE

XML template format.

WD_OPEN_FORMAT_XML_TEMPLATE_MACRO_ENABLED

public static final MSWordNode.WdOpenFormat WD_OPEN_FORMAT_XML_TEMPLATE_MACRO_ENABLED

XML template format with macros enabled.

Method Detail

values

public static MSWordNode.WdOpenFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MSWordNode.WdOpenFormat c : MSWordNode.WdOpenFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MSWordNode.WdOpenFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Returns:

The numerical value as specified in the MSDN

isUseFormatConfig

public boolean isUseFormatConfig()

Returns:

true if the page and font is as defined in server-config/ms-office/style-config.xml