Package com.grapecity.documents.excel

Interface IDocumentPropertyCollection

All Known Subinterfaces:
IBuiltInDocumentPropertyCollection, ICustomDocumentPropertyCollection
public interface IDocumentPropertyCollection
Represents a collection of document properties.

  • Method Details

    • getCount

      int getCount()
      Returns the number of document property in the collection.

    • get

      IDocumentProperty get(String name)
      Returns the IDocumentProperty object with the specified name.
      Parameters:
      name - Specifies the name of an element in the collection.

    • get

      IDocumentProperty get(int index)
      Returns the IDocumentProperty object from a collection.
      Parameters:
      index - Specifies the index of an element in the collection.

    • contains

      boolean contains(String name)
      Determines whether the document property with specified name is contained in IDocumentPropertyCollection.
      Parameters:
      name - The document property name.
      Returns:
      Whether the document property name is contained.

    • clear

      void clear()
      Removes all properties from the collection.

    • indexOf

      int indexOf(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

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

    • removeAt

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