Class ColumnSelection

Defines a selection of columns.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- ColumnSelection

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor DataColumnSignatures Expression GetColumns

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 Object.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 Object.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from Object.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 Object.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 Object.Equals

Default capability

constructor

new ColumnSelection(expression): ColumnSelection
Defines the selection by a column search expression.
Parameters
- expression: string | String
  The expression that defines the columns.
Returns ColumnSelection
Since
2.0

Overrides Object.constructor
new ColumnSelection(signatures): ColumnSelection
Defines the selection as a fixed set of columns.
Parameters
- signatures: OrExplicit<System.Collections.Generic.IEnumerable<DataColumnSignature>>
  The signatures of the columns to select.
Returns ColumnSelection
Since
2.0

Overrides Object.constructor

DataColumnSignatures

get DataColumnSignatures(): System.Collections.Generic.ICollection<DataColumnSignature>
Gets the signatures.

Returns System.Collections.Generic.ICollection<DataColumnSignature>
Since
2.0

Expression

get Expression(): string
Gets the expression that selects columns. Returns string.empty if no expression is set.

Returns string
Since
2.0

GetColumns

GetColumns(reader): System.Collections.Generic.IEnumerable<DataRowReaderColumn>
Returns the columns in reader matching this selection.
Parameters
- reader: DataRowReader
  The reader to look for columns in.
Returns System.Collections.Generic.IEnumerable<DataRowReaderColumn>
Any columns matching the selection.

Since
2.0

Class ColumnSelection

Since

Hierarchy (view full)

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

constructor

Parameters

Returns ColumnSelection

Since

Parameters

Returns ColumnSelection

Since

DataColumnSignatures

Returns System.Collections.Generic.ICollection<DataColumnSignature>

Since

Expression

Returns string

Since

GetColumns

Parameters

Returns System.Collections.Generic.IEnumerable<DataRowReaderColumn>

Since

Settings

On This Page

`Static`Equals