public abstract class DocumentPropertyCollection
Example:
//Instantiate a Workbook object by calling its empty constructor 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");
Property Getters/Setters Summary | ||
---|---|---|
int | getCount() | |
Gets number of items in the collection.
|
||
DocumentProperty | get(int index) | |
Returns a |
||
DocumentProperty | get(java.lang.String name) | |
Returns a |
Method Summary | ||
---|---|---|
void | clear() | |
Removes all properties from the collection.
|
||
boolean | contains(java.lang.String name) | |
Returns true if a property with the specified name exists in the collection.
|
||
int | indexOf(java.lang.String name) | |
Gets the index of a property by name.
|
||
java.util.Iterator | iterator() | |
void | remove(java.lang.String name) | |
Removes a property with the specified name from the collection.
|
||
void | removeAt(int index) | |
Removes a property at the specified index.
|
public int getCount()
public DocumentProperty get(java.lang.String name)
Returns null if a property with the specified name is not found.
name
- The case-insensitive name of the property to retrieve.public DocumentProperty get(int index)
index
- Zero-based index of the public java.util.Iterator iterator()
public boolean contains(java.lang.String name)
name
- The case-insensitive name of the property.public int indexOf(java.lang.String name)
name
- The case-insensitive name of the property.public void remove(java.lang.String name)
name
- The case-insensitive name of the property.public void removeAt(int index)
index
- The zero based index.public void clear()