Action
    Preparing search index...

    Class DataSourcePromptMode

    Defines how a Spotfire.Dxp.Data.DataSource should prompt a user for settings when loading data.

    Note that the application can run in a mode where it is not allowed to show a UI.

    2.0

    Hierarchy (View Summary)

    Index

    Properties

    All None RequiredOnly

    Methods

    Cast Equals GetHashCode HasFlag ToString TryCast Equals

    Default capability

    And Or Xor

    Properties

    All: Spotfire.Dxp.Data.DataSourcePromptMode

    The user should be prompted for input if applicable. The current settings should be used as default.

    None: Spotfire.Dxp.Data.DataSourcePromptMode

    Use current settings without prompting the user.

    RequiredOnly: Spotfire.Dxp.Data.DataSourcePromptMode

    The user should be prompted for required information not included in the current settings. Optional settings should not be prompted.

    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.

    • Determines whether one or more bit fields are set in the current instance.

      Parameters

      Returns boolean

      true if the bit field or bit fields that are set in flag are also set in the current instance; otherwise, false.

    • 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 T1 | null

    • 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

    • Perform And operation on enum values.

      Parameters

      Returns this

      The result.

      2.0

    • Perform Or operation on enum values.

      Parameters

      Returns this

      The result.

      2.0

    • Perform Xor operation on enum values.

      Parameters

      Returns this

      The result.

      2.0

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    Default capability