com.aspose.cells

com.aspose.cells

Class CustomDocumentPropertyCollection

A collection of custom document properties.

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

Example:

//Instantiate a Workbook object
Workbook workbook = new Workbook("book1.xls");

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

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
DocumentPropertyadd(java.lang.String name, boolean value)
Creates a new custom document property of the PropertyType.Boolean data type.
DocumentPropertyadd(java.lang.String name, com.aspose.cells.DateTime value)
Creates a new custom document property of the PropertyType.DateTime data type.
DocumentPropertyadd(java.lang.String name, double value)
Creates a new custom document property of the PropertyType.Float data type.
DocumentPropertyadd(java.lang.String name, int value)
Creates a new custom document property of the PropertyType.Number data type.
DocumentPropertyadd(java.lang.String name, java.lang.String value)
Creates a new custom document property of the PropertyType.String data type.
DocumentPropertyaddLinkToContent(java.lang.String name, java.lang.String source)
Creates a new custom document property which links to content.
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.
voidupdateLinkedPropertyValue()
Update custom document property value which links to content.
voidupdateLinkedRange()
Update custom document property value to linked range.
 

    • 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

      • add

        public DocumentProperty add(java.lang.String name, java.lang.String value)
        Creates a new custom document property of the PropertyType.String data type.
        Parameters:
        name - The name of the property.
        value - The value of the property.
        Returns:
        The newly created property object.

      • add

        public DocumentProperty add(java.lang.String name, int value)
        Creates a new custom document property of the PropertyType.Number data type.
        Parameters:
        name - The name of the property.
        value - The value of the property.
        Returns:
        The newly created property object.

      • add

        public DocumentProperty add(java.lang.String name, com.aspose.cells.DateTime value)
        Creates a new custom document property of the PropertyType.DateTime data type.
        Parameters:
        name - The name of the property.
        value - The value of the property.
        Returns:
        The newly created property object.

      • add

        public DocumentProperty add(java.lang.String name, boolean value)
        Creates a new custom document property of the PropertyType.Boolean data type.
        Parameters:
        name - The name of the property.
        value - The value of the property.
        Returns:
        The newly created property object.

      • add

        public DocumentProperty add(java.lang.String name, double value)
        Creates a new custom document property of the PropertyType.Float data type.
        Parameters:
        name - The name of the property.
        value - The value of the property.
        Returns:
        The newly created property object.

      • addLinkToContent

        public DocumentProperty addLinkToContent(java.lang.String name, java.lang.String source)
        Creates a new custom document property which links to content.
        Parameters:
        name - The name of the property.
        source - The source of the property
        Returns:
        The newly created property object.

      • updateLinkedPropertyValue

        public void updateLinkedPropertyValue()
        Update custom document property value which links to content.

      • updateLinkedRange

        public void updateLinkedRange()
        Update custom document property value to linked range.

      • 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.