ILabelStyle80

A label object can have text, images or both. For more information about TerraExplorer's labels, see "Text and Image Labels" in the TerraExplorer User Manual.

	Properties
	BackgroundColor	An IColor80 representing the label’s background color .
	Bold	Gets and sets a Boolean that determines if the font style is set as bold.
	FontName	Gets and sets the name of the font.
	FontSize	Gets and sets the font size in pixels. The size of the text ranges from 8 point to 72 point.
	FrameFileName	Gets and sets a full pathname or a URL to the frame file that is used as a border for the label.
	IconColor	An IColor80 representing the color of the label’s icon image.
	Italic	Gets and sets a Boolean that determines if the font style is set as italic.
	LimitScreenSize	Gets and sets a Boolean that determines if the label maintains its original size when zooming in.
	LineColor	An IColor80 representing the color of the label’s line to ground.
	LineToGroundLength	Gets and sets the length of the line that extends down from the pivot either to the ground or to a custom length towards the ground.
	LineToGroundType	Gets and sets an enum that determines if a line extends down from the pivot either to the ground or to a custom length towards the ground.
	LockMode	Gets and sets which text label position parameters are adjusted automatically to face the camera and which are locked to the Position group field values.
	MaxImageSize	Gets and sets the maximum size for the label’s image, if it has one.
	MaxViewingHeight	Gets and sets the maximum viewing height at which the label is visible.
	MinViewingHeight	Gets and sets the minimum viewing height at which the label is visible.
	MultilineJustification	Gets and sets the justification of the text if there is more than one line of text.
	PivotAlignment	Gets and sets the alignment of the label relative to its pivot point.
	Scale	Gets and sets the label’s dimensions, in meters per pixel.
	ShowTextBehavior	Gets and sets an enum that determines whether the label text is shown always or only when the mouse cursor is placed above the label.
	SmallestVisibleSize	Gets and sets minimum font height, in pixels, at which the label disappears as you fly away from it.
	TextAlignment	Gets and sets the horizontal and vertical justification of the text with respect to the background.
	TextColor	An IColor80 representing the foreground color of the text.
	TextOnImage	Gets and sets a Boolean that determines if the text appears on the image in the label.
	Underline	Gets and sets a Boolean that determines if the font style is set as underline.

Bold

Gets and sets a Boolean that determines if the font style is set as bold.

JavaScript
Bold

C#
bool Bold { get; set; }

C++

HRESULT Bold([out, retval] VARIANT_BOOL* pVal)

HRESULT Bold([in] VARIANT_BOOL pVal)

FontName

Gets and sets the name of the font.

JavaScript
FontName

C#
string FontName { get; set; }

C++

HRESULT FontName([out, retval] BSTR* pVal)

HRESULT FontName([in] BSTR pVal)

FrameFileName

Gets and sets a full pathname or a URL to the frame file that is used as a border for the label. See "Label Frame File Format" in the TerraExplorer User Manual for more information about the structure of a label frame file.

JavaScript
FrameFileName

C#
string FrameFileName { get; set; }

C++

HRESULT FrameFileName([out, retval] BSTR* pVal)

HRESULT FrameFileName([in] BSTR pVal)

Italic

Gets and sets a Boolean that determines if the font style is set as italic.

JavaScript
Italic

C#
bool Italic { get; set; }

C++

HRESULT Italic([out, retval] VARIANT_BOOL* pVal)

HRESULT Italic([in] VARIANT_BOOL pVal)

LimitScreenSize

Gets and sets a Boolean that determines if the label keeps its original size as one flies closer.

JavaScript
LimitScreenSize

C#
bool LimitScreenSize { get; set; }

C++

HRESULT LimitScreenSize([out, retval] VARIANT_BOOL* pVal)

HRESULT LimitScreenSize([in] VARIANT_BOOL pVal)

LineToGroundLength

Gets and sets the length of the line that extends down from the pivot either to the ground or to a custom length towards the ground.

JavaScript
LineToGroundLength

C#
bool LineToGroundLength { get; set; }

C++

HRESULT LineToGroundLength([out, retval] double* pVal)

HRESULT LineToGroundLength([in] double pVal)

LineToGroundType

Gets and sets an enum that determines if a line extends down from the pivot either to the ground or to a custom length towards the ground. The following are the possible values:

§ LINE_TYPE_NONE = 0
No line to ground is extended from the pivot.

§ LINE_TYPE_TO_GROUND = 1
A line is extended from the pivot down to the ground.

§ LINE_TYPE_CUSTOM = 2
A line is extended from the pivot to a custom length towards the ground.

JavaScript
LineToGroundType

C#
bool LineToGroundType { get; set; }

C++

HRESULT LineToGroundType([out, retval] LineType* pVal)

HRESULT LineToGroundType([in] LineType pVal)

LockMode

Gets and sets which text label position parameters are adjusted automatically to face the camera and which are locked to the Position group field values. Can have one of the following values:

