ExpressionDetailItem.SetValueRenderer Method

ExpressionDetailItem SetValueRenderer Method

TIBCO Spotfire 5.5 API Reference

Sets the renderer for the detail (tooltip) item.

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

Syntax

C++

Copy to Clipboard Print

public ValueRendererSettings SetValueRenderer(
	TypeIdentifier typeId
)

public ValueRendererSettings SetValueRenderer(
	TypeIdentifier typeId
)

Parameters

typeId: Type: Spotfire.Dxp.Framework.DocumentModel TypeIdentifier
The type id of the renderer to use.

Return Value

Type: ValueRendererSettings
The renderer settings associated with the type id.

Exceptions

Exception	Condition
System ArgumentNullException	Throws ArgumentNullException if typeId is null.
System ArgumentException	Thrown if typeId is not a type identifier for a registered ValueRenderer.

Examples

The following example snippet shows how to set the renderer for the expressionDetailItem to the geometry renderer.

C++

Copy to Clipboard Print

GeometryRendererSettings geometryRendererSettings = (GeometryRendererSettings)expressionDetailItem.SetRenderer(ValueRendererTypeIdentifiers.GeometryRenderer);
geometryRendererSettings.BorderColor = Color.Red;

GeometryRendererSettings geometryRendererSettings = (GeometryRendererSettings)expressionDetailItem.SetRenderer(ValueRendererTypeIdentifiers.GeometryRenderer);
geometryRendererSettings.BorderColor = Color.Red;

Version Information

Supported in: 5.5, 5.0, 4.5, 4.0, 3.3