CreateTextLabel

Creates a text label in the 3D Window.

Note:    If you want to create an image label, use the CreateLabel or CreateImageLabel methods.

 

JavaScript

 

CreateTextLabel(

       Position,

       Text,

       LabelStyle,

       GroupID,

       Description )

 

C#

 

ITerrainLabel66 CreateTextLabel(

       IPosition66 Position,

       string Text,

       [ILabelStyle66 LabelStyle = 0],

       [string GroupID = ""],

       [string Description = ""])

 

C++

 

HRESULT CreateTextLabel(

       IPosition66* Position,

       BSTR Text,

       ILabelStyle66 LabelStyle,

       BSTR GroupID,

       BSTR Description,

       ITerrainLabel66** pITerrainLabel66)

 

Parameters

Position

An IPosition66 representing the position and orientation of the label on the terrain.

Text

The label text.

LabelStyle

An ILabelStyle66 representing the label style (e.g. color, font and viewing distance properties).

GroupID  

The Project Tree group in which the label is created. If it is set to an empty string, the object is created under the root. You can obtain the GroupID by one of the following methods:

·          Create the group using IProjectTree66.CreateGroup.

·          Find the group, if you know the name, using IProjectTree66.FindItem.

·          Traverse the Tree using IProjectTree66 methods such as GetNextItem, until you come to the desired GroupID.

Description

The name of the label as it appears in the Project Tree. If an empty string is passed into this parameter, TerraExplorer assigns it a unique name.

Return Value

pITerrainLabel66 

An ITerrainLabel66 representing the newly created label.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.