CreateTextLabel

The CreateLabel method 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#
ITerrainLabel61 CreateTextLabel(        IPosition61 Position,        string Text,        ILabelStyle61 LabelStyle = 0,        int GroupID = 0,        string Description = "")

 

C++
HRESULT CreateTextLabel(        IPosition61* Position,        BSTR Text,        ILabelStyle61 LabelStyle,        LONG_PTR GroupID,        BSTR Description,        ITerrainLabel61** pITerrainLabel61)

 

Parameters:

Position

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

Text

The label text.

LabelStyle

An ILabelStyle61 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 zero, the object is created under the root. You can obtain the GroupID by one of the following methods:

§  Create the group using IProjectTree61.CreateGroup.

§  Find the group, if you know the name, using IProjectTree61.FindItem.

§  Traverse the Tree using IProjectTree61 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

pITerrainLabel61 

An ITerrainLabel61 representing the newly created label.

Exceptions

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