aspose.cells
Class DocumentPropertyCollection

Base class for BuiltInDocumentPropertyCollection and CustomDocumentPropertyCollection collections.

Property Getters/Setters Summary
functiongetCount()
           Gets number of items in the collection.
functionget(index)
           Returns a DocumentProperty object by index.
functionget(name)
           Returns a DocumentProperty object by the name of the property.
 
Method Summary
functionclear()
           Removes all properties from the collection.
functioncontains(name)
           Returns true if a property with the specified name exists in the collection.
functionindexOf(name)
           Gets the index of a property by name.
functioniterator()
          
functionremove(name)
           Removes a property with the specified name from the collection.
functionremoveAt(index)
           Removes a property at the specified index.
 

Property Getters/Setters Detail

getCount : Number 

function getCount()
Gets number of items in the collection.

get : DocumentProperty 

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.

get : DocumentProperty 

function get(index)
Returns a DocumentProperty object by index.
Parameters:
index - Zero-based index of the DocumentProperty to retrieve.

Method Detail

iterator

function iterator()
Returns:

contains

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.

indexOf

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.

remove

function remove(name)
Removes a property with the specified name from the collection.
Parameters:
name: String - The case-insensitive name of the property.

removeAt

function removeAt(index)
Removes a property at the specified index.
Parameters:
index: Number - The zero based index.

clear

function clear()
Removes all properties from the collection.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.