GetLabelOverlapStatus()

Summary

Gets the status of whether labels can be drawn on top of point icons.

 

Changes

Added to Version 6.0/2012.

 

Syntax

status = GetLabelOverlapStatus(string lyr_set_name)

 

Argument	Contents
lyr_set_name	The name of the layer and selection set

 

Returns

"True" if labels can be drawn on top of point icons, otherwise "False."

 

Notes

• A boolean setting of "None" indicates that the setting for a selection set or feature class will be inherited from the setting for the base layer.

Example

// Open a map with at least one layer

lyr = GetLayer()

overlap_status = GetLabelOverlapStatus(lyr + "|")

ShowMessage("The overlap status is " + overlap_status)

 

Error Codes

Error Type	Meaning
NotFound	The specified layer or selection set does not exist

 

See Also

Function	Summary
GetLabelOptions()	Get the label option settings for a layer or selection set
SetLabels()	Enables or disables labeling for a layer or selection set
SetLabelOptions()	Changes the option settings for labels
SetLabelOverlapStatus()	Sets the status of whether labels can be drawn on top of point icons