com.aspose.words

Class DocumentProperty

java.lang.Object

com.aspose.words.DocumentProperty

All Implemented Interfaces:

java.lang.Cloneable

public class DocumentProperty
extends java.lang.Object
implements java.lang.Cloneable

Represents a custom or built-in document property.

To learn more, visit the Work with Document Properties documentation article.

See Also:

DocumentPropertyCollection

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLinkSource() Gets the source of a linked custom document property.
java.lang.String	getName() Returns the name of the property.
int	getType() Gets the data type of the property.
java.lang.Object	getValue() Gets the value of the property.
boolean	isLinkToContent() Shows whether this property is linked to content or not.
protected java.lang.Object	memberwiseClone()
void	setValue(java.lang.Object value) Sets the value of the property.
boolean	toBool() Returns the property value as bool.
byte[]	toByteArray() Returns the property value as byte array.
java.util.Date	toDateTime() Returns the property value as DateTime in UTC.
double	toDouble() Returns the property value as double.
int	toInt() Returns the property value as integer.
java.lang.String	toString() Returns the property value as a string formatted according to the current locale.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

Returns the name of the property.

Cannot be null and cannot be an empty string.

Returns:

The name of the property.

getValue

public java.lang.Object getValue()

Gets the value of the property.

Cannot be null.

Returns:

The value of the property.

setValue

public void setValue(java.lang.Object value)

Sets the value of the property.

Cannot be null.

Parameters:

value - The value of the property.

getType

public int getType()

Gets the data type of the property.

Returns:

The data type of the property. The returned value is one of PropertyType constants.

getLinkSource

public java.lang.String getLinkSource()

Gets the source of a linked custom document property.

Returns:

The source of a linked custom document property.

isLinkToContent

public boolean isLinkToContent()

Shows whether this property is linked to content or not.

Returns:

The corresponding boolean value.

toString

public java.lang.String toString()

Returns the property value as a string formatted according to the current locale.

Converts a boolean property into "Y" or "N". Converts a date property into a short date string. For all other types converts a property using Object.ToString().

Overrides:

toString in class java.lang.Object

toInt

public int toInt()

Returns the property value as integer. Throws an exception if the property type is not PropertyType.NUMBER.

toDouble

public double toDouble()

Returns the property value as double. Throws an exception if the property type is not PropertyType.NUMBER.

toDateTime

public java.util.Date toDateTime()

Returns the property value as DateTime in UTC.

Throws an exception if the property type is not PropertyType.DATE_TIME.

Microsoft Word stores only the date part (no time) for custom date properties.

toBool

public boolean toBool()

Returns the property value as bool.

Throws an exception if the property type is not PropertyType.BOOLEAN.

toByteArray

public byte[] toByteArray()

Returns the property value as byte array.

Throws an exception if the property type is not PropertyType.BYTE_ARRAY.

memberwiseClone

protected java.lang.Object memberwiseClone()