com.aspose.cells

com.aspose.cells

Class DocumentPropertyCollection

  • java.lang.Object
    • com.aspose.cells.DocumentPropertyCollection
Base class for BuiltInDocumentPropertyCollection and CustomDocumentPropertyCollection collections.

Example:

//Instantiate a Workbook object by calling its empty constructor
Workbook workbook = new Workbook("book1.xls");

//Retrieve a list of all custom document properties of the Excel file
DocumentPropertyCollection customProperties = workbook.getWorksheets().getCustomDocumentProperties();

//Accessng a custom document property by using the property index
DocumentProperty customProperty1 = customProperties.get(3);

//Accessng a custom document property by using the property name
DocumentProperty customProperty2 = customProperties.get("Owner");

Property Getters/Setters Summary
intgetCount()
Gets number of items in the collection.
DocumentPropertyget(int index)
Returns a DocumentProperty object by index.
DocumentPropertyget(java.lang.String name)
Returns a DocumentProperty object by the name of the property.
 
Method Summary
voidclear()
Removes all properties from the collection.
booleancontains(java.lang.String name)
Returns true if a property with the specified name exists in the collection.
intindexOf(java.lang.String name)
Gets the index of a property by name.
java.util.Iteratoriterator()
voidremove(java.lang.String name)
Removes a property with the specified name from the collection.
voidremoveAt(int index)
Removes a property at the specified index.
 

    • Property Getters/Setters Detail

      • getCount

        public int getCount()
        Gets number of items in the collection.

      • get

        public DocumentProperty get(java.lang.String 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.

    • Method Detail

      • iterator

        public java.util.Iterator iterator()
        Returns:

      • contains

        public boolean contains(java.lang.String name)
        Returns true if a property with the specified name exists in the collection.
        Parameters:
        name - The case-insensitive name of the property.
        Returns:
        True if the property exists in the collection; false otherwise.

      • indexOf

        public int indexOf(java.lang.String name)
        Gets the index of a property by name.
        Parameters:
        name - The case-insensitive name of the property.
        Returns:
        The zero based index. Negative value if not found.

      • remove

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

      • removeAt

        public void removeAt(int index)
        Removes a property at the specified index.
        Parameters:
        index - The zero based index.

      • clear

        public void clear()
        Removes all properties from the collection.