Class SymbolStyle

A symbol style object.

Inheritance

System.Object

SymbolStyle

DictionarySymbolStyle

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Esri.ArcGISRuntime.Symbology

Assembly: Esri.ArcGISRuntime.dll

Syntax

public class SymbolStyle

Remarks

A SymbolStyle is created either from a style file on disk (an SQLite database with a .stylx extension, created with ArcGIS Pro) or from a style file hosted on ArcGIS Online or an ArcGIS Enterprise portal (also referred to as a web style).

When used by itself, the symbol style supports two key workflows. One is to return a symbol based on a provided set of key values. Since each symbol in the style has a key that uniquely identifies it, you can pass an array of keys into GetSymbolAsync(IEnumerable<String>) to return a new Symbol built from the individual symbols represented by those keys. You might use this symbol to create a new Graphic.

The other common workflow is to use a standalone symbol style to search for symbol primitives. Symbol primitives are the individual symbols that compose more complex symbols. This is achieved using SearchSymbolsAsync(SymbolStyleSearchParameters). You could created a symbol picker app, for example, that searches for all symbols in the style that have the tag "maritime" in it. The search results contain symbols that you could use directly. You could also extract their individual symbol components to create a new multilayer symbol.

Properties

Name	Description
Portal	Gets the Portal that hosts the web style identified with Portal. This will be null if the style was identified with a PortalItem or Uri or a local .stylx file on disk.
PortalItem	Gets the PortalItem representing the web style.
StyleLocation	Gets the file location of the .stylx file on disk. This will be empty if the style was hosted on a portal (also referred to as a web style).
StyleName	Gets the name of the web style. This will be empty if the web style was identified with a Uri or a PortalItem or a local .stylx file on disk.
Uri	Gets the Uri of the web symbol style item. This will be null if the style was identified with a PortalItem, style name or a local .stylx file on disk.

Methods

Name	Description
GetDefaultSearchParametersAsync()	Returns a Style Symbol Search Parameters object providing the default search parameters from the database.
GetSymbolAsync(IEnumerable<String>)	Asynchronously returns a symbol based on the provided list of keys.
OpenAsync(PortalItem)	Opens a new SymbolStyle object from a portal item. The portal item must be a web style.
OpenAsync(String)	Opens a SymbolStyle in the specified path.
OpenAsync(String, ArcGISPortal)	Opens a new SymbolStyle from a portal item. The portal item must contain a webstyle style.
OpenAsync(Uri)	Opens a new SymbolStyle from a web style item Uri.
SearchSymbolsAsync(SymbolStyleSearchParameters)	Returns a collection of SymbolStyleSearchResult objects.

Applies to

Target	Versions
.NET Standard 2.0	100.3 - 200.6
.NET	100.13 - 200.6
.NET Windows	100.13 - 200.6
.NET Android	200.0 - 200.6
.NET iOS	200.0 - 200.6
.NET Framework	100.0 - 200.6
Xamarin.Android	100.0 - 100.15
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.6