Layer.Description Property
Gets or sets a short description of the layer.
Syntax
public System.String Description { get; set; }Property Value
A short description of the layer.
Remarks
This property is typically configured in Carmenta Studio, when a map configuration is created. After loading the map configuration, an application may check if a description is available for a layer, and perhaps display it as a tool tip in a layer control or similar.
The property is used by the Catalog mechanism to populate metadata records for the catalog services, corresponding to the OGC metadata item abstract.
If the property is not specified for an OgcWmsLayer or OgcWmtsLayer instance, it will be set to the abstract specified in the service capabilities document. For OgcWmsServerLayer or OgcWmtsServerLayer instances, the description will always be set from the service capabilities document.
This property can be specified in several different languages, see Localized properties in Carmenta Studio. To retrieve the description for a particular language, use the GetLocalizedDescription method.
Platforms
Windows, Linux, Android