com.aspose.words

Class CustomDocumentProperties

java.lang.Object

com.aspose.words.DocumentPropertyCollection

com.aspose.words.CustomDocumentProperties

All Implemented Interfaces:

java.lang.Iterable

public class CustomDocumentProperties
extends DocumentPropertyCollection

A collection of custom document properties.

To learn more, visit the Work with Document Properties documentation article.

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

The names of the properties are case-insensitive.

The properties in the collection are sorted alphabetically by name.

See Also:

Document, Document.getBuiltInDocumentProperties(), Document.getCustomDocumentProperties()

Method Summary

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, java.util.Date 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.
DocumentProperty	addLinkToContent(java.lang.String name, java.lang.String linkSource) Creates a new linked to content custom document property.

Methods inherited from class com.aspose.words.DocumentPropertyCollection

clear, contains, get, get, getCount, indexOf, iterator, remove, removeAt

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

add

public DocumentProperty add(java.lang.String name,
                            java.lang.String value)

Creates a new custom document property. 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,
                            java.util.Date 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 linkSource)
                                  throws java.lang.Exception

Creates a new linked to content custom document property.

Parameters:

name - The name of the property.

linkSource - The source of the property.

Returns:

The newly created property object or null when the linkSource is invalid.

Throws:

java.lang.Exception