com.spire.xls
Class DocumentProperty

java.lang.Object
  com.spire.xls.DocumentProperty

All Implemented Interfaces:

IDocumentProperty

public class DocumentProperty
extends java.lang.Object
implements IDocumentProperty

Constructor Summary

DocumentProperty()

DocumentProperty(java.lang.String name)

Method Summary

static int	correctIndex(BuiltInPropertyType propertyId, boolean[] bSummary) Converts property id into correct index.
java.lang.Object	deepClone() Creates a new object that is a copy of the current instance.
byte[]	getBlob() Gets blob value.
boolean	getBoolean() Gets boolean value.
java.util.Date	getDateTime() Gets date time value.
double	getDouble() Gets double value.
int	getInt32() Gets 4-bytes signed integer value.
int	getInteger() Gets integer value.
java.lang.String	getLinkSource() Returns the source of a linked custom document property.
boolean	getLinkToContent() True if the value of the custom document property is linked to the content of the container document.
java.lang.String	getName() Returns property name.
BuiltInPropertyType	getPropertyId() Returns property id for built-in properties.
PropertyType	getPropertyType() Gets document property type.
java.lang.String	getText() Gets string value.
java.lang.Object	getValue() Gets property value.
boolean	isBuiltIn() Indicates whether property is built-in.
void	setBlob(byte[] value) Sets Blob value.
void	setBoolean(boolean value) Sets boolean value.
void	setDateTime(java.util.Date value) Sets date time value.
void	setDouble(double value) Sets double value.
void	setInt32(int value) Sets 4-bytes signed integer value.
void	setInteger(int value) Sets integer value.
void	setLinkSource(IPropertyData variant)
void	setLinkSource(java.lang.String value) Sets the source of a linked custom document property.
void	setLinkToContent(boolean value)
void	setPropertyId(BuiltInPropertyType value) Sets property id for built-in properties.
void	setText(java.lang.String value) Sets string value.
void	setValue(java.lang.Object value) Sets property value.

Constructor Detail

DocumentProperty

public DocumentProperty()

DocumentProperty

public DocumentProperty(java.lang.String name)

Method Detail

isBuiltIn

public boolean isBuiltIn()

Indicates whether property is built-in. Read-only.

Specified by:

isBuiltIn in interface IDocumentProperty

getPropertyId

public BuiltInPropertyType getPropertyId()

Returns property id for built-in properties. Read-only.

Specified by:

getPropertyId in interface IDocumentProperty

setPropertyId

public void setPropertyId(BuiltInPropertyType value)

Sets property id for built-in properties. Read-only.

getPropertyType

public PropertyType getPropertyType()

Gets document property type.

getName

public java.lang.String getName()

Returns property name. Read-only.

Specified by:

getName in interface IDocumentProperty

getValue

public java.lang.Object getValue()

Gets property value.

Specified by:

getValue in interface IDocumentProperty

setValue

public void setValue(java.lang.Object value)

Sets property value.

Specified by:

setValue in interface IDocumentProperty

getBlob

public byte[] getBlob()

Gets blob value.

setBlob

public void setBlob(byte[] value)

Sets Blob value.

getBoolean

public boolean getBoolean()

Gets boolean value.

Specified by:

getBoolean in interface IDocumentProperty

setBoolean

public void setBoolean(boolean value)

Sets boolean value.

Specified by:

setBoolean in interface IDocumentProperty

getInteger

public int getInteger()

Gets integer value.

Specified by:

getInteger in interface IDocumentProperty

setInteger

public void setInteger(int value)

Sets integer value.

Specified by:

setInteger in interface IDocumentProperty

getInt32

public int getInt32()

Gets 4-bytes signed integer value.

Specified by:

getInt32 in interface IDocumentProperty

setInt32

public void setInt32(int value)

Sets 4-bytes signed integer value.

Specified by:

setInt32 in interface IDocumentProperty

getDouble

public double getDouble()

Gets double value.

Specified by:

getDouble in interface IDocumentProperty

setDouble

public void setDouble(double value)

Sets double value.

Specified by:

setDouble in interface IDocumentProperty

getText

public java.lang.String getText()

Gets string value.

Specified by:

getText in interface IDocumentProperty

setText

public void setText(java.lang.String value)

Sets string value.

Specified by:

setText in interface IDocumentProperty

getDateTime

public java.util.Date getDateTime()

Gets date time value.

Specified by:

getDateTime in interface IDocumentProperty

setDateTime

public void setDateTime(java.util.Date value)

Sets date time value.

Specified by:

setDateTime in interface IDocumentProperty

getLinkSource

public java.lang.String getLinkSource()

Returns the source of a linked custom document property. Read/write String.

Specified by:

getLinkSource in interface IDocumentProperty

setLinkSource

public void setLinkSource(java.lang.String value)

Sets the source of a linked custom document property. Read/write String.

Specified by:

setLinkSource in interface IDocumentProperty

getLinkToContent

public boolean getLinkToContent()

True if the value of the custom document property is linked to the content of the container document. False if the value is static. Read/write boolean.

Specified by:

getLinkToContent in interface IDocumentProperty

setLinkToContent

public void setLinkToContent(boolean value)

Specified by:

setLinkToContent in interface IDocumentProperty

deepClone

public java.lang.Object deepClone()

Creates a new object that is a copy of the current instance.

Returns:

A new object that is a copy of this instance.

setLinkSource

public void setLinkSource(IPropertyData variant)

correctIndex

public static int correctIndex(BuiltInPropertyType propertyId,
                               boolean[] bSummary)

Converts property id into correct index.

Parameters:

propertyId - Property id to convert.

bSummary - Indicates whether this is documnet summary property of simply document property.

Returns:

Correct property index.