About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class DocumentProperties

Provides access to the document properties in the document.

Since

2.0

Hierarchy (View Summary)

DocumentNode
- DocumentProperties

Implements

Index

Methods

[iterator] Cast Equals GetEnumerator GetHashCode ToString TryCast Equals

Default capability

AllowWebPlayerResume Context Description IsAttached Keywords Transactions Get Set

Methods

[iterator]

"[iterator]"(): Iterator<DataProperty>
Returns Iterator<DataProperty>

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from DocumentNode.Cast

Equals

Equals(obj: any): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from DocumentNode.Equals

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<DataProperty>
Returns an enumerator that iterates through the collection.

Returns System.Collections.Generic.IEnumerator<DataProperty>
An enumerator that can be used to iterate through the collection.

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from DocumentNode.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from DocumentNode.TryCast

`Static`Equals

Equals(objA: any, objB: any): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from DocumentNode.Equals

Default capability

AllowWebPlayerResume

get AllowWebPlayerResume(): boolean
Gets or sets a value indicating whether the AllowWebPlayerResume property is set for the current document.

Returns boolean
Since
2.0
set AllowWebPlayerResume(value: boolean): void
Parameters
- value: boolean
Returns void

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

Description

get Description(): string
Gets or sets the Description property.

Returns string
Since
2.0
set Description(value: string): void
Parameters
- value: string
Returns void

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

Keywords

get Keywords(): System.Collections.Generic.IList<string>
Gets or sets the Keywords property.

Returns System.Collections.Generic.IList<string>
Since
2.0
set Keywords(value: OrExplicit<System.Collections.Generic.IList<string>>): void
Parameters
- value: OrExplicit<System.Collections.Generic.IList<string>>
Returns void

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

Get

Get(propertyName: string | String): unknown
Gets the value of a named property. Binary data properties are returned as UInt8Array.
Parameters
- propertyName: string | String
  The property name.
Returns unknown
The value of the property.

Since
2.0

Set

Set(propertyName: string | String, value: any): void
Sets the value of a named property. Setting a binary data property expects the value name="value"/> to be an UInt8Array.
Parameters
- propertyName: string | String
  The property name.
- value: any
  The value to set.
Returns void
Since
2.0