Class DocumentMetadata

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

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

FileNameUsedBySave IsDirty LoadedFromFileName LoadedFromLibraryPath

Extended capability 'LibraryRead'

LibraryItemUsedBySave LoadedFromLibraryItem

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

    Returns T1

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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

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

    Returns null | T1

StaticEquals

  • 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.

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

    Since

    2.0

LoadedFromLibraryPath

  • get LoadedFromLibraryPath(): string

  • Gets the library path that the analysis was opened from; otherwise null.

    Returns string

    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

    Since

    2.0

LoadedFromLibraryItem

  • get LoadedFromLibraryItem(): LibraryItem

  • Gets the library item that the analysis was opened from; otherwise null.

    Returns LibraryItem

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability
Extended capability 'LibraryRead'