Class DictionarySymbolStyle
A dictionary symbol style object containing symbol primitives and rules for generating symbols from attribute values.
Namespace: Esri.ArcGISRuntime.Symbology
Assembly: Esri.ArcGISRuntime.dll
Syntax
public class DictionarySymbolStyle : SymbolStyleRemarks
A DictionarySymbolStyle is created either from a style file on disk (an SQLite database with a .stylx extension, created with ArcGIS Pro) or from a dictionary style file hosted on ArcGIS Online or an ArcGIS Enterprise portal (also referred to as a dictionary web style).
A DictionarySymbolStyle must contain a set of symbol primitives and a rule engine that parses
input fields. The DictionarySymbolStyle assembles new symbols based on the input attribute
values. DictionarySymbolStyle is often used to render symbols from a military specification
(such as MIL-STD 2525D or APP-6B) but can also be used with a custom style.
When working with dictionary symbol styles, it's important to avoid using certain reserved strings as field names.
Note that dictionary symbol styles reserve certain field names for their internal implementation.
Specifically, the field name gt is reserved and geoelements rendered with a dictionary symbol style should not contain an attribute with name gt.
Additionally, do not use countrylabel as a primitive name as it is reserved to manage a unique symbol/text scenario in military dictionaries.
A DictionarySymbolStyle is used in conjunction with a DictionaryRenderer to symbolize geoelements in a FeatureLayer or GraphicsOverlay.
Esri builds and maintains some dictionary web styles according to the US and NATO military symbol specifications. These desktop and web styles are hosted online and are publicly available. Refer to the ArcGIS Online Dictionary Symbology Styles group for the latest versions of the styles available.
Properties
| Name | Description |
|---|---|
| Configurations | Gets the list of configuration settings for the custom dictionary style. |
| DictionaryName | Gets the name of the custom Arcade-based dictionary style. For older version style files, this is an empty string. |
| SymbologyFieldNames | Gets the string list of attributes used to construct a symbol from the dictionary style. |
| TextFieldNames | Gets the string list of attributes used to obtain text values for display with a symbol from a dictionary style. |
Methods
| Name | Description |
|---|---|
| CreateFromFileAsync(String) | Creates a new a DictionarySymbolStyle from the style file at the provided location. |
| GetSymbolAsync(IDictionary<String, Object>) | Asynchronously returns a symbol based on the provided attributes. |
| OpenAsync(PortalItem) | Opens a DictionarySymbolStyle from a portal item. The portal item must be a dictionary web style. |
| OpenAsync(Uri) | Opens a new DictionarySymbolStyle from a dictionary web style item Uri. |
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.7 |
| .NET | 100.13 - 200.7 |
| .NET Windows | 100.13 - 200.7 |
| .NET Android | 200.0 - 200.7 |
| .NET iOS | 200.0 - 200.7 |
| .NET Framework | 100.0 - 200.7 |
| Xamarin.Android | 100.0 - 100.15 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.7 |