Click or drag to resize

KmlScreenOverlay Class

A KML ScreenOverlay object.
Inheritance Hierarchy

Namespace:  Esri.ArcGISRuntime.Ogc
Assembly:  Esri.ArcGISRuntime (in Esri.ArcGISRuntime.dll) Version: 100.7.0.0
Syntax
C#
public sealed class KmlScreenOverlay : KmlNode

The KmlScreenOverlay type exposes the following members.

Constructors
  NameDescription
Public methodKmlScreenOverlay
Initializes a new instance of the KmlScreenOverlay class.
Top
Properties
  NameDescription
Public propertyAddress
Gets or sets an address associated with this node.
(Inherited from KmlNode.)
Public propertyBalloonBackgroundColor
Gets the color that should be used for the background of the node's popup balloon.
(Inherited from KmlNode.)
Public propertyCode exampleBalloonContent
Gets the balloon popup content for this KML node as a string containing HTML.
(Inherited from KmlNode.)
Public propertyColor
Gets or sets the color mask applied to the overlay image.
Public propertyDescription
Gets or sets the description of this KML node.
(Inherited from KmlNode.)
Public propertyDrawOrder
Gets or sets the draw order of this screen overlay.
Public propertyCode exampleExtent
Gets the bounding extent of this KML node.
(Inherited from KmlNode.)
Public propertyHighlightStyle
Gets or sets the style used to render this KML node when IsHighlighted is true.
(Inherited from KmlNode.)
Public propertyIcon
Gets or sets the KML screen overlay icon.
Public propertyId
Gets or sets the ID of the KML node.
(Inherited from KmlNode.)
Public propertyIsHighlighted
Gets or sets a value indicating whether this KML node is highlighted. This controls whether the default Style or an alternate HighlightStyle (if present) is used for rendering the node.
(Inherited from KmlNode.)
Public propertyCode exampleIsVisible
Gets or sets a value indicating whether this KML node is visible.
(Inherited from KmlNode.)
Public propertyCode exampleName
Gets or sets the name of this KML node.
(Inherited from KmlNode.)
Public propertyOverlayCoordinate
Gets or sets a point on (or outside of) the overlay image that is mapped to the ScreenCoordinate.
Public propertyParent
Gets the parent of this node.
(Inherited from KmlNode.)
Public propertyRefreshError
Gets the reason for refresh failure if the RefreshStatus is Failed.
(Inherited from KmlNode.)
Public propertyRefreshStatus
Gets the KML node's refresh status.
(Inherited from KmlNode.)
Public propertyRotation
Gets or sets the angle of rotation of the overlay image.
Public propertyRotationCoordinate
Gets or sets the point about which the screen overlay is rotated, relative to the screen.
Public propertyScreenCoordinate
Gets or sets a point relative to the screen origin that the overlay image is mapped to.
Public propertySize
Gets or sets the size of the image for the screen overlay.
Public propertySnippet
Gets or sets the optional snippet for this KML node.
(Inherited from KmlNode.)
Public propertySnippetMaxLines
Gets or sets the maximum number of lines of snippet to be shown in the UI.
(Inherited from KmlNode.)
Public propertyCode exampleStyle
Gets or sets the style used to render this KML node.
(Inherited from KmlNode.)
Public propertyUxIcon
Gets the icon associated with this KML node for use in the user interface.
(Inherited from KmlNode.)
Public propertyUxIconColor
Gets the color used to tint the UX icon.
(Inherited from KmlNode.)
Public propertyUxIconId
Gets the UX icon id.
(Inherited from KmlNode.)
Public propertyCode exampleViewpoint
Gets the KmlViewpoint associated with this KML node or null if no Camera or LookAt is specified for the node.
(Inherited from KmlNode.)
Top
Methods
  NameDescription
Public methodSaveAsAsync
Saves this node and any referenced local files as a KMZ archive.
(Inherited from KmlNode.)
Public methodCode exampleWriteToAsync
Saves this node and any referenced local files into the given Stream as a KMZ archive.
(Inherited from KmlNode.)
Top
Events
  NameDescription
Public eventCode examplePropertyChanged
Occurs when a property value changes.
(Inherited from KmlNode.)
Top
Remarks
A ScreenOverlay is an image shown over the map, with a fixed position relative to the screen. ScreenOverlays may be used for compasses, logos, legends, and heads-up displays.
See Also