Class KmlDataset
Points to KML/KMZ content, either from a local file or the network. This object provides an entry point for traversing the tree of KmlNodes that make up the file.
Namespace: Esri.ArcGISRuntime.Ogc
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class KmlDataset : ILoadable, INotifyPropertyChanged
Remarks
Use the RootNodes property to obtain a KmlNodeCollection to traverse the KmlNode objects for examining/using individual KML features. The RootNodes is populated after a KML dataset has finished loading successfully.
A typical KML document will have multiple levels of nodes. Consider using recursion to discover the full collection of nodes in a KML file. See the guide doc and samples for details.
If a KML file has KmlNetworkLinks, the content can change after loading due to automatic refresh. You can use the PropertyChanged event to detect changes and update your app's UI.
Constructors
Name | Description |
---|---|
KmlDataset(KmlNode) | Initializes a new instance of the KmlDataset class, with the given KmlNode as its root node. |
KmlDataset(Uri) | Initializes a new instance of the KmlDataset class. |
Properties
Name | Description |
---|---|
LoadError | Gets the Exception associated with the last load error. |
LoadStatus | Gets the load status. |
RootNodes | Gets this dataset's root KML nodes as a KmlNodeCollection. |
Source | Gets the location of the KML data from which this dataset was created. |
Methods
Name | Description |
---|---|
CancelLoad() | Cancel loading metadata for the object. |
LoadAsync() | Load the metadata for the object asynchronously. |
RetryLoadAsync() | Loads or retries loading metadata for the object asynchronously. |
Events
Name | Description |
---|---|
BalloonPopupEvent | Event that is raised when a KmlTour requests that a balloon popup should be shown or hidden for a particular KmlNode. |
Loaded | Event that is raised when the object is done loading. |
LoadStatusChanged | Event that is raised when the LoadStatus property changes. |
NetworkLinkControlMessage | Event that is raised when a network link control message is available for this dataset. |
Name | Description |
---|---|
INotifyPropertyChanged.PropertyChanged |
Applies to
Target | Versions |
---|---|
.NET Standard 2.0 | 100.4 - 100.15 |
.NET 6.0 | 100.13 - 100.15 |
.NET 6.0 Windows | 100.13 - 100.15 |
.NET Framework | 100.4 - 100.15 |
.NET 5 | 100.10 - 100.12 |
.NET Core 3.1 | 100.7 - 100.12 |
Xamarin.Android | 100.4 - 100.15 |
Xamarin.iOS | 100.4 - 100.15 |
UWP | 100.4 - 100.15 |