com.aspose.cells

Class DocumentProperty

java.lang.Object

com.aspose.cells.DocumentProperty

public class DocumentProperty
extends java.lang.Object

Represents a custom or built-in document property.

Example

 
         //Instantiate a Workbook object
         Workbook workbook = new Workbook("book1.xls");
 
         //Retrieve a list of all custom document properties of the Excel file
         DocumentPropertyCollection customProperties = workbook.getWorksheets().getCustomDocumentProperties();
 
         //Accessng a custom document property by using the property index
         DocumentProperty customProperty1 = customProperties.get(3);
 
         //Accessng a custom document property by using the property name
         DocumentProperty customProperty2 = customProperties.get("Owner");
 

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name of the property.
java.lang.String	getSource() The linked content source.
int	getType() Gets the data type of the property.
java.lang.Object	getValue() Gets the value of the property.
boolean	isGeneratedName() Returns true if this property does not have a name in the OLE2 storage and a unique name was generated only for the public API.
boolean	isLinkedToContent() Indicates whether this property is linked to content
void	setValue(java.lang.Object value) Sets the value of the property.
boolean	toBool() Returns the property value as bool.
DateTime	toDateTime() Returns the property value as DateTime in local timezone.
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.

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.

getValue

public java.lang.Object getValue()

Gets the value of the property.

setValue

public void setValue(java.lang.Object value)

Sets the value of the property.

isLinkedToContent

public boolean isLinkedToContent()

Indicates whether this property is linked to content

getSource

public java.lang.String getSource()

The linked content source.

getType

public int getType()

Gets the data type of the property.

See PropertyType.

isGeneratedName

public boolean isGeneratedName()

Returns true if this property does not have a name in the OLE2 storage and a unique name was generated only for the public API.

toString

public java.lang.String toString()

Returns the property value as a string.

Remarks

Converts a number property using Object.ToString(). Converts a boolean property into "Y" or "N". Converts a date property into a short date string.

Overrides:

toString in class java.lang.Object

toInt

public int toInt()

Returns the property value as integer.

Remarks

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

toDouble

public double toDouble()

Returns the property value as double.

Remarks

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

toDateTime

public DateTime toDateTime()

Returns the property value as DateTime in local timezone.

Remarks

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

toBool

public boolean toBool()

Returns the property value as bool.

Remarks

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