com.aspose.cells
Class CustomDocumentPropertyCollection

java.lang.Object
  CollectionBase
      DocumentPropertyCollection
          com.aspose.cells.CustomDocumentPropertyCollection

All Implemented Interfaces:

java.lang.Iterable

public class CustomDocumentPropertyCollection 
extends DocumentPropertyCollection

//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();

public int getCount()

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.

public DocumentProperty get(int index)

Returns a DocumentProperty object by index.

Parameters:

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

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.

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.

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.

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.

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.

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.

public void updateLinkedPropertyValue()

Update custom document property value which links to content.

public void updateLinkedRange()

Update custom document property value to linked range.

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.

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.

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.

public void removeAt(int index)

Removes a property at the specified index.

Parameters:

index - The zero based index.

public void clear()

public java.util.Iterator iterator()

public boolean contains(java.lang.Object value)

Reserved for internal use.

public int add(java.lang.Object value)

Reserved for internal use.

public int indexOf(java.lang.Object value)

Reserved for internal use.