Class ModManager

Manages the Mods in a document. There is one instance of the ModManager in each document and it is owned by the Document.

Since

2.1

Hierarchy (View Summary)

DocumentNode
- ModManager

Implements

Index

Methods

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

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

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

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: Action<TNode>,
): void
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
Type Parameters
- TNode
Parameters
- typeTNode: TypeRefParam<TNode>
  Generic type argument
- action: Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from DocumentNode.ForEachNodeInSubTree

GetVisualizationModsIncludingPinned

GetVisualizationModsIncludingPinned(): System.Collections.Generic.IEnumerable<
ModIdentifier,
>
Enumerates all visualization mods embedded in the document as well as all visualization mods that have been pinned by the current user.

Returns System.Collections.Generic.IEnumerable<ModIdentifier>
The visualization mods available to the current user.

Since
2.1

Extended capability 'LibraryRead'

TryLoadVisualizationModFromLibrary

TryLoadVisualizationModFromLibrary(
    libraryItem: LibraryItem,
    modIdentifier: OutParam<ModIdentifier>,
    exception: OutParam<Exception>,
): boolean
Tries to load a Visualization Mod from the specified libraryItem in the library.
Parameters
- libraryItem: LibraryItem
  The item in the library representing a Visualization Mod.
- modIdentifier: OutParam<ModIdentifier>
  The Spotfire.Dxp.Application.Mods.ModIdentifier for the Visualization Mod that has been loaded, or null.
- exception: OutParam<Exception>
  The exception that occured during load, or null.
Returns boolean
true if the Visualization Mod was successfully loaded, false otherwise.

Since
2.1

Class ModManager

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Extended capability 'LibraryRead'

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

Context

Returns INodeContext

Since

IsAttached

Returns boolean

Since

Transactions

Returns ITransactions

Since

ForEachNodeInSubTree

Type Parameters

Parameters

Returns void

Since

GetVisualizationModsIncludingPinned

Returns System.Collections.Generic.IEnumerable<ModIdentifier>

Since

Extended capability 'LibraryRead'

TryLoadVisualizationModFromLibrary

Parameters

Returns boolean

Since

Settings

On This Page

`Static`Equals