CustomDocumentPropertyCollection class

A collection of custom document properties.

Inheritance: CustomDocumentPropertyCollection → DocumentPropertyCollection

The CustomDocumentPropertyCollection type exposes the following members:

Properties

Property	Description
capacity	Gets or sets the number of elements that the array list can contain.

Methods

Method	Description
`get(self, name)`	Returns a `DocumentProperty` object by the name of the property.
`get(self, index)`	Returns a `DocumentProperty` object by index.
`index_of(self, name)`	Gets the index of a property by name.
`index_of(self, item, index)`	Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the array list that extends from the specified index to the last element.
`index_of(self, item, index, count)`	Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the array list that starts at the specified index and contains the specified number of elements.
`copy_to(self, array)`	Copies the entire array list to a compatible one-dimensional array list, starting at the beginning of the target array list.
`copy_to(self, index, array, array_index, count)`	Copies a range of elements from the array list to a compatible one-dimensional array list, starting at the specified index of the target array list.
`last_index_of(self, item)`	Searches for the specified object and returns the zero-based index of the last occurrence within the entire array list.
`last_index_of(self, item, index)`	Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the array list that extends from the first element to the specified index.
`last_index_of(self, item, index, count)`	Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the array list that contains the specified number of elements and ends at the specified index.
`add(self, name, value)`	Creates a new custom document property of the PropertyType.String data type.
`add(self, name, value)`	Creates a new custom document property of the PropertyType.Number data type.
`add(self, name, value)`	Creates a new custom document property of the PropertyType.DateTime data type.
`add(self, name, value)`	Creates a new custom document property of the PropertyType.Boolean data type.
`add(self, name, value)`	Creates a new custom document property of the PropertyType.Float data type.
`binary_search(self, item)`	Searches the entire sorted array list for an element using the default comparer and returns the zero-based index of the element.
`add_link_to_content(self, name, source)`	Creates a new custom document property which links to content.
`update_linked_property_value(self)`	Update custom document property value which links to content.
`update_linked_range(self)`	Update custom document property value to linked range.

Remarks

Each DocumentProperty object represents a custom property of a container document.

Example

from aspose.cells import Workbook

# Instantiate a Workbook object
workbook = Workbook("book1.xls")
# Retrieve a list of all custom document properties of the Excel file
customProperties = workbook.worksheets.custom_document_properties

CustomDocumentPropertyCollection class

CustomDocumentPropertyCollection class

Properties

Methods

Remarks

Example

See Also