ShapeMap3D.TryGetShape Method

ShapeMap3D TryGetShape Method

TIBCO Spotfire 5.5 API Reference

Tries to get the shape for a given category, returning true upon success.

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 bool TryGetShape(
	CategoryKey category,
	out Shape3D shape
)

public bool TryGetShape(
	CategoryKey category,
	out Shape3D shape
)

Parameters

category: Type: Spotfire.Dxp.Application.Visuals CategoryKey
A CategoryKey object identifying the category.

shape: Type: Spotfire.Dxp.Application.Visuals Shape3D
When this method returns, contains the shape associated with the specified category, if one is found; otherwise null.

Return Value

Type: Boolean
true if this instance contains a shape for the specified category; otherwise, false.

Version Information

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