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

Class DocumentMetadata

Provides access to metadata for the currently opened Spotfire.Dxp.Application.Document.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- DocumentMetadata

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

FileNameUsedBySave IsDirty LoadedFromFileName LoadedFromLibraryPath

Extended capability 'LibraryRead'

LibraryItemUsedBySave LoadedFromLibraryItem

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 Object.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 Object.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from Object.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 Object.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 Object.Equals

Default capability

FileNameUsedBySave

get FileNameUsedBySave(): string
Gets the current file name used by save operations initiated by the user.

Returns string
Since
2.0

IsDirty

get IsDirty(): boolean
Returns true if the document has been changed since it was last saved.

Returns boolean
Since
2.0

LoadedFromFileName

get LoadedFromFileName(): string
Gets the file name that the analysis was opened from; otherwise null.

Returns string
Remark
If there is no analysis open or if the analysis was no loaded from a file, null is returned.

Since
2.0

LoadedFromLibraryPath

get LoadedFromLibraryPath(): string
Gets the library path that the analysis was opened from; otherwise null.

Returns string
Remark
If there is no analysis open or if the analysis was not loaded from the library, null is returned.

Since
2.0

Extended capability 'LibraryRead'

LibraryItemUsedBySave

get LibraryItemUsedBySave(): LibraryItem
Gets the library item that the analysis was last saved to in the library; otherwise null.

Returns LibraryItem
Remark
If there is no analysis open or if the analysis last save operation was not to the library, null is returned.

Since
2.0

LoadedFromLibraryItem

get LoadedFromLibraryItem(): LibraryItem
Gets the library item that the analysis was opened from; otherwise null.

Returns LibraryItem
Remark
If there is no analysis open or if the analysis was not loaded from the library, null is returned.

Since
2.0