Click or drag to resize

API Reference

Contains classes used in licensing and deploying your custom ArcGIS Runtime .NET SDK based application on end user devices.
Contains classes that help in obtaining metadata information about various layer and table types that are served up as ArcGIS Server web services. Developers can obtain the details that are displayed in the ArcGIS Server REST pages as objects that can be used in other parts of the application. Examples of the types of information that can be obtained about various ArcGIS Server web services include: ArcGIS Server version, type of layer, opacity of a layer, timespan the data covers in a layer, number of records in a layer or table, full geographic extent of the web service, geometry of the layer, can the layer be edited, can the data be sync’ed locally, is the web service route or network enabled and what are its specifications, etc.
Contains classes that access attribute data associated with the various layers. Developers can access Features which are attributes and geometries in a row of a table and gain information from a FeatureTable in a Geodatabase. A Geodatabase is a database storage structure that contains spatial data. The attribute and geographic information in it can be queried (spatially or textually) and edited. Developers can make use of CodedValueDomans to specify an explicit set of valid values that can be set as attributes in a Field. Fields are the columns of the table; they contains various types (number, text, boolean, date, etc.) have names and are of a specified size. The attribute information in a Geodatabase can be obtained/modified either using an ArcGIS Server web service via a ServiceFeatureTable or on the local device’s storage location via a GeodatabaseFeatureTable. Additionally, developers can add or delete image, text, and files stored as Attachments attribute information in FeatureLayer’s.
Contains key classes and enumerations that define the geometries that are the heart of a Geographic Information System (GIS). Developers can read and create various Geometry types such as: Envelope, MapPoint, Polygon, and Polyline. Additionally, they can read and create the SpatialReference (aka. coordinate system) and define the various Units (angular, area, and linear) for the various geometries. Containers that house collections of the geometries (PartCollection, PointCollection). There is also a powerful set of GeometryEngine static methods that can perform numerous GIS based geometry manipulations (buffer, cut, clip, generalize, offset, union, etc.) locally on the application device without having to make expensive transactions across the Intranet/Internet.
Contains classes for creating your own custom communications with ArcGIS Server. Developers use these classes as a starting point to request data from ArcGIS Server, provide the appropriate security credentials, and handle exception error messages if problems arise in communicating with ArcGIS Server. These classes would typically be used by advanced developers who want to write functionality that is otherwise not found in the ArcGIS Runtime .NET SDK.
Contains classes for working with Electronic Navigational Charts (ENC) within the ArcGIS Runtime for .NET SDK. Runtime reads and displays ENCs following International Hydrographic Organization specifications (see Important classes include EncCell, EncExchangeSet, and EncDataSet.
Contains classes to work with ArcGIS Runtime Local Server SDK, an optional component of ArcGIS Runtime SDK for .NET that can be downloaded separately for Windows (64-bit). ArcGIS Runtime Local Server is primarily for executing offline geoprocessing tasks in your ArcGIS Runtime applications. These tasks work in the same way as geoprocessing tasks published from ArcGIS Server. Running a geoprocessing task on ArcGIS Runtime Local Server requires a geoprocessing package (.gpkx file). These packages are authored in ArcGIS Pro either using Model Builder or by writing a Python script. ArcGIS Runtime Local Server also allows your application to consume map image layers or feature layers that use local content in a map package (.mpkx file). These packages are authored and created using ArcGIS Pro. NOTE: The localServices namespace is in an assembly included with the Esri.ArcGISRuntime.LocalServices NuGet package.
Contains classes to enable your device (PC, tablet, laptop, phone, handheld, etc.) to discover its geographic coordinate location and display a symbol in the map along with the layers as a backdrop. This enables developers to create work-order based field applications or real-time navigation applications with a minimal effort as compared to having to write your own hardware interface logic to access geo-positional information from the device.
Contains the classes used to create, retrieve, and display all of the various layers in your Geographic Information System (GIS) based application. For most application developers, the central focus of your programming efforts with the ArcGIS Runtime .NET SDK will be centered on displaying layers of geographic information and having end users interact with the rich information contained in the layers. These GIS layers are contained with a Map, which has several properties and methods to aid in determining things like: when the layers have loaded, obtaining the spatial refernce of a layer, setting the viewable scale of the layers, etc. There are some high level abstract layer types like: Layer, ImageAdjustmentLayer, and ImageTiledLayer that could be used to create your own custom layer type but this will not typical programming path for most developers. Rather, most developers will write code where users will interact with layers that inherit from these abstract classes, the most popular being: FeatureLayer, ArcGISMapImageLayer. and ArcGISTiledLayer. There are literally hundreds of Properties, Methods, and Events of which developers can program against to spatially enable your application. Layers can come from various sources such as ArcGIS Server web services and local datasets (geodatabase or file based) on the device. The layers that can be accessed can be vector or raster based sources.
Contains classes to control labeling on FeatureLayers, SubTypeSubLayers, ArcGISMapImageSubLayers, and GraphicOverlays. There are three types of classes that inherit from the base (abstract) LabelExpression class, they are: ArcadeLabelExpression, SimpleLabelExpression, and WebmapLabelExpression. Each type of LabelExpression has an Expression property that takes a string to define what is to be labeled. There are numerous enumerations that can be used to define the placement of labels in the LabelExpression. Each layer has a LabelDefinition property that takes a List of LabelDefinitions. The LabelDefinition class has an Expression property that takes one of the three LabelExpression classes.
Contains classes that allow the display the data of a feature, graphic or pixel (geo elements) in a way that is easier to understand than basic attributes in a row/column format via a 'popup' graphical element that floats on top of the map. Popups are part of the ArcGIS information model and can be configured for individual layers (or sublayers) in a map via a popup definition. They can also be used with graphics and graphics overlays, and pixels and rasters. Popups convert raw data into an information display that is both powerful and easy to read. Some common uses of popups are: display results from an identify (aka. a user map view click) and editing a feature by adding/updating/deleting attributes/geometry.
Contains classes that facilitate the implementation of turn-by-turn navigation experiences.
Contains classes that allow the utilization of the Open GIS Consortium (OGC) standard for Web Map Tile Service (WMTS) layers. WMTS is a cached service that accesses pre-created tiles from a cache on a server’s hard drive instead of dynamically rendering images. The full WMTS standard can be found on the OGC web site: As of ArcGIS Server version 10.1 serving WMTS layers as a native REST service is supported.
Contains classes that provide a way to build applications that work with content from ArcGIS Online or an ArcGIS Portal. ArcGIS Portal is software technology from Esri that customers can deploy either on premise or in the cloud. ArcGIS Online is Esri's Software as a Service (SaaS) offering that represents GIS as a Service and is implemented using the same technology as ArcGIS Portal. It allows application developers to work with users, groups and content hosted within ArcGIS Online or within an ArcGIS Portal. Developers can build web, mobile, and desktop applications that support sharing and collaboration using web maps.
Contains classes that support direct read, display and manipulate rasters. A raster consists of a matrix of cells (or pixels) organized into rows and columns (or a grid) where each cell contains a value representing information (ex: temperature, elevation, flow direction, etc.). Examples of raster data sources are digital aerial photographs, imagery from satellites, digital pictures, or even scanned maps. Raster data is displayed via a raster layer. Raster layers have the ability to apply different renderers to visualize the data in many ways. Raster layers can have raster functions applied to perform spatial analysis. Multiple raster data sets can be visually merged together to form a mosaic dataset. Raster layers support re-projection to align data visually with other GIS datasets.
Contains classes to enable accessing your applications information over secure Intranet/Internet connections. The most important class being the AuthenticationManager singleton that when enabled will manage the user credentials for the following resources: (1) ArcGIS Server resources secured using token-based authentication or using HTTP authentication, (2) secured resources (i.e. web maps), and (3) secured ArcGIS Portal resources.
Contains classes to render features in a layer with symbols. Symbols are graphics used to represent a geographic feature or class of features. Symbols can look like what they represent (trees, railroads, houses), or they can be abstract shapes (points, lines, polygons) or characters. Typically symbols vary with visual properties such as: color, size, rotation, image, text, shape, etc. to differentiate certain characteristics in the layer. Once a symbol is defined with is various visual properties, they are added to a Renderer (ClassBreaksRenderer, SimpleRenderer, UniqueValueRenderer, etc.) and then applied to the layer for visual representation. Default symbology is usually provided for layers.
Contains classes to perform asynchronous geoprocessing tasks on ArcGIS Server via a web service. The key class is the Job (Of T) which is the base class for other specialized types of geoprocessing execution. Some of the key properties of the Job (Of T) is the ability to start, pause, and cancel a task, as well as obtain information about its execution.
Contains classes to perform geocoding and reverse geocoding using an ArcGIS Server web service. Geocoding is the GIS operation for converting street addresses into spatial data that can be displayed as features on a map, usually by referencing address information from a street segment data layer. Reverse geocoding is the process of finding a street address from a point on a map.
Contains classes to execute geoprocessing (aka. GP) services on ArcGIS Server. Geoprocessing is a GIS operation used to manipulate GIS data. A typical geoprocessing operation takes an input dataset, performs an operation on that dataset, and returns the result of the operation as an output dataset. Common geoprocessing operations include geographic feature overlay, feature selection and analysis, topology processing, raster processing, and data conversion. Geoprocessing allows for definition, management, and analysis of information used to form decisions. The Geoprocessor class in this namespace provide the starting point for developers to use geoprocessing services.
Contain classes to perform route (aka. network) analysis via ArcGIS Server web requests. Routing analysis determines the best route from one network location to one or more other locations. It can also calculate the quickest or shortest route depending on the impedance chosen. The order of the stops may be determined by the user. For example, if the impedance is time, then the best route is the quickest route.
The Esri.ArcGISRuntime.Tasks.Offline namespace contains classes to download maps, geodatabases, and basemaps from ArcGIS Online and ArcGIS Enterprise to the local device and to synchronize content when online.
Contains classes that allows displaying graphical elements in the MapView and SceneView. Some of the key classes in creating, manipulating, displaying these graphical elements include: Graphic, GraphicCollection, GraphicsOverlay, and GraphicsOverlayCollection. Other important classes include the ability to control user interaction in the MapView and SceneView via the InterationsOptions, MapViewInteractionsOptions and SceneViewInteractionsOptions classes. Various draped grid graticules can be draped in the MapView and SceneView via the Grid, LatitudeLongitudeGrid, MgrsGrid, UsngGridm and UtmGrid classes.
Contains classes that the user interacts with visually in the Graphical User interface (GUI) of the application; the most important being the MapView and SceneView classes. The MapView is a 2D control that allows for visual interaction of layers by performing mouse clicks, taps and pressing keyboard keys to pan and zoom around as well as select features. The MapView layout can be modified to adjust its size, color, viewable extent, rotation, spatial reference, time extent, wraparound mode, and many modify more features. The MapView.Map Property enables getting/setting the Map Class; which is responsible for managing the collection of GIS layers displayed. The SceneView functions similarly to the MapView but is intended to be used for 3D mapping on the Earths sphere. It contains a similar ScenevView.Scene Property that enables getting/setting the Scene Class to display GIS layers.
Contains classes that allow for visualizing viewshed and line-of-sight analysis in a Scene. Viewsheds are a type of visibility analysis that show the visible and obstructed areas covered by a directed field of view. Line-of-sight is a type of visibility analysis which shows where a sight line is blocked by an obstruction. The results of these analysis are visual in nature, are calculated by the GPU and hence performing an identify/hit-testing of the visible/obstructed areas is not possible. Developers can control the colors of what is visible and obstructed from the observation point in the analysis.
Contains classes for working with a utility network, which is used to model utility systems such as electric, gas, water, storm water, wastewater, and telecommunications.