AddColumnsSettings Class

Spotfire 14.5 API Reference

This class describes the settings used when performing the AddColumns(DataSource, AddColumnsSettings) operation on a DataTable.

Inheritance Hierarchy

System.Object
Spotfire.Dxp.Data.AddColumnsSettings

Namespace: Spotfire.Dxp.Data
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 67.0.20819.4186 (67.0.20819.4186)

Syntax

[SerializableAttribute]
[PersistenceVersionAttribute(31, 0)]
[ImmutableAttribute]
public sealed class AddColumnsSettings : ISerializable

The AddColumnsSettings type exposes the following members.

Constructors

	Name	Description
	AddColumnsSettings(IDictionary<DataColumnSignature, DataColumnSignature>, JoinType, IEnumerable<DataColumnSignature>)	Initializes a new instance of the AddColumnsSettings class. Settings for adding columns to a DataTable using the AddColumns(DataSource, AddColumnsSettings) method.
	AddColumnsSettings(DataTable, DataSource, JoinType)	Initializes a new instance of the AddColumnsSettings class. Settings for adding columns to a DataTable using the AddColumns(DataSource, AddColumnsSettings) method. This method performs an automatic match.
	AddColumnsSettings(IDictionary<DataColumnSignature, DataColumnSignature>, JoinType, IEnumerable<DataColumnSignature>, Boolean)	Initializes a new instance of the AddColumnsSettings class. Settings for adding columns to a DataTable using the AddColumns(DataSource, AddColumnsSettings) method.
	AddColumnsSettings(DataTable, DataSource, JoinType, Boolean)	Initializes a new instance of the AddColumnsSettings class. Settings for adding columns to a DataTable using the AddColumns(DataSource, AddColumnsSettings) method. This method performs an automatic match.

Properties

	Name	Description
	IgnoredColumns	Gets the signatures for the columns in the added data that should be ignored, i.e. not part of the resulting columns.
	JoinType	Gets the type of join to perform.
	Map	Gets the join condition between columns in the original data (keys) and columns in the added data (values).
	TreatEmptyValuesAsEqual	Gets a value indicating whether empty values should be treated as equal when performing the join.

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WithIgnoredColumns	Creates a copy of this AddColumnsSettings instance, with new IgnoredColumns.
	WithJoinType	Creates a copy of this AddColumnsSettings instance, with a new JoinType.
	WithMap	Creates a copy of this AddColumnsSettings instance, with a new Map.
	WithTreatEmptyValuesAsEqual	Creates a copy of this AddColumnsSettings instance, with a new TreatEmptyValuesAsEqual setting.

Explicit Interface Implementations

	Name	Description
	ISerializable.GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object.

Version Information

Supported in: 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8