Labels visualization

Properties

string Labels.FloatNumberFormat [get, set]
 Gets or sets the formatting to be used for floating point numbers during generation of labels. More...
 
bool Labels.FontBold [get, set]
 Gets or sets the value which indicates whether the font of labels is bold. More...
 
uint Labels.FontColor [get, set]
 Gets or sets the color of the label font. More...
 
uint Labels.FontColor2 [get, set]
 Gets or sets the second color of the label font. It is used to set color gradient for the font. More...
 
tkLinearGradientMode Labels.FontGradientMode [get, set]
 Gets or sets the gradient mode for the labels. More...
 
bool Labels.FontItalic [get, set]
 Gets or sets the value which indicates whether the font of labels is italic. More...
 
string Labels.FontName [get, set]
 Gets or sets the name of the font to draw labels with, e.g. Arial. More...
 
uint Labels.FontOutlineColor [get, set]
 Sets the color of the font outline. More...
 
bool Labels.FontOutlineVisible [get, set]
 Gets or sets the value which indicates whether font outline is visible. The default value is false. More...
 
int Labels.FontOutlineWidth [get, set]
 Gets or sets the width of the font outline. The default value is 1. More...
 
int Labels.FontSize [get, set]
 Gets or sets the size of the font to draw labels with. More...
 
bool Labels.FontStrikeOut [get, set]
 Gets or sets the value which indicates whether the font of labels is struck out. More...
 
int Labels.FontTransparency [get, set]
 Gets or sets the transparency of the font. A values between 0 (transparent) to 255 (opaque) can be used. More...
 
bool Labels.FontUnderline [get, set]
 Gets or sets the value which indicates whether the font of labels is struck out. More...
 
uint Labels.FrameBackColor [get, set]
 Gets or sets the color of the frame's background. More...
 
uint Labels.FrameBackColor2 [get, set]
 Gets or sets the second color of the frame's background. More...
 
tkLinearGradientMode Labels.FrameGradientMode [get, set]
 Gets or sets the type of gradient for the frame of the label. More...
 
uint Labels.FrameOutlineColor [get, set]
 Gets or sets the outline color of the label's frame More...
 
tkDashStyle Labels.FrameOutlineStyle [get, set]
 Gets or sets the outline style of the label's frame. More...
 
int Labels.FrameOutlineWidth [get, set]
 Gets or sets the width of the outline of the label's frame. More...
 
int Labels.FramePaddingX [get, set]
 Gets or sets the horizontal distance between the text of the label and its frame. More...
 
int Labels.FramePaddingY [get, set]
 Gets or sets the vertical distance between the text of the label and its frame. More...
 
int Labels.FrameTransparency [get, set]
 Gets or sets the transparency of the label's frame. A values between 0 (transparent) to 255 (opaque) can be used. More...
 
tkLabelFrameType Labels.FrameType [get, set]
 Gets or sets the shape of the label's frame. More...
 
bool Labels.FrameVisible [get, set]
 Gets or sets the values which indicates whether label's frame is visible. More...
 
uint Labels.HaloColor [get, set]
 Gets or sets the color of the halo around label's text. More...
 
int Labels.HaloSize [get, set]
 Gets or sets the size of the halo drawn around label's text. More...
 
bool Labels.HaloVisible [get, set]
 Gets or sets the value which indicates whether label's halo is visible. More...
 
uint Labels.ShadowColor [get, set]
 Gets or sets the color of the label's shadow. More...
 
int Labels.ShadowOffsetX [get, set]
 Gets or sets the horizontal offset of the label's shadow. More...
 
int Labels.ShadowOffsetY [get, set]
 Gets or sets the vertical offset of the label's shadow. More...
 
bool Labels.ShadowVisible [get, set]
 Gets or sets the value which indicates whether label's shadow is visible. More...
 
tkTextRenderingHint Labels.TextRenderingHint [get, set]
 Gets or sets rendering hint to be used during GDI+ rendering. More...
 

Detailed Description

Here is the list of visualization properties for labels. This module is a part of the documentation of Labels class.

The more details on the topic in the description of the LabelCategory class. The properties listed below are used for all labels without specific visualization category set, i.e. Label.Category == -1;

dot_inline_dotgraph_25.png

Graph description

Properties

◆ FloatNumberFormat

string Labels.FloatNumberFormat
getset

Gets or sets the formatting to be used for floating point numbers during generation of labels.

See acceptable formats in description of C printf function. The commonly used values may be: g (shortest representation), %.2f (two decimal points).

New API 4.9.3:
Added in version 4.9.3

◆ FontBold

bool Labels.FontBold
getset

Gets or sets the value which indicates whether the font of labels is bold.

Examples:
ImageLabels.cs.

◆ FontColor

uint Labels.FontColor
getset

Gets or sets the color of the label font.

◆ FontColor2

uint Labels.FontColor2
getset

Gets or sets the second color of the label font. It is used to set color gradient for the font.

See also
Labels.FontGradientMode

◆ FontGradientMode

tkLinearGradientMode Labels.FontGradientMode
getset

Gets or sets the gradient mode for the labels.

See also
Labels.FontColor2

◆ FontItalic

bool Labels.FontItalic
getset

Gets or sets the value which indicates whether the font of labels is italic.

◆ FontName

string Labels.FontName
getset

Gets or sets the name of the font to draw labels with, e.g. Arial.

◆ FontOutlineColor

uint Labels.FontOutlineColor
getset

Sets the color of the font outline.

See also
Labels.FontOutlineVisible
Examples:
ImageLabels.cs.

◆ FontOutlineVisible

bool Labels.FontOutlineVisible
getset

Gets or sets the value which indicates whether font outline is visible. The default value is false.

Examples:
ImageLabels.cs.

◆ FontOutlineWidth

int Labels.FontOutlineWidth
getset

Gets or sets the width of the font outline. The default value is 1.

See also
FontOutlineVisible
Examples:
ImageLabels.cs.

◆ FontSize

int Labels.FontSize
getset

Gets or sets the size of the font to draw labels with.

Examples:
ImageLabels.cs.

◆ FontStrikeOut

bool Labels.FontStrikeOut
getset

Gets or sets the value which indicates whether the font of labels is struck out.

◆ FontTransparency

int Labels.FontTransparency
getset

Gets or sets the transparency of the font. A values between 0 (transparent) to 255 (opaque) can be used.

The default value is 255. Values which fall outside the specified range will be corrected to the closest acceptable value without reporting an error.

◆ FontUnderline

bool Labels.FontUnderline
getset

Gets or sets the value which indicates whether the font of labels is struck out.

◆ FrameBackColor

uint Labels.FrameBackColor
getset

Gets or sets the color of the frame's background.

◆ FrameBackColor2

uint Labels.FrameBackColor2
getset

Gets or sets the second color of the frame's background.

, Labels.FrameGradientMode

◆ FrameGradientMode

tkLinearGradientMode Labels.FrameGradientMode
getset

Gets or sets the type of gradient for the frame of the label.

For all values other than gmNone a gradient starting from Labels.FrameBackColor and ending by Labels.FrameBackColor2 will be applied.

◆ FrameOutlineColor

uint Labels.FrameOutlineColor
getset

Gets or sets the outline color of the label's frame

◆ FrameOutlineStyle

tkDashStyle Labels.FrameOutlineStyle
getset

Gets or sets the outline style of the label's frame.

◆ FrameOutlineWidth

int Labels.FrameOutlineWidth
getset

Gets or sets the width of the outline of the label's frame.

◆ FramePaddingX

int Labels.FramePaddingX
getset

Gets or sets the horizontal distance between the text of the label and its frame.

◆ FramePaddingY

int Labels.FramePaddingY
getset

Gets or sets the vertical distance between the text of the label and its frame.

◆ FrameTransparency

int Labels.FrameTransparency
getset

Gets or sets the transparency of the label's frame. A values between 0 (transparent) to 255 (opaque) can be used.

The default value is 255. Values which fall outside the specified range will be corrected to the closest acceptable value without reporting an error.

◆ FrameType

tkLabelFrameType Labels.FrameType
getset

Gets or sets the shape of the label's frame.

Examples:
LabelSelection.cs, and ToolTip.cs.

◆ FrameVisible

bool Labels.FrameVisible
getset

Gets or sets the values which indicates whether label's frame is visible.

Examples:
LabelSelection.cs, and ToolTip.cs.

◆ HaloColor

uint Labels.HaloColor
getset

Gets or sets the color of the halo around label's text.

See also
Labels.HaloVisible

◆ HaloSize

int Labels.HaloSize
getset

Gets or sets the size of the halo drawn around label's text.

See also
Labels.HaloVisible

◆ HaloVisible

bool Labels.HaloVisible
getset

Gets or sets the value which indicates whether label's halo is visible.

◆ ShadowColor

uint Labels.ShadowColor
getset

Gets or sets the color of the label's shadow.

See also
ShadowVisible

◆ ShadowOffsetX

int Labels.ShadowOffsetX
getset

Gets or sets the horizontal offset of the label's shadow.

See also
ShadowVisible

◆ ShadowOffsetY

int Labels.ShadowOffsetY
getset

Gets or sets the vertical offset of the label's shadow.

See also
ShadowVisible

◆ ShadowVisible

bool Labels.ShadowVisible
getset

Gets or sets the value which indicates whether label's shadow is visible.

◆ TextRenderingHint

tkTextRenderingHint Labels.TextRenderingHint
getset

Gets or sets rendering hint to be used during GDI+ rendering.

This property will be ignored if GlobalSettings.AutoChooseRenderingHintForLabels is set to true.

Examples:
MinimalDistance.cs.