AddRowsSettings Class

Spotfire 14.3 API Reference

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

Inheritance Hierarchy

SystemObject
Spotfire.Dxp.DataAddRowsSettings

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

Syntax

Copy

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

The AddRowsSettings type exposes the following members.

Constructors

	Name	Description
	AddRowsSettings(IDictionaryDataColumnSignature, DataColumnSignature, IEnumerableDataColumnSignature)	Initializes a new instance of the AddRowsSettings class. Settings for adding rows to a DataTable using the AddRows(DataSource, AddRowsSettings) method.
	AddRowsSettings(DataTable, DataSource)	Initializes a new instance of the AddRowsSettings class. Settings for adding rows to a DataTable using the AddRows(DataSource, AddRowsSettings) method. This Constructor performs an automatic match, no columns are ignored.
	AddRowsSettings(IDictionaryDataColumnSignature, DataColumnSignature, IEnumerableDataColumnSignature, String, String)	Initializes a new instance of the AddRowsSettings class. Settings for adding rows to a DataTable using the AddRows(DataSource, AddRowsSettings) method.
	AddRowsSettings(DataTable, DataSource, String, String)	Initializes a new instance of the AddRowsSettings class. Settings for adding rows to a DataTable using the AddRows(DataSource, AddRowsSettings) method. This Constructor performs an automatic match, no columns are ignored.
	AddRowsSettings(IDictionaryDataColumnSignature, DataColumnSignature, IEnumerableDataColumnSignature, String, String, String)	Initializes a new instance of the AddRowsSettings class. Settings for adding rows to a DataTable using the AddRows(DataSource, AddRowsSettings) method.
	AddRowsSettings(DataTable, DataSource, String, String, String)	Initializes a new instance of the AddRowsSettings class. Settings for adding rows to a DataTable using the AddRows(DataSource, AddRowsSettings) method. This Constructor performs an automatic match, no columns are ignored.

Top

Properties

	Name	Description
	CreateNewSourceColumn	Gets a value indicating whether a new origin column (containing the identifier values) should be created to identify the original and added rows.
	IgnoredColumns	Gets the signatures for the columns in the added data that should not be included in the result.
	Map	Gets the mapping between columns in the original data (keys) and columns in the added data (values).
	NewRowSourceValue	Gets the value (if any) to use to identify the added rows.
	OriginalRowSourceValue	Gets the value (if any) to use to identify the original rows.
	RowSourceColumnName	Gets the name (if any) of the origin column that should be created or used to identify the original and added rows.
	UseExistingSourceColumn	Gets a value indicating whether an existing origin column (containing the identifier values) should be used to identify the original and added rows.

Top

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.)
	WithCreatedRowSourceColumn	Creates a copy of this AddRowsSettings instance, where CreateNewSourceColumn is true.
	WithExistingRowSourceColumn	Creates a copy of this AddRowsSettings instance, where UseExistingSourceColumn is true.
	WithIgnoredColumns	Creates a copy of this AddRowsSettings instance, with new IgnoredColumns.
	WithMap	Creates a copy of this AddRowsSettings instance, with a new Map.
	WithoutRowSourceColumn	Creates a copy of this AddRowsSettings instance, without any RowSourceColumnName where both CreateNewSourceColumn and UseExistingSourceColumn will be false.

Top

Explicit Interface Implementations

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

Top

Version Information

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

Reference

Spotfire.Dxp.Data Namespace