com.aspose.cells

Class DocumentPropertyCollection

java.lang.Object

com.aspose.cells.CollectionBase

com.aspose.cells.DocumentPropertyCollection

All Implemented Interfaces:

java.lang.Iterable

Direct Known Subclasses:

BuiltInDocumentPropertyCollection, CustomDocumentPropertyCollection

public abstract class DocumentPropertyCollection
extends CollectionBase

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");
 

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(java.lang.String name) Returns true if a property with the specified name exists in the collection.
DocumentProperty	get(int index) Returns a DocumentProperty object by index.
DocumentProperty	get(java.lang.String name) Returns a DocumentProperty object by the name of the property.
int	indexOf(java.lang.String name) Gets the index of a property by name.
void	remove(java.lang.String name) Removes a property with the specified name from the collection.
void	removeAt(int index) Removes a property at the specified index.

Methods inherited from class com.aspose.cells.CollectionBase

add, clear, contains, getCount, indexOf, iterator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

public DocumentProperty get(java.lang.String name)

Returns a DocumentProperty object by the name of the property.

Remarks

Returns null if a property with the specified name is not found.

Parameters:

name - The case-insensitive name of the property to retrieve.

get

public DocumentProperty get(int index)

Returns a DocumentProperty object by index.

Overrides:

get in class CollectionBase

Parameters:

index - Zero-based index of the DocumentProperty to retrieve.

Returns:

The item at specified position.

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.

Overrides:

removeAt in class CollectionBase

Parameters:

index - The zero based index.