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

Class ImageCollection

Represents a collection of images stored in the document.

Since

2.0

Hierarchy (view full)

DocumentNode
- ImageCollection

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context IsAttached Transactions Add Contains Remove TryGetImage

Methods

Cast

Cast<T1, T2>(this, type): 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): 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

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, type): 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, objB): 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

Context

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

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

IsAttached

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

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

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

Add

Add(key, imageData): void
Adds an image to the text area. It can be referenced from the HTML content using the key used as filename.
Parameters
- key: string | String
  The key of the image.
- imageData: Stream
  The image to add. This should be in a format supported by web browsers, for instance PNG or JPG.
Returns void
Since
2.0

Contains

Contains(key): boolean
Gets a value indicating whether the collection contains an image specified by key.
Parameters
- key: string | String
  The key of the image.
Returns boolean
True if the collection contains the image; otherwise False.

Since
2.0

Remove

Remove(key): boolean
Removes the image with the specified key.
Parameters
- key: string | String
  The key of the image to remove.
Returns boolean
True if the image was removed; otherwise False.

Since
2.0

TryGetImage

TryGetImage(key, outputStream): boolean
Tries to get the image with the specified key.
Parameters
- key: string | String
  The key of the image to get.
- outputStream: Stream
  The stream to write image data to.
Returns boolean
True if the image could be found; otherwise False.

Since
2.0