DocumentPropertyCollection
Source: aspose.
Base class for BuiltInDocumentPropertyCollection and CustomDocumentPropertyCollection collections.
Methods
clear()
Removes all properties from the collection.
contains(name) → boolean
Returns true if a property with the specified name exists in the collection.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
name |
String |
|
The case-insensitive name of the property. |
- Returns
-
booleanTrue if the property exists in the collection; false otherwise.
get(name)
Returns a DocumentProperty object by the name of the property. Returns null if a property with the specified name is not found.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
name |
String |
|
The case-insensitive name of the property to retrieve. |
get(index)
Returns a DocumentProperty object by index.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
index |
Number |
|
Zero-based index of the |
getCount()
Gets number of items in the collection.
indexOf(name) → Number
Gets the index of a property by name.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
name |
String |
|
The case-insensitive name of the property. |
- Returns
-
NumberThe zero based index. Negative value if not found.
iterator() → Iterator
- Returns
-
Iterator
remove(name)
Removes a property with the specified name from the collection.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
name |
String |
|
The case-insensitive name of the property. |
removeAt(index)
Removes a property at the specified index.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
index |
Number |
|
The zero based index. |