DocumentPropertyCollection
Contents
[
Hide
]DocumentPropertyCollection class
Base class for BuiltInDocumentPropertyCollection and BuiltInDocumentPropertyCollection collections.
class DocumentPropertyCollection;
Methods
| Method | Description |
|---|---|
| contains(string) | Returns true if a property with the specified name exists in the collection. |
| indexOf(string) | Gets the index of a property by name. |
| remove(string) | Removes a property with the specified name from the collection. |
| removeAt(number) | Removes a property at the specified index. |
| getCount() | Gets the number of elements contained in. |
| get(string) | Returns a DocumentProperty object by the name of the property. |
contains(string)
Returns true if a property with the specified name exists in the collection.
contains(name: string) : boolean;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | string | The case-insensitive name of the property. |
Returns
True if the property exists in the collection; false otherwise.
indexOf(string)
Gets the index of a property by name.
indexOf(name: string) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | string | The case-insensitive name of the property. |
Returns
The zero based index. Negative value if not found.
remove(string)
Removes a property with the specified name from the collection.
remove(name: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | string | The case-insensitive name of the property. |
removeAt(number)
Removes a property at the specified index.
removeAt(index: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | The zero based index. |
getCount()
Gets the number of elements contained in.
getCount() : number;
get(string)
Returns a DocumentProperty object by the name of the property.
get(name: string) : DocumentProperty;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | string | The case-insensitive name of the property to retrieve. |
Returns
Remarks
Returns null if a property with the specified name is not found.