TableColumnCollection.SetValueRenderer Method (VirtualColumn, TypeIdentifier)

TableColumnCollection SetValueRenderer Method (VirtualColumn, TypeIdentifier)

TIBCO Spotfire 6.0 API Reference

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

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

Syntax

C++

Copy to Clipboard Print

public ValueRendererSettings SetValueRenderer(
	VirtualColumn virtualColumn,
	TypeIdentifier rendererIdentifier
)

public ValueRendererSettings SetValueRenderer(
	VirtualColumn virtualColumn,
	TypeIdentifier rendererIdentifier
)

Parameters

virtualColumn: Type: Spotfire.Dxp.Data.VirtualColumns VirtualColumn
The virtual 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.