CreateImageLabel

The CreateImageLabel creates an Image Label in the 3D Window.

Note:    If no text is being added to the label, it is preferable to use this method rather than the generic CreateLabel method.

 

JavaScript
CreateImageLabel(       Position,       ImageFileName,       LabelStyle ,       GroupID ,       Description )

 

C#
ITerrainImageLabel6 CreateImageLabel(       IPosition6 Position,       string   ImageFileName,       ILabelStyle6      LabelStyle = 0,       int      GroupID = 0,       string   Description = "")

 

C++
HRESULT CreateImageLabel(             IPosition6 *            Position,        BSTR                    ImageFileName,        ILabelStyle6            LabelStyle,        LONG_PTR                GroupID,        BSTR                    Description,        ITerrainImageLabel6 **  pITerrainImageLabel6)

 

Parameters

Position

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

ImageFileName

A full pathname or a URL to the image file that appears in the label.

LabelStyle

An ILabelStyle6 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 IProjectTree6.CreateGroup.

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

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

pITerrainImageLabel6

An ITerrainImageLabel6 representing the newly created Image label.

Exceptions

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