DocumentCustomProperty Class

A custom document property.

Declaration

public final class DocumentCustomProperty extends Struct<DocumentCustomProperty> implements IEquatable<DocumentCustomProperty>

Remarks

The getCustomProperties() method returns a dictionary of DocumentCustomProperty objects.

Refer to the following help topic for additional information: Create Custom Document Properties.

Implements

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

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

DocumentCustomProperty

Constructors

DocumentCustomProperty() Constructor

Initializes a new instance of the DocumentCustomProperty class.

Declaration

public DocumentCustomProperty()

DocumentCustomProperty(BigDecimal value) Constructor

Initializes a new instance of the DocumentCustomProperty class with specified BigDecimal value.

Declaration

public DocumentCustomProperty(BigDecimal value)

Parameters

Name	Type	Description
value	BigDecimal	The property value.

DocumentCustomProperty(boolean value) Constructor

Initializes a new instance of the DocumentCustomProperty class with specified Boolean value.

Declaration

public DocumentCustomProperty(boolean value)

Parameters

Name	Type	Description
value	boolean	The property value.

DocumentCustomProperty(double value) Constructor

Initializes a new instance of the DocumentCustomProperty class with specified double value.

Declaration

public DocumentCustomProperty(double value)

Parameters

Name	Type	Description
value	double	The property value.

DocumentCustomProperty(Instant value) Constructor

Initializes a new instance of the DocumentCustomProperty class with specified Instant value.

Declaration

public DocumentCustomProperty(Instant value)

Parameters

Name	Type	Description
value	Instant	The property value.

DocumentCustomProperty(int value) Constructor

Initializes a new instance of the DocumentCustomProperty class with specified integer value.

Declaration

public DocumentCustomProperty(int value)

Parameters

Name	Type	Description
value	int	The property value.

DocumentCustomProperty(String value) Constructor

Initializes a new instance of the DocumentCustomProperty class with specified string value.

Declaration

public DocumentCustomProperty(String value)

Parameters

Name	Type	Description
value	String	The property value.

Methods

equals(DocumentCustomProperty value) Method

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

Declaration

public boolean equals(DocumentCustomProperty value)

Parameters

Name	Type	Description
value	DocumentCustomProperty	An object to compare with the current DocumentCustomProperty 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 DocumentCustomProperty object.

Declaration

public boolean equals(Object obj)

Parameters

Name	Type	Description
obj	Object	An object to compare with the current DocumentCustomProperty object.

Returns

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

getType() Method

Returns the property type.

Declaration

public DocumentCustomPropertyValueType getType()

Returns

Type	Description
DocumentCustomPropertyValueType	An enumeration value that indicates the property type.

getValue() Method

Returns the property value.

Declaration

public Object getValue()

Returns

Type	Description
Object	The property value.

Remarks

The getValue() method returns the property value as an Object instance. Use the getType() method to determine the property type.

hashCode() Method

Returns a hash code for this DocumentCustomProperty object.

Declaration

public int hashCode()

Returns

Type	Description
int	The identification number.

toBooleanValue() Method

Returns the property value as a Boolean value.

Declaration

public boolean toBooleanValue()

Returns

Type	Description
boolean	The property value as Boolean value.

toDateTimeValue() Method

Returns the property value as an Instant.

Declaration

public Instant toDateTimeValue()

Returns

Type	Description
Instant	The property value as an Instant.

toDecimalValue() Method

Returns the property value as a Decimal value.

Declaration

public BigDecimal toDecimalValue()

Returns

Type	Description
BigDecimal	The property value as DateTime value.

toDoubleValue() Method

Returns the property value as a Double value.

Declaration

public double toDoubleValue()

Returns

Type	Description
double	The property value as Double value.

toIntValue() Method

Returns the property value as a Int32 value.

Declaration

public int toIntValue()

Returns

Type	Description
int	The property value as Int32 value.

toStringValue() Method

Returns the property value as a String value.

Declaration

public String toStringValue()

Returns

Type	Description
String	The property value as String value.