GetLegendDisplayStatus()

Summary

Determines whether a layer, set, or a theme is displayed in the legend.

Syntax

flag = GetLegendDisplayStatus(string set_or_theme_name)

Argument	Contents
set_or_theme_name	The name of the set or the theme

Returns

The string "True" if the set or the theme is displayed in the legend; the string "False" if the set or the theme is hidden.

Notes

If the set name is of the form layer|, indicating all features in a layer, GetLegendDisplayStatus() will determine whether the layer name is or is not displayed in the legend.

Example

sets = GetSets("Streets")
for i = 1 to sets.length do
flag = GetLegendDisplayStatus(sets[i])
if flag = "False" then SetLegendDisplayStatus(sets[i], "True")
end

Error Codes

Error Type	Meaning
NotFound	The set or theme was not found
Error	The set or theme was invalid