Adds the column.
Namespace: Spotfire.Dxp.Data.VirtualColumns
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
public void AddColumn( string name, DataType dataType, string contentType, string externalId, VirtualColumnInputIdentifier inputIdentifier )
Parameters
- name
- Type: SystemString
The name. - dataType
- Type: Spotfire.Dxp.DataDataType
The data type. - contentType
- Type: SystemString
The content type. - externalId
- Type: SystemString
An identifier for the column. Unlike name this will remain constant throughout the lifetime of column and used to uniquely identify it within the producer. - inputIdentifier
- Type: Spotfire.Dxp.Data.VirtualColumnsVirtualColumnInputIdentifier
The identifier for the collection of inputs for this column. This identifier is declared in the public new abstract class VirtualColumnInputIdentifiers that should be present in each VirtualColumnProducer. It is associated with an VirtualColumnInputCollection through usage of the methods CreateInputs, GetInputs and SetInputs on VirtualColumnProducer. The columns of the same producer can have the same or separate inputs and should then be given the corresponding identifiers here. Once a column is associated with an input collection only values from those inputs will be present in the VirtualValueRequests for values in that column.
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | If name, dataType, externalId, or inputIdentifier are null. |
ArgumentException | If name or externalId are the empty string. |
InvalidOperationException | If this method is not called from ConfigureColumnsCore or the external ids are not unique within the producer. |
Version Information
See Also