VisualCollection.AddNew Method (TypeIdentifier)

VisualCollection AddNew Method (TypeIdentifier)

TIBCO Spotfire 5.5 API Reference

Creates a new Visual with a visual of the type identified by visualTypeId and adds it to the collection.

Namespace: Spotfire.Dxp.Application
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 Visual AddNew(
	TypeIdentifier visualTypeId
)

public Visual AddNew(
	TypeIdentifier visualTypeId
)

Parameters

visualTypeId: Type: Spotfire.Dxp.Framework.DocumentModel TypeIdentifier
The visual type identifier.

Return Value

Type: Visual
The newly created Visual.

Exceptions

Exception	Condition
System ArgumentNullException	If the visualTypeId is null.
System ArgumentException	If the visualTypeId is invalid.

Examples

The following example snippet shows how to add a bar chart to a visual collection.

C++

Copy to Clipboard Print

BarChart chart = page.Visuals.AddNew(VisualTypeIdentifiers.BarChart).As<BarChart>();

BarChart chart = page.Visuals.AddNew(VisualTypeIdentifiers.BarChart).As<BarChart>();

Version Information

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