DocumentFormat Class

A document format.

Declaration

public final class DocumentFormat extends Struct<DocumentFormat> implements IConvertToInt<DocumentFormat>, IEquatable<DocumentFormat>

Remarks

Refer to the following help topic for additional information: Create, Load, and Save PowerPoint Presentations.

Implements

com.devexpress.utils.IConvertToInt<com.devexpress.docs.presentation.DocumentFormat>

com.devexpress.system.IEquatable<com.devexpress.docs.presentation.DocumentFormat>

Inherited Members

com.devexpress.system.Struct.equals(java.lang.Object)

com.devexpress.system.Struct.getHashCode()

com.devexpress.system.Struct.hashCode()

java.lang.Object.clone()

java.lang.Object.finalize()

java.lang.Object.getClass()

java.lang.Object.notify()

java.lang.Object.notifyAll()

java.lang.Object.toString()

java.lang.Object.wait()

java.lang.Object.wait(long)

java.lang.Object.wait(long,int)

Inheritance

Object

com.devexpress.system.Struct

DocumentFormat

Constructors

DocumentFormat() Constructor

Initializes a new instance of the DocumentFormat class.

Declaration

public DocumentFormat()

DocumentFormat(int value) Constructor

Initializes a new instance of the DocumentFormat class with specified settings.

Declaration

public DocumentFormat(int value)

Parameters

Name	Type	Description
value	int	The integer value that specifies the document format.

Fields

POTM Field

Office Open XML Presentation Macro-Enabled template document format.

Declaration

public static final DocumentFormat POTM

Field Value

Type	Description
DocumentFormat	Office Open XML Presentation Macro-Enabled template document format.

POTX Field

Office Open XML Presentation template document format.

Declaration

public static final DocumentFormat POTX

Field Value

Type	Description
DocumentFormat	Office Open XML Presentation template document format.

PPTM Field

Office Open XML Presentation Macro-Enabled document format.

Declaration

public static final DocumentFormat PPTM

Field Value

Type	Description
DocumentFormat	Office Open XML Presentation Macro-Enabled document format.

PPTX Field

Office Open XML Presentation document format.

Declaration

public static final DocumentFormat PPTX

Field Value

Type	Description
DocumentFormat	Office Open XML Presentation document format.

UNDEFINED Field

Undefined document format.

Declaration

public static final DocumentFormat UNDEFINED

Field Value

Type	Description
DocumentFormat	Undefined document format.

Methods

equals(DocumentFormat other) Method

Determines whether the specified object is equal to the current DocumentFormat object.

Declaration

public boolean equals(DocumentFormat other)

Parameters

Name	Type	Description
other	DocumentFormat	A DocumentFormat object to compare with the current object.

Returns

Type	Description
boolean	true if the specified object is equal to the current object; otherwise, false.

equals(Object obj) Method

Determines whether the specified object is equal to the current DocumentFormat object.

Declaration

public boolean equals(Object obj)

Parameters

Name	Type	Description
obj	Object	The obj parameter.

Returns

Type	Description
boolean	true if the specified object is equal to the current object; otherwise, false.

fromInt(int value) Method

Converts the specified integer value to a document format.

Declaration

public DocumentFormat fromInt(int value)

Parameters

Name	Type	Description
value	int	The integer value to convert.

Returns

Type	Description
DocumentFormat	The document format that corresponds to the specified integer value.

hashCode() Method

Returns a hash code for this DocumentFormat object.

Declaration

public int hashCode()

Returns

Type	Description
int	The identification number.

toInt() Method

Converts the document format to its integer value.

Declaration

public int toInt()

Returns

Type	Description
int	The integer value that corresponds to the document format.

toString() Method

Returns the string representation of the DocumentFormat object.

Declaration

public String toString()

Returns

Type	Description
String	The string representation of the DocumentFormat object.