HideMapLabels()
Summary
Turns label display off for all currently displaying layers.
Syntax
HideMapLabels(string map_name)
| Argument | Contents |
|---|---|
| map_name | Map whose labels should be removed; if null, the current map |
Notes
-
Label display will not be turned off for layers or hidden layers whose autoscale settings prevent them from being displayed at the current scale.
-
This function removes labels from all currently displaying layers.
-
To turn labels off and on, call SetLabelOptions() with the Visibility option set to "Off" or "On."
Example
HideMapLabels()
Error Codes
| Error Type | Meaning |
|---|---|
| NotFound | The specified map does not exist |
See Also
| Function | Summary |
|---|---|
| SetLabelOptions() | Enables or disables, and sets options for, labeling for a layer or selection set |