Example:
# Instantiate a Workbook object by calling its empty constructor workbook = Workbook("CustomProperties.xlsx") # Retrieve a list of all custom document properties of the Excel file customProperties = workbook.getWorksheets().getCustomDocumentProperties() # Accessng a custom document property by using the property index customProperty1 = customProperties.get(3) # Accessng a custom document property by using the property name customProperty2 = customProperties.get("Owner")
Property Getters/Setters Summary | ||
---|---|---|
method | getCount() | |
Gets number of items in the collection. | ||
method | get(index) | |
Returns a |
||
method | get(name) | |
Returns a |
Method Summary | ||
---|---|---|
method | clear() | |
Removes all properties from the collection. | ||
method | contains(name) | |
Returns true if a property with the specified name exists in the collection. | ||
method | indexOf(name) | |
Gets the index of a property by name. | ||
method | iterator() | |
method | remove(name) | |
Removes a property with the specified name from the collection. | ||
method | removeAt(index) | |
Removes a property at the specified index. |
Property Getters/Setters Detail |
---|
getCount : int | |
int getCount() |
get : DocumentProperty | |
DocumentProperty get(name) |
Returns null if a property with the specified name is not found.
name
- The case-insensitive name of the property to retrieve.get : DocumentProperty | |
DocumentProperty get(index) |
index
- Zero-based index of the Method Detail |
---|
iterator | |
Iterator iterator() |
contains | |
boolean contains(name) |
name: String
- The case-insensitive name of the property.indexOf | |
int indexOf(name) |
name: String
- The case-insensitive name of the property.remove | |
remove(name) |
name: String
- The case-insensitive name of the property.removeAt | |
removeAt(index) |
index: int
- The zero based index.clear | |
clear() |