CustomDocumentPropertyCollection

Inheritance: java.lang.Object, com.aspose.cells.CollectionBase, com.aspose.cells.DocumentPropertyCollection

public class CustomDocumentPropertyCollection extends DocumentPropertyCollection

A collection of custom document properties.

Remarks

Each object represents a custom property of a container document.

Example

         //Instantiate a Workbook object
         Workbook workbook = new Workbook("book1.xls");
 
         //Retrieve a list of all custom document properties of the Excel file
         CustomDocumentPropertyCollection customProperties = workbook.getWorksheets().getCustomDocumentProperties();

Methods

Method	Description
add(Object o)	Adds an item to the CollectionBase instance.
add(String name, boolean value)	Creates a new custom document property of the PropertyType.Boolean data type.
add(String name, DateTime value)	Creates a new custom document property of the PropertyType.DateTime data type.
add(String name, double value)	Creates a new custom document property of the PropertyType.Float data type.
add(String name, int value)	Creates a new custom document property of the PropertyType.Number data type.
add(String name, String value)	Creates a new custom document property of the PropertyType.String data type.
addLinkToContent(String name, String source)	Creates a new custom document property which links to content.
clear()	Removes all objects from the CollectionBase instance.
contains(Object o)	Return whether instance contains this object
contains(String name)	Returns true if a property with the specified name exists in the collection.
equals(Object arg0)
get(int index)	Returns a DocumentProperty object by index.
get(String name)	Returns a DocumentProperty object by the name of the property.
getClass()
getCount()	Gets the number of elements contained in the CollectionBase instance.
hashCode()
indexOf(Object o)	Determines the index of a specific item in the CollectionBase instance.
indexOf(String name)	Gets the index of a property by name.
iterator()	Returns an enumerator that iterates through the CollectionBase instance.
notify()
notifyAll()
remove(String name)	Removes a property with the specified name from the collection.
removeAt(int index)	Removes a property at the specified index.
toString()
updateLinkedPropertyValue()	Update custom document property value which links to content.
updateLinkedRange()	Update custom document property value to linked range.
wait()
wait(long arg0)
wait(long arg0, int arg1)

add(Object o)

public int add(Object o)

Adds an item to the CollectionBase instance.

Parameters:

Parameter	Type	Description
o	java.lang.Object	The Object to add to the CollectionBase instance.

Returns: int - The position into which the new element was inserted.

add(String name, boolean value)

public DocumentProperty add(String name, boolean value)

Creates a new custom document property of the PropertyType.Boolean data type.

Parameters:

Parameter	Type	Description
name	java.lang.String	The name of the property.
value	boolean	The value of the property.