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

Class ColumnsChangedResult

This is a report on the changes in a Spotfire.Dxp.Data.DataTable after a large operation such as ReplaceData(dataSource) is performed. It should be used to notify the user of the changes.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- ColumnsChangedResult

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

AddedColumns ColumnMismatch InvalidatedColumns InvalidatedHierarchies NameChanges NoMatchingColumns PrimaryKeyMismatch RemovedColumns TypeChanges

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

AddedColumns

get AddedColumns(): System.Collections.Generic.IList<string>
Gets the names of the added columns.

Returns System.Collections.Generic.IList<string>
Since
2.0

ColumnMismatch

get ColumnMismatch(): boolean
Gets a value indicating whether some columns match, but not all, or not. Column additions do not count as mismatches.

Returns boolean
Since
2.0

InvalidatedColumns

get InvalidatedColumns(): System.Collections.Generic.IList<string>
Gets the names of the invalidated columns.

Returns System.Collections.Generic.IList<string>
Since
2.0

InvalidatedHierarchies

get InvalidatedHierarchies(): System.Collections.Generic.IList<string>
Gets the names of the invalidated hierarchies.

Returns System.Collections.Generic.IList<string>
Since
2.0

NameChanges

get NameChanges(): System.Collections.Generic.IList<string[]>
Gets the old and new names of the renamed columns. A list of string arrays with two elements, the first element is the old name and the second is the new name.

Returns System.Collections.Generic.IList<string[]>
Since
2.0

NoMatchingColumns

get NoMatchingColumns(): boolean
Gets a value indicating whether no columns match or not.

Returns boolean
Since
2.0

PrimaryKeyMismatch

get PrimaryKeyMismatch(): boolean
Gets a value indicating whether the primary key could not be matched to the new data set or not.

Returns boolean
Since
2.0

RemovedColumns

get RemovedColumns(): System.Collections.Generic.IList<string>
Gets the names of the removed columns.

Returns System.Collections.Generic.IList<string>
Since
2.0

TypeChanges

get TypeChanges(): System.Collections.Generic.IList<string[]>
Gets the name, old type name, and new type name for all columns that have changed their data type. A list of string arrays with three elements, the first element is the name, the second is the old type name and the third is the new type name.

Returns System.Collections.Generic.IList<string[]>
Since
2.0