CustomDocumentProperties

CustomDocumentProperties

Overview

CustomDocumentProperties is a class in Aspose.Words FOSS for Java. Inherits from: DocumentPropertyCollection.

A collection of custom document properties.

Edition status of its 11 listed members (a property and its accessor methods are listed separately, overloads once): 11 not yet exercised by a verified example.

This class declares 15 methods for CustomDocumentProperties objects in Java programs. Available methods include: add, addLinkToContent, clear, contains, get, getCount, indexOf, iterator, remove, removeAt. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: count.

Properties

NameTypeAccessDescription
countintReadGets number of items in the collection.

Methods

SignatureDescription
add(name: String, value: String) → DocumentPropertyCreates a new custom document property of the PropertyType.STRING data type.
add(name: String, value: int) → DocumentPropertyCreates a new custom document property of the PropertyType.NUMBER data type.
add(name: String, value: java.util.Date) → DocumentPropertyCalls add(name, value) on this CustomDocumentProperties instance.
add(name: String, value: boolean) → DocumentPropertyCreates a new custom document property of the PropertyType.BOOLEAN data type.
add(name: String, value: double) → DocumentPropertyCreates a new custom document property of the PropertyType.DOUBLE data type.
addLinkToContent(name: String, linkSource: String) → DocumentPropertyCreates a new linked to content custom document property.
getCount() → intGets number of items in the collection.
get(name: String) → DocumentPropertyReturns a DocumentProperty object by the name of the property.
get(index: int) → DocumentPropertyReturns a DocumentProperty object by index.
iterator() → Iterator<DocumentProperty>Returns an iterator object that can be used to iterate over all items in the collection.
contains(name: String) → booleanReturns true if a property with the specified name exists in the collection.
indexOf(name: String) → intGets the index of a property by name.
remove(name: String)Removes a property with the specified name from the collection.
removeAt(index: int)Removes a property at the specified index.
clear()Removes all properties from the collection.

See Also