GetFigureType()

Summary

Gets the type of a figure window.

 

Changes

Added to version 5.0.

 

Syntax

type = GetFigureType(string figure_name)

 

Argument	Contents
figure_name	The name of the figure, or null for the current figure window.

 

Returns

A string indicating the type of the figure window: "Chart,"  "Intersection,"  "Line Diagram,"  "Prism Map," or  "TIN Figure."

 

Example

// Display the type of a figure window

type = GetFigureType("Prism Map")

ShowMessage("The figure window is a " + type)

 

Error Codes

Error Type	Meaning
NotFound	The specified figure does not exist

 

See Also

Function	Summary
GetWindowType()	Gets the type of the current window
IsWindow()	Determines whether a window is of a given type