Each
Example:
//Instantiate a Workbook object $workbook = new cells\Workbook("book1.xlsx"); //Retrieve a list of all custom document properties of the Excel file $customProperties = $workbook->getWorksheets()->getCustomDocumentProperties(); $customProperty1 = $customProperties->get(3); $customProperty2 = $customProperties->get("Owner"); $customProperties->add("test1", "testv1");
Property Getters/Setters Summary | ||
---|---|---|
function | getCount() | |
Gets number of items in the collection. | ||
function | get(index) | |
Returns a |
||
function | get(name) | |
Returns a |
Method Summary | ||
---|---|---|
function | add(name, value) | |
Creates a new custom document property of the PropertyType.Boolean data type. | ||
function | add(name, value) | |
Creates a new custom document property of the PropertyType.DateTime data type. | ||
function | add(name, value) | |
Creates a new custom document property of the PropertyType.Float data type. | ||
function | add(name, value) | |
Creates a new custom document property of the PropertyType.Number data type. | ||
function | add(name, value) | |
Creates a new custom document property of the PropertyType.String data type. | ||
function | addLinkToContent(name, source) | |
Creates a new custom document property which links to content. | ||
function | clear() | → inherited from DocumentPropertyCollection |
Removes all properties from the collection. | ||
function | contains(name) | → inherited from DocumentPropertyCollection |
Returns true if a property with the specified name exists in the collection. | ||
function | indexOf(name) | → inherited from DocumentPropertyCollection |
Gets the index of a property by name. | ||
function | iterator() | → inherited from DocumentPropertyCollection |
function | remove(name) | → inherited from DocumentPropertyCollection |
Removes a property with the specified name from the collection. | ||
function | removeAt(index) | → inherited from DocumentPropertyCollection |
Removes a property at the specified index. | ||
function | updateLinkedPropertyValue() | |
Update custom document property value which links to content. | ||
function | updateLinkedRange() | |
Update custom document property value to linked range. |
Property Getters/Setters Detail |
---|
getCount : Number | |
function getCount() |
get : DocumentProperty | |
function 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 | |
function get(index) |
index
- Zero-based index of the Method Detail |
---|
add | |
function add(name, value) |
name: String
- The name of the property.value: String
- The value of the property.add | |
function add(name, value) |
name: String
- The name of the property.value: Number
- The value of the property.add | |
function add(name, value) |
name: String
- The name of the property.value: DateTime
- The value of the property.add | |
function add(name, value) |
name: String
- The name of the property.value: boolean
- The value of the property.add | |
function add(name, value) |
name: String
- The name of the property.value: Number
- The value of the property.addLinkToContent | |
function addLinkToContent(name, source) |
name: String
- The name of the property.source: String
- The source of the propertyupdateLinkedPropertyValue | |
function updateLinkedPropertyValue() |
updateLinkedRange | |
function updateLinkedRange() |
iterator | |
function iterator() |
contains | |
function contains(name) |
name: String
- The case-insensitive name of the property.indexOf | |
function indexOf(name) |
name: String
- The case-insensitive name of the property.remove | |
function remove(name) |
name: String
- The case-insensitive name of the property.removeAt | |
function removeAt(index) |
index: Number
- The zero based index.clear | |
function clear() |