aspose.cells
Class CustomDocumentPropertyCollection

//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");

function getCount()

Gets number of items in the collection.

function get(name)

Returns a DocumentProperty object by the name of the property.

Returns null if a property with the specified name is not found.

Parameters:

name - The case-insensitive name of the property to retrieve.

function get(index)

Returns a DocumentProperty object by index.

Parameters:

index - Zero-based index of the DocumentProperty to retrieve.

function add(name, value)

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

Parameters:

name: String - The name of the property.

value: String - The value of the property.

Returns:

The newly created property object.

function add(name, value)

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

Parameters:

name: String - The name of the property.

value: Number - The value of the property.

Returns:

The newly created property object.

function add(name, value)

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

Parameters:

name: String - The name of the property.

value: DateTime - The value of the property.

Returns:

The newly created property object.

function add(name, value)

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

Parameters:

name: String - The name of the property.

value: boolean - The value of the property.

Returns:

The newly created property object.

function add(name, value)

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

Parameters:

name: String - The name of the property.

value: Number - The value of the property.

Returns:

The newly created property object.

function addLinkToContent(name, source)

Creates a new custom document property which links to content.

Parameters:

name: String - The name of the property.

source: String - The source of the property

Returns:

The newly created property object.

function updateLinkedPropertyValue()

Update custom document property value which links to content.

function updateLinkedRange()

Update custom document property value to linked range.

function iterator()

Returns:

function contains(name)

Returns true if a property with the specified name exists in the collection.

Parameters:

name: String - The case-insensitive name of the property.

Returns:

True if the property exists in the collection; false otherwise.

function indexOf(name)

Gets the index of a property by name.

Parameters:

name: String - The case-insensitive name of the property.

Returns:

The zero based index. Negative value if not found.

function remove(name)

Removes a property with the specified name from the collection.

Parameters:

name: String - The case-insensitive name of the property.

function removeAt(index)

Removes a property at the specified index.

Parameters:

index: Number - The zero based index.

function clear()

Removes all properties from the collection.