com.aspose.cells

Class CustomDocumentPropertyCollection

java.lang.Object

com.aspose.cells.CollectionBase

com.aspose.cells.DocumentPropertyCollection

com.aspose.cells.CustomDocumentPropertyCollection

All Implemented Interfaces:

java.lang.Iterable

public class CustomDocumentPropertyCollection
extends DocumentPropertyCollection

A collection of custom document properties.

Remarks

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

Method Summary

Methods

Modifier and Type	Method and Description
DocumentProperty	add(java.lang.String name, boolean value) Creates a new custom document property of the PropertyType.Boolean data type.
DocumentProperty	add(java.lang.String name, DateTime value) Creates a new custom document property of the PropertyType.DateTime data type.
DocumentProperty	add(java.lang.String name, double value) Creates a new custom document property of the PropertyType.Float data type.
DocumentProperty	add(java.lang.String name, int value) Creates a new custom document property of the PropertyType.Number data type.
DocumentProperty	add(java.lang.String name, java.lang.String value) Creates a new custom document property of the PropertyType.String data type.
DocumentProperty	addLinkToContent(java.lang.String name, java.lang.String source) Creates a new custom document property which links to content.
void	updateLinkedPropertyValue() Updates values of all custom properties that are linked to content(use cell value of linked range to update value of custom property).
void	updateLinkedRange() Updates all ranges that are linked to custom properties(use the value of custom document property to update cell value of linked range).

Methods inherited from class com.aspose.cells.DocumentPropertyCollection

contains, get, get, indexOf, remove, removeAt

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

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,
                   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. It should be the name of named range.

Returns:

The newly created property object.

updateLinkedPropertyValue

public void updateLinkedPropertyValue()

Updates values of all custom properties that are linked to content(use cell value of linked range to update value of custom property).

updateLinkedRange

public void updateLinkedRange()

Updates all ranges that are linked to custom properties(use the value of custom document property to update cell value of linked range).