Adds the column.
Namespace: Spotfire.Dxp.Data.VirtualColumnsAssembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 18.10.8513.5432 (18.10.8513.5432)
Syntax
Parameters
- name
- Type: System String
The name.
- dataType
- Type: Spotfire.Dxp.Data DataType
The data type.
- contentType
- Type: System String
The content type.
- externalId
- Type: System String
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.VirtualColumns VirtualColumnInputIdentifier
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.
- properties
- Type: Spotfire.Dxp.Data DataColumnProperties
A collection of any extra properties.
Exceptions
Exception | Condition |
---|---|
System ArgumentNullException | If name, dataType, externalId, inputIdentifier or properties are null. |
System ArgumentException | If name or externalId are the empty string. |
System InvalidOperationException | If this method is not called from ConfigureColumnsCore or the external ids are not unique within the producer. |
Remarks
Version Information
See Also