Class DataRowReaderColumnCollection

Represents a collection of the Spotfire.Dxp.Data.DataRowReaderColumns that a Spotfire.Dxp.Data.DataRowReader returns.

Remark

This collection can be retrieved from the Spotfire.Dxp.Data.DataRowReader.Columns property.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- DataRowReaderColumnCollection

Implements

Index

Methods

[iterator] Cast Equals GetHashCode ToString TryCast Equals

Default capability

Item Count FindAll GetEnumerator TryGetColumn TryGetColumnAllowingDifferentTypes

Methods

[iterator]

"[iterator]"(): Iterator<DataRowReaderColumn>
Returns Iterator<DataRowReaderColumn>

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): 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: any): 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: T2, type: TypeRef<T1>): 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: any, objB: any): 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

`Readonly`Item

Item: PropertyGet<number | Int32, DataRowReaderColumn> & PropertyGet<
    string
    | String,
    DataRowReaderColumn,
>

Gets the column with the specified name

Param: name

The name.

Returns

The column with the name.

Since

2.0

Count

get Count(): number
Gets the number of columns.

Returns number
Since
2.0

FindAll

FindAll(
searchExpression: string | String,
): System.Collections.Generic.ICollection<DataRowReaderColumn>
Find all columns that match the search expression.
Parameters
- searchExpression: string | String
  The search expression.
Returns System.Collections.Generic.ICollection<DataRowReaderColumn>
All columns that match the search expression.

Remark
For search syntax see Spotfire user manual.

Since
2.0

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<DataRowReaderColumn>
Returns an enumerator that iterates through the collection.

Returns System.Collections.Generic.IEnumerator<DataRowReaderColumn>
Since
2.0

TryGetColumn

TryGetColumn(
columnName: string | String,
column: OutParam<DataRowReaderColumn>,
): boolean
Try to find a column which matches the column name.
Parameters
- columnName: string | String
  The column name.
- column: OutParam<DataRowReaderColumn>
  Returns the column, the value is undefined if the method returns false.
Returns boolean
true if a column could be found; otherwise false.

Since
2.0
TryGetColumn(
dataColumnSignature: DataColumnSignature,
column: OutParam<DataRowReaderColumn>,
): boolean
Try to find a column which matches the column signature.
Parameters
- dataColumnSignature: DataColumnSignature
  The column signature.
- column: OutParam<DataRowReaderColumn>
  Returns the column, the value is undefined if the method returns false.
Returns boolean
true if a column could be found; otherwise false.

Since
2.0

TryGetColumnAllowingDifferentTypes

TryGetColumnAllowingDifferentTypes(
dataColumnSignature: DataColumnSignature,
column: OutParam<DataRowReaderColumn>,
): boolean
Try to find a column which matches the column signature.
Parameters
- dataColumnSignature: DataColumnSignature
  The column signature.
- column: OutParam<DataRowReaderColumn>
  Returns the column, the value is undefined if the method returns false.
Returns boolean
true if a column could be found; otherwise false.

Since
2.0

Class DataRowReaderColumnCollection

Remark

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

[iterator]

Returns Iterator<DataRowReaderColumn>

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

ReadonlyItem

Param: name

Returns

Since

Count

Returns number

Since

FindAll

Parameters

Returns System.Collections.Generic.ICollection<DataRowReaderColumn>

Remark

Since

GetEnumerator

Returns System.Collections.Generic.IEnumerator<DataRowReaderColumn>

Since

TryGetColumn

Parameters

Returns boolean

Since

Parameters

Returns boolean

Since

TryGetColumnAllowingDifferentTypes

Parameters

Returns boolean

Since

Settings

On This Page

`Static`Equals

`Readonly`Item