TableColumnCollection.SetValueRenderer Method (DataColumn, TypeIdentifier)

TableColumnCollection SetValueRenderer Method (DataColumn, TypeIdentifier)

TIBCO Spotfire 6.5 API Reference

Sets the value renderer for the plot column corresponding to a given data column.

Namespace: Spotfire.Dxp.Application.Visuals
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 14.10.7525.5058 (14.10.7525.5058)

Syntax

C++

Copy to Clipboard Print

public ValueRendererSettings SetValueRenderer(
	DataColumn dataColumn,
	TypeIdentifier rendererIdentifier
)

public ValueRendererSettings SetValueRenderer(
	DataColumn dataColumn,
	TypeIdentifier rendererIdentifier
)

Parameters

dataColumn: Type: Spotfire.Dxp.Data DataColumn
The data column to set the renderer for.

rendererIdentifier: Type: Spotfire.Dxp.Framework.DocumentModel TypeIdentifier
The type identifier of the value renderer to set. ValueRendererTypeIdentifiers.VirtualValueRenderer cannot be used, use VirtualColumnProducers to add virtual values to the table plot.

Return Value

Type: ValueRendererSettings
The newly created value renderer settings.

Exceptions

Exception	Condition
System ArgumentException	Thrown if the rendererIdentifier is VirtualValueRenderer. VirtualValueRenderer is not supported in the table plot, add a virtual column to the plot instead.

Version Information

Supported in: 6.5, 6.0, 5.5, 5.0, 4.5