Class DataSaveSettings

Container for data-related save settings. This class is set on the Spotfire.Dxp.Data.DataManager class and defines how the data should be stored when saving the document.

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor ConfigurePrompting DataTableSettings EmbedAllSourceData KeepMarkingsTagsAndBookmarks AreApplicable TryGetDataTableSettings

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

constructor

ConfigurePrompting

  • get ConfigurePrompting(): boolean

  • Gets or sets a value indicating whether prompting for settings should be performed for tables with linked data.

    Returns boolean

    Since

    2.0

  • set ConfigurePrompting(value): void

  • Parameters

    • value: boolean

    Returns void

DataTableSettings

EmbedAllSourceData

  • get EmbedAllSourceData(): boolean

  • Gets or sets a value indicating whether all tables with source data shall be saved in embedded mode.

    Returns boolean

    Since

    2.0

  • set EmbedAllSourceData(value): void

  • Parameters

    • value: boolean

    Returns void

KeepMarkingsTagsAndBookmarks

  • get KeepMarkingsTagsAndBookmarks(): boolean

  • Gets or sets a value indicating whether markings, tags and bookmarks shall be kept for tables with linked data.

    Returns boolean

    Since

    2.0

  • set KeepMarkingsTagsAndBookmarks(value): void

  • Parameters

    • value: boolean

    Returns void

AreApplicable

  • AreApplicable(dataManager): boolean

  • Checks if the save settings are applicable to the tables in a given Spotfire.Dxp.Data.DataManager.

    Parameters

    Returns boolean

    True if the settings are applicable.

    Since

    2.0

TryGetDataTableSettings

  • TryGetDataTableSettings(tableId, tableSettings): boolean

  • Try and get the settings for a specified table.

    Parameters

    • tableId: Guid

      The table identifier.

    • tableSettings: OutParam<DataTableSaveSettings>

      The table settings will be assigned to this parameter if found, null will be assigned otherwise.

    Returns boolean

    True is the table was present.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability