Drawing labels

Functions
void	AxMap.AddDrawingLabel (int DrawHandle, string Text, uint Color, double x, double y, tkHJustification hJustification)
	Adds label to the specified drawing layer.
void	AxMap.AddDrawingLabelEx (int DrawHandle, string Text, uint Color, double x, double y, tkHJustification hJustification, double Rotation)
	Adds label to the specified drawing layer. Angle of rotation is accepted.
void	AxMap.ClearDrawingLabels (int DrawHandle)
	Clears labels on the specified drawing layer.
void	AxMap.DrawingFont (int DrawHandle, string FontName, int FontSize)
	Sets the font for the labels of the drawing layer.
Labels	AxMap.get_DrawingLabels (int DrawingLayerIndex)
	Gets labels associated with the drawing layer.
int	AxMap.get_DrawingLabelsOffset (int DrawHandle)
	Gets the vertical offset of the labels for the specified drawing layer in pixels.
bool	AxMap.get_DrawingLabelsScale (int DrawHandle)
	Gets a boolean value which indicates whether the labels of the drawing layer will be scaled.
bool	AxMap.get_DrawingLabelsShadow (int DrawHandle)
	Gets a boolean value which indicates whether a shadow will be displayed for the labels of the drawing layer.
uint	AxMap.get_DrawingLabelsShadowColor (int DrawHandle)
	Gets the color of the shadow for the labels of the specified drawing layer.
bool	AxMap.get_DrawingLabelsVisible (int DrawHandle)
	Gets a boolean value which indicates whether labels of the drawing layer are visible.
bool	AxMap.get_UseDrawingLabelCollision (int DrawHandle)
	Gets a boolean value which indicates whether overlapping labels will be allowed for drawing layer.
void	AxMap.GetDrawingStandardViewWidth (int DrawHandle, ref double Width)
	Gets the value which affects the scaling of labels.
void	AxMap.set_DrawingLabels (int DrawingLayerIndex, Labels __p2)
	Replaces the labels associated with the drawing layer.
void	AxMap.set_DrawingLabelsOffset (int DrawHandle, int __p2)
	Sets the vertical offset of the labels for the specified drawing layer in pixels.
void	AxMap.set_DrawingLabelsScale (int DrawHandle, bool __p2)
	Sets a boolean value which indicates whether the labels of the drawing layer will be scaled.
void	AxMap.set_DrawingLabelsShadow (int DrawHandle, bool __p2)
	Sets a boolean value which indicates whether a shadow will be displayed for the labels of the drawing layer.
void	AxMap.set_DrawingLabelsShadowColor (int DrawHandle, uint __p2)
	Sets the color of the shadow for the labels of the specified drawing layer.
void	AxMap.set_DrawingLabelsVisible (int DrawHandle, bool __p2)
	Sets a boolean value which indicates whether labels of the drawing layer are visible.
void	AxMap.set_UseDrawingLabelCollision (int DrawHandle, bool __p2)
	Sets a boolean value which indicates whether overlapping labels will be allowed for drawing layer.

---

Detailed Description

Here is a list of properties and methods to add and remove labels on drawing layer of the map. It's possible to change even more properties using instance of Labels class obtained by AxMap.get_DrawingLabels() property. This module is a part of the documentation of AxMap class.

Graph description

---

Function Documentation

void AxMap.AddDrawingLabel	(	int	DrawHandle,
		string	Text,
		uint	Color,
		double	x,
		double	y,
		tkHJustification	hJustification
	)

Adds label to the specified drawing layer.

This method corresponds to the Labels.AddLabel method.

Parameters:

DrawHandle	The handle of the drawing layer returned by AxMap.NewDrawing method.
Text	The text of the label.
Color	The color of the label.
x	The x coordinate of the label.
y	The y coordinate of the label.
hJustification	The justification of the label.

void AxMap.AddDrawingLabelEx	(	int	DrawHandle,
		string	Text,
		uint	Color,
		double	x,
		double	y,
		tkHJustification	hJustification,
		double	Rotation
	)

Adds label to the specified drawing layer. Angle of rotation is accepted.

This method corresponds to the Labels.AddLabel method.

Parameters:

DrawHandle	The handle of the drawing layer returned by AxMap.NewDrawing method.
Text	The text of the label.
Color	The color of the label.
x	The x coordinate of the label.
y	The y coordinate of the label.
hJustification	The justification of the label.
Rotation	The angle of rotation in degrees.

Examples:

SplitByAttribute.cs.

void AxMap.ClearDrawingLabels

(

int

DrawHandle

)

Clears labels on the specified drawing layer.

Parameters:

DrawHandle

The handle of the drawing layer returned by AxMap.NewDrawing method.

void AxMap.DrawingFont	(	int	DrawHandle,
		string	FontName,
		int	FontSize
	)

Sets the font for the labels of the drawing layer.

Parameters:

DrawHandle	The handle of the drawing layer returned by AxMap.NewDrawing method.
FontName	The name of the font.
FontSize	The size of the font.

Labels AxMap.get_DrawingLabels

(

int

DrawingLayerIndex

)

Gets labels associated with the drawing layer.

Parameters:

DrawingLayerIndex

The handle of the drawing layer returned by AxMap.NewDrawing method.

Returns:

The reference to the Labels class or NULL reference on the invalid handle.

Examples:

SplitByAttribute.cs, and ToolTip.cs.

int AxMap.get_DrawingLabelsOffset

(

int

DrawHandle

)

Gets the vertical offset of the labels for the specified drawing layer in pixels.

Parameters:

DrawHandle

The index of the drawing layer returned by AxMap.NewDrawing method.

Returns:

The offset in pixels.

Deprecated:

v. 4.8. Use AxMap.get_DrawingLabels and Labels.OffsetX, Labels.OffsetY instead.

bool AxMap.get_DrawingLabelsScale

(

int

DrawHandle

)

Gets a boolean value which indicates whether the labels of the drawing layer will be scaled.

This property corresponds to the Labels.ScaleLabels property.

Parameters:

DrawHandle

he index of the drawing layer returned by AxMap.NewDrawing method.

Returns:

True if the labels are scaled and false otherwise.

bool AxMap.get_DrawingLabelsShadow

(

int

DrawHandle

)

Gets a boolean value which indicates whether a shadow will be displayed for the labels of the drawing layer.

This property corresponds to the Labels.HaloVisible property.

Parameters:

DrawHandle

The handle of the drawing layer returned by AxMap.NewDrawing method.

Returns:

True if the shadow is displayed and false otherwise.

uint AxMap.get_DrawingLabelsShadowColor

(

int

DrawHandle

)

Gets the color of the shadow for the labels of the specified drawing layer.

This property corresponds to the Labels.HaloColor property.

Parameters:

DrawHandle

The handle of the drawing layer returned by AxMap.NewDrawing method.

Returns:

The color of shadow.

bool AxMap.get_DrawingLabelsVisible

(

int

DrawHandle

)

Gets a boolean value which indicates whether labels of the drawing layer are visible.

This property corresponds to the Labels.Visible property.

Parameters:

DrawHandle

The handle of the drawing layer returned by AxMap.NewDrawing method.

Returns:

True in case labels are visible and false otherwise.

bool AxMap.get_UseDrawingLabelCollision

(

int

DrawHandle

)

Gets a boolean value which indicates whether overlapping labels will be allowed for drawing layer.

This property corresponds to the Labels.AvoidCollisions property.

Parameters:

DrawHandle

The handle of the drawing layer returned by AxMap.NewDrawing method.

Returns:

True in case overlapping labels are removed and false otherwise.

void AxMap.GetDrawingStandardViewWidth	(	int	DrawHandle,
		ref double	Width
	)

Gets the value which affects the scaling of labels.

Parameters:

DrawHandle	The handle of the drawing layer returned by AxMap.NewDrawing method.
Width	The standard width of the view in pixels to use normal size of labels.

Deprecated:

v 4.8. Use Labels.ScaleLabels, Labels.BaseScale instead.

void AxMap.set_DrawingLabels	(	int	DrawingLayerIndex,
		Labels	__p2
	)

Replaces the labels associated with the drawing layer.

Parameters:

DrawingLayerIndex	The handle of the drawing layer returned by AxMap.NewDrawing method.
__p2	The new instance of the Labels class to associate with the layer.

void AxMap.set_DrawingLabelsOffset	(	int	DrawHandle,
		int	__p2
	)

Sets the vertical offset of the labels for the specified drawing layer in pixels.

Parameters:

DrawHandle	The index of the drawing layer returned by AxMap.NewDrawing method.
__p2	The offset in pixels.

Deprecated:

v. 4.8. Use AxMap.get_DrawingLabels and Labels.OffsetX, Labels.OffsetY instead.

void AxMap.set_DrawingLabelsScale	(	int	DrawHandle,
		bool	__p2
	)

Sets a boolean value which indicates whether the labels of the drawing layer will be scaled.

This property corresponds to the Labels.ScaleLabels property.

Parameters:

DrawHandle	The handle of the drawing layer returned by AxMap.NewDrawing method.
__p2	True if the labels are scaled and false otherwise.

void AxMap.set_DrawingLabelsShadow	(	int	DrawHandle,
		bool	__p2
	)

Sets a boolean value which indicates whether a shadow will be displayed for the labels of the drawing layer.

This property corresponds to the Labels.HaloVisible property.

Parameters:

DrawHandle	The handle of the drawing layer returned by AxMap.NewDrawing method.
__p2	True if the shadow is displayed and false otherwise.

void AxMap.set_DrawingLabelsShadowColor	(	int	DrawHandle,
		uint	__p2
	)

Sets the color of the shadow for the labels of the specified drawing layer.

This property corresponds to the Labels.HaloColor property.

Parameters:

DrawHandle	The handle of the drawing layer returned by AxMap.NewDrawing method.
__p2	The color of shadow.

void AxMap.set_DrawingLabelsVisible	(	int	DrawHandle,
		bool	__p2
	)

Sets a boolean value which indicates whether labels of the drawing layer are visible.

This property corresponds to the Labels.Visible property.

Parameters:

DrawHandle	The handle of the drawing layer returned by AxMap.NewDrawing method.
__p2	True in case labels are visible and false otherwise.

void AxMap.set_UseDrawingLabelCollision	(	int	DrawHandle,
		bool	__p2
	)

Sets a boolean value which indicates whether overlapping labels will be allowed for drawing layer.

This property corresponds to the Labels.AllowCollisions property.

Parameters:

DrawHandle	The handle of the drawing layer returned by AxMap.NewDrawing method.
__p2	True in case overlapping labels are removed and false otherwise.