Action
    Preparing search index...

    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.

    2.0

    Hierarchy (View Summary)

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    constructor ConfigurePrompting DataTableSettings EmbedAllSourceData KeepMarkingsTagsAndBookmarks AreApplicable TryGetDataTableSettings

    Methods

    • 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

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

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • 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

    • 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

    • get ConfigurePrompting(): boolean

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

      Returns boolean

      2.0

    • set ConfigurePrompting(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get EmbedAllSourceData(): boolean

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

      Returns boolean

      2.0

    • set EmbedAllSourceData(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get KeepMarkingsTagsAndBookmarks(): boolean

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

      Returns boolean

      Note that you need to specify a primary key on the corresponding tables in order for this to work.

      2.0

    • set KeepMarkingsTagsAndBookmarks(value: boolean): void

      Parameters

      • value: boolean

      Returns void

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

      2.0

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

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability