Functions
bool	Labels.Select (Extents BoundingBox, int Tolerance, SelectMode SelectMode, ref object LabelIndices, ref object PartIndices)
	Returns the indices of all labels which are dispalyed in the given part of the map.
Properties
tkLabelAlignment	Labels.Alignment `[get, set]`
	Sets horizontal and vertical alignment of labels.
bool	Labels.AutoOffset `[get, set]`
	Turns on or off the auto offset behavior.
double	Labels.BasicScale `[get, set]`
	Map scale for which the size of labels will be equal to value set in Labels.FontSize property.
tkLabelAlignment	Labels.InboxAlignment `[get, set]`
	Gets or sets the value which defines an alignment of text within label's frame.
tkLineLabelOrientation	Labels.LineOrientation `[get, set]`
	Gets or sets the type of the label's orientation relative to the direction of the labelled shape.
double	Labels.OffsetX `[get, set]`
	Gets or sets the horizontal offset in pixels which is used to draw labels.
double	Labels.OffsetY `[get, set]`
	Gets or sets the vertical offset in pixels which is used to draw labels.
tkLabelPositioning	Labels.Positioning `[get, set]`
	Gets or sets the method of label positioning.
bool	Labels.ScaleLabels `[get, set]`
	Gets or sets the value which indicates whether the labels will change their size depending upon map scale. The default value is false.
tkVerticalPosition	Labels.VerticalPosition `[get, set]`
	Gets or sets the value which affects the sequance of labels drawing relative to the map layers.

Detailed Description

Here is a list of properties and methods which affects alignment, positioning and scale of labels. This module is a part of the documentation of Labels class.

Graph description

Function Documentation

bool Labels.Select	(	Extents	BoundingBox,
		int	Tolerance,
		SelectMode	SelectMode,
		ref object	LabelIndices,
		ref object	PartIndices
	)

Returns the indices of all labels which are dispalyed in the given part of the map.

This property doesn't change appearance of the labels.

Parameters:

BoundingBox	The bounding box in screen coordinates.
Tolerance	The selection tolerance.
SelectMode	The selection mode.
LabelIndices	An output array with indices of the labels.
PartIndices	An output array with indices of parts for each label.

Returns:: True in case at least one label fell into selection.

Examples:: LabelSelection.cs.

Properties

tkLabelAlignment Labels.Alignment [get, set]

Sets horizontal and vertical alignment of labels.

Examples:: SplitByAttribute.cs.

bool Labels.AutoOffset [get, set]

Turns on or off the auto offset behavior.

Wnen set to true, Labels.OffsetX and Labels.OffsetY property will be changed automatically according to the size of symbols for parent shape points to aviod overlaps. Applicable for point and mutipoint shapefiles only.

double Labels.BasicScale [get, set]

Map scale for which the size of labels will be equal to value set in Labels.FontSize property.

Applicable only when Label.Scale is set to true.

tkLabelAlignment Labels.InboxAlignment [get, set]

Gets or sets the value which defines an alignment of text within label's frame.

Should be used with multuline labels.

tkLineLabelOrientation Labels.LineOrientation [get, set]

Gets or sets the type of the label's orientation relative to the direction of the labelled shape.

Applicable for the instance of the Labels class associated with polyline shapefiles, i.e. obtained by Shapefile.Labels property while Shapefile.ShapefileType is polyline.

double Labels.OffsetX [get, set]

Gets or sets the horizontal offset in pixels which is used to draw labels.

When labels are subject to the rotation, "horizontal" means "along the text width".