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

Class DataSourcePromptMode

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

Since

2.0

Hierarchy (view full)

Enum
- DataSourcePromptMode

Index

Properties

All None RequiredOnly

Methods

Cast Equals GetHashCode HasFlag ToString TryCast Equals

Default capability

Properties

`Static` `Readonly`All

All: DataSourcePromptMode

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

`Static` `Readonly`None

None: DataSourcePromptMode

Use current settings without prompting the user.

`Static` `Readonly`RequiredOnly

RequiredOnly: DataSourcePromptMode

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

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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Enum.Cast

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.

Inherited from Enum.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from Enum.GetHashCode

HasFlag

HasFlag(flag): boolean
Determines whether one or more bit fields are set in the current instance.
Parameters
- flag: Enum
  An enumeration value.
Returns boolean
true if the bit field or bit fields that are set in flag are also set in the current instance; otherwise, false.

Inherited from Enum.HasFlag

ToString

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

Returns string
A string that represents the current object.

Inherited from Enum.ToString

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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from Enum.TryCast

`Static`Equals

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.

Inherited from Enum.Equals

Default capability

And

And(...rest): this
Perform And operation on enum values.
Parameters
- Rest...rest: Enum[]
  The other enum values.
Returns this
The result.

Since
2.0

Inherited from Enum.And

Or

Or(...rest): this
Perform Or operation on enum values.
Parameters
- Rest...rest: Enum[]
  The other enum values.
Returns this
The result.

Since
2.0

Inherited from Enum.Or

Xor

Xor(...rest): this
Perform Xor operation on enum values.
Parameters
- Rest...rest: Enum[]
  The other enum values.
Returns this
The result.

Since
2.0

Inherited from Enum.Xor