Each
Example:
# Instantiate a Workbook object workbook = Workbook("CustomProperties.xlsx") # Retrieve a list of all custom document properties of the Excel file customProperties = workbook.getWorksheets().getCustomDocumentProperties()
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 | add(name, value) | |
Creates a new custom document property of the PropertyType.Boolean data type. | ||
method | add(name, value) | |
Creates a new custom document property of the PropertyType.DateTime data type. | ||
method | add(name, value) | |
Creates a new custom document property of the PropertyType.Float data type. | ||
method | add(name, value) | |
Creates a new custom document property of the PropertyType.Number data type. | ||
method | add(name, value) | |
Creates a new custom document property of the PropertyType.String data type. | ||
method | addLinkToContent(name, source) | |
Creates a new custom document property which links to content. | ||
method | clear() | → inherited from DocumentPropertyCollection |
Removes all properties from the collection. | ||
method | contains(name) | → inherited from DocumentPropertyCollection |
Returns true if a property with the specified name exists in the collection. | ||
method | indexOf(name) | → inherited from DocumentPropertyCollection |
Gets the index of a property by name. | ||
method | iterator() | → inherited from DocumentPropertyCollection |
method | remove(name) | → inherited from DocumentPropertyCollection |
Removes a property with the specified name from the collection. | ||
method | removeAt(index) | → inherited from DocumentPropertyCollection |
Removes a property at the specified index. | ||
method | updateLinkedPropertyValue() | |
Update custom document property value which links to content. | ||
method | updateLinkedRange() | |
Update custom document property value to linked range. |
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 |
---|
add | |
DocumentProperty add(name, value) |
name: String
- The name of the property.value: String
- The value of the property.add | |
DocumentProperty add(name, value) |
name: String
- The name of the property.value: int
- The value of the property.add | |
DocumentProperty add(name, value) |
name: String
- The name of the property.value: DateTime
- The value of the property.add | |
DocumentProperty add(name, value) |
name: String
- The name of the property.value: boolean
- The value of the property.add | |
DocumentProperty add(name, value) |
name: String
- The name of the property.value: float
- The value of the property.addLinkToContent | |
DocumentProperty addLinkToContent(name, source) |
name: String
- The name of the property.source: String
- The source of the propertyupdateLinkedPropertyValue | |
updateLinkedPropertyValue() |
updateLinkedRange | |
updateLinkedRange() |
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() |