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#

 

ITerrainImageLabel66 CreateImageLabel(

       IPosition66   Position,

       string        ImageFileName,

       [ILabelStyle66       LabelStyle = 0],

       [string       GroupID = ""],

       [string       Description = ""])

 

C++

 

HRESULT CreateImageLabel(

        IPosition66 *       Position,

        BSTR  ImageFileName,

        ILabelStyle66       LabelStyle,

        BSTR  GroupID,

        BSTR  Description,

        ITerrainImageLabel66 **   pITerrainImageLabel66) 

 

Parameters

Position

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

ImageFileName

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

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

pITerrainImageLabel66

An ITerrainImageLabel66 representing the newly created Image label.

Exceptions

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