Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class CustomDocumentProperties

java.lang.Object
  extended by com.aspose.cells.CustomDocumentProperties
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Iterable<DocumentProperty>

public class CustomDocumentProperties
extends java.lang.Object
implements java.lang.Iterable<DocumentProperty>, java.lang.Cloneable

Represents a collection of custom document properties.


Method Summary
 DocumentProperty add(java.lang.String name, boolean value)
          Creates a new custom document property of the PropertyType.Boolean data type.
 DocumentProperty add(java.lang.String name, java.util.Date dateTime)
          Creates a new custom document property of the PropertyType.DateTime data type.
 DocumentProperty add(java.lang.String name, double value)
          Creates a new custom document property of the PropertyType.Float data type.
 DocumentProperty add(java.lang.String name, int value)
          Creates a new custom document property of the PropertyType.Number data type.
 DocumentProperty add(java.lang.String name, java.lang.String value)
          Creates a new custom document property of the PropertyType.String data type.
 DocumentProperty get(int index)
          Returns a DocumentProperty object by index.
 DocumentProperty get(java.lang.String name)
          Returns a DocumentProperty object by the name of the property.
 int getCount()
          Gets number of items in the collection.
 java.util.Iterator<DocumentProperty> iterator()
          Returns an DocumentProperty iterator.
 void remove(java.lang.String name)
          Removes property with the specified name from the collection.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getCount

public int getCount()
Gets number of items in the collection.

Returns:
number of items in the collection.

get

public DocumentProperty get(java.lang.String name)
Returns a DocumentProperty object by the name of the property. Returns null if a property with the specified name is not found.

Parameters:
name - The case-sensitive name of the property to retrieve.
Returns:
a DocumentProperty object by the name of the property.

get

public DocumentProperty get(int index)
Returns a DocumentProperty object by index.

Parameters:
index - Zero-based index of the DocumentProperty to return.
Returns:
a DocumentProperty object by index.

add

public DocumentProperty add(java.lang.String name,
                            java.lang.String value)
Creates a new custom document property of the PropertyType.String data type.

Parameters:
name - The name of the property.
value - The value of the property.
Returns:
The newly created property Object.

add

public DocumentProperty add(java.lang.String name,
                            int value)
Creates a new custom document property of the PropertyType.Number data type.

Parameters:
name - The name of the property.
value - The value of the property.
Returns:
The newly created property object.

add

public DocumentProperty add(java.lang.String name,
                            java.util.Date dateTime)
Creates a new custom document property of the PropertyType.DateTime data type.

Parameters:
name - The name of the property.
dateTime - The dateTime of the property.
Returns:
The newly created property object.

add

public DocumentProperty add(java.lang.String name,
                            boolean value)
Creates a new custom document property of the PropertyType.Boolean data type.

Parameters:
name - The name of the property.
value - The value of the property.
Returns:
The newly created property object.

add

public DocumentProperty add(java.lang.String name,
                            double value)
Creates a new custom document property of the PropertyType.Float data type.

Parameters:
name - The name of the property.
value - The value of the property.
Returns:
The newly created property object.

remove

public void remove(java.lang.String name)
Removes property with the specified name from the collection.

Parameters:
name - The case-sensitive name of the property to remove.

iterator

public java.util.Iterator<DocumentProperty> iterator()
Returns an DocumentProperty iterator.

Specified by:
iterator in interface java.lang.Iterable<DocumentProperty>