§ LM_DECAL = 0

§ LM_AXIS = 1

§ LM_AXIS_TEXTUP = 2

§ LM_AXIS_AUTOPITCH = 3

§ LM_AXIS_AUTOPITCH_TEXTUP = 4

§ LM_AXIS_AUTOYAW = 5

JavaScript
LockMode

C#
LabelLockMode LockMode { get; set; }

C++

HRESULT LockMode([out, retval] LabelLockMode* pVal)

HRESULT LockMode([in] LabelLockMode pVal)

MaxImageSize

Gets and sets the maximum size of the included image.

JavaScript
MaxImageSize

C#
int MaxImageSize { get; set; }

C++

HRESULT MaxImageSize([out, retval] long* pVal)

HRESULT MaxImageSize([in] long pVal)

MaxViewingHeight

Gets and sets the maximum viewing height at which the label is visible.

JavaScript
MaxViewingHeight

C#
double MaxViewingHeight { get; set; }

C++

HRESULT MaxViewingHeight([out, retval] double* pVal)

HRESULT MaxViewingHeight([in] double pVal)

MinViewingHeight

Gets and sets the minimum viewing height for which the label is visible. When flying lower than the MinViewingHeight, the label disappears.

JavaScript
MinViewingHeight

C#
double MinViewingHeight { get; set; }

C++

HRESULT MinViewingHeight([out, retval] double* pVal)

HRESULT MinViewingHeight([in] double pVal)

MultilineJustification

Gets and sets the justification of the text if there is more than one line of text. The following are possible values: Left, Right or Center. (Default: Center).

JavaScript
MultilineJustification

C#
string MultilineJustification { get; set; }

C++

HRESULT MultilineJustification([out, retval] BSTR* pVal)

HRESULT MultilineJustification([in] BSTR pVal)

PivotAlignment

Gets and sets the alignment of the label relative to its pivot point. The following are possible values: Top, Left; Top, Center; Top, Right; Center, Left; Center, Center; Center, Right; Bottom, Left; Bottom, Center; Bottom, Right.

JavaScript
PivotAlignment

C#
string PivotAlignment { get; set; }

C++

HRESULT PivotAlignment([out, retval] BSTR* pVal)

HRESULT PivotAlignment([in] BSTR pVal)

Scale

Gets and sets the dimensions, in meters per pixel, of the label. The maximum character height is the FontSize times the Scale value.

JavaScript
Scale

C#
double Scale { get; set; }

C++

HRESULT Scale([out, retval] double* pVal)

HRESULT Scale([in] double pVal)

ShowTextBehavior

Gets and sets an enum that determines whether the text of a label that contains image and text is shown always or only when the mouse cursor is placed above the label. The following are the possible values:

§ SHOW_TEXT_ALWAYS = 0
Always display the label’s text.

§ SHOW_TEXT_ON_HOVER = 1
Display the label’s text only when the mouse is hovering over the label’s icon.

JavaScript
ShowTextBehavior

C#
ShowTextOptions ShowTextBehavior { get; set; }

C++

HRESULT ShowTextBehavior([out, retval] ShowTextOptions* pVal)

HRESULT ShowTextBehavior([in] ShowTextOptions pVal)

SmallestVisibleSize

Gets and sets minimum font height, in pixels, at which the label disappears as you fly away from it.

The label can grow to a maximum of the FontSize multiplied by the Scale. After that, the label starts to scale down until it reaches the SmallestVisibleSize, at which point point, it disappears.

JavaScript
SmallestVisibleSize

C#
int SmallestVisibleSize { get; set; }

C++

HRESULT SmallestVisibleSize ([out, retval] long* pVal)

HRESULT SmallestVisibleSize ([in] long pVal)

TextAlignment

Gets and sets the horizontal and vertical justification of the text with respect to the background image. The following are possible values: Left, TopLeft, TopRight, Top, Right, RightBottom, Bottom, BottomLeft (Default: Bottom).

JavaScript
TextAlignment

C#
string TextAlignment { get; set; }

C++

HRESULT TextAlignment([out, retval] BSTR* pVal)

HRESULT TextAlignment([in] BSTR pVal)

TextOnImage

Gets and sets a Boolean that determines if the text appears on the image in the label. Otherwise, the label expands so that the text appears around the image. This parameter is ignored if there is no image set for this label.

JavaScript
TextOnImage

C#
bool TextOnImage { get; set; }

C++

HRESULT TextOnImage([out, retval] VARIANT_BOOL* pVal)

HRESULT TextOnImage([in] VARIANT_BOOL pVal)

Underline

Gets and sets a Boolean that determines if the font style is set as underline.

JavaScript
Underline

C#
bool Underline { get; set; }

C++

HRESULT Underline([out, retval] VARIANT_BOOL* pVal)

HRESULT Underline([in] VARIANT_BOOL pVal)

JavaScript
FontSize