Class RadMap

Inheritance
System.Object
RadControl
RadMap
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.RadMap.dll

Syntax

[TelerikToolboxCategory("Data Controls")]
public class RadMap : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadMap()

Initializes a new instance of the RadMap class.

Declaration
public RadMap()

Properties

DefaultSize

Gets the default size of the RadMap control.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

InputBehavior

Gets or sets the input behavior that handles user interactions with the map.

Declaration
public MapInputBehavior InputBehavior { get; set; }
Property Value
MapInputBehavior

IsUpdateSuspended

Gets a value indicating whether visual updates to the map are currently suspended.

Declaration
public bool IsUpdateSuspended { get; }
Property Value
System.Boolean

true if updates are suspended; otherwise, false.

Layers

Gets the collection of layers that can be displayed on the map.

Declaration
public MapLayerCollection Layers { get; }
Property Value
MapLayerCollection

MapElement

Gets the main map element that provides the core functionality of the RadMap control.

Declaration
public RadMapElement MapElement { get; }
Property Value
RadMapElement

Providers

Gets the collection of map providers that can be used to visualize the map.

Declaration
public MapProviderCollection Providers { get; }
Property Value
MapProviderCollection

SelectedElements

Gets a collection of the currently selected visual elements on the map.

Declaration
public List<MapVisualElement> SelectedElements { get; }
Property Value
System.Collections.Generic.List<MapVisualElement>

ShowLegend

Gets or sets a value indicating whether the map legend is visible.

Declaration
public bool ShowLegend { get; set; }
Property Value
System.Boolean

ShowMiniMap

Gets or sets a value indicating whether the mini map overview is visible.

Declaration
public bool ShowMiniMap { get; set; }
Property Value
System.Boolean

ShowNavigationBar

Gets or sets a value indicating whether the map navigation bar is visible.

Declaration
public bool ShowNavigationBar { get; set; }
Property Value
System.Boolean

ShowScaleIndicator

Gets or sets a value indicating whether the map scale indicator is visible.

Declaration
public bool ShowScaleIndicator { get; set; }
Property Value
System.Boolean

ShowSearchBar

Gets or sets a value indicating whether the map search bar is visible.

Declaration
public bool ShowSearchBar { get; set; }
Property Value
System.Boolean

Text

This property is not relevant for this class.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

Methods

BeginUpdate()

Suspends visual updates to the map until the EndUpdate method is called.

Declaration
public void BeginUpdate()

BringIntoView(PointG)

Centers the map viewport on the specified geographic location.

Declaration
public virtual void BringIntoView(PointG location)
Parameters
PointG location

The geographic location to center the map on.

BringIntoView(PointG, Int32)

Centers the map viewport on the specified geographic location and sets the zoom level.

Declaration
public virtual void BringIntoView(PointG location, int zoomLevel)
Parameters
PointG location

The geographic location to center the map on.
System.Int32 zoomLevel

The zoom level to set for the map.

BringIntoView(RectangleG)

Adjusts the zoom level and position of the map to fit the specified geographic rectangle in the viewport.

Declaration
public virtual void BringIntoView(RectangleG rectangle)
Parameters
RectangleG rectangle

The geographic rectangle to bring into view.

CreateChildItems(RadElement)

Creates child elements of the RadMap control.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

The parent element to which child elements will be added.
Overrides

CreateMapElement()

Creates a new instance of the RadMapElement class.

Declaration
protected virtual RadMapElement CreateMapElement()
Returns
RadMapElement

A new instance of the RadMapElement class.

EndUpdate()

Resumes visual updates to the map and performs an immediate update.

Declaration
public void EndUpdate()

EndUpdate(Boolean)

Resumes visual updates to the map and optionally performs an immediate update.

Declaration
public void EndUpdate(bool update)
Parameters
System.Boolean update

If set to true, an immediate update is performed; otherwise, the update is deferred.

IsInputKey(Keys)

Determines whether the specified key is a regular input key or a special key that requires preprocessing.

Declaration
protected override bool IsInputKey(Keys keyData)
Parameters
System.Windows.Forms.Keys keyData

One of the System.Windows.Forms.Keys values.
Returns
System.Boolean

true if the specified key is a regular input key; otherwise, false.
Overrides

Pan(Int64, Int64)

Moves the map viewport to the specified coordinates in pixels.

Declaration
public virtual void Pan(long x, long y)
Parameters
System.Int64 x

The x-coordinate in pixels.
System.Int64 y

The y-coordinate in pixels.

Pan(SizeL)

Moves the map viewport by the specified amount in pixels.

Declaration
public virtual void Pan(SizeL delta)
Parameters
SizeL delta

The amount to move the viewport in pixels.

Zoom(Int32)

Sets the zoom level of the map viewport.

Declaration
public virtual void Zoom(int zoomLevel)
Parameters
System.Int32 zoomLevel

The zoom level to set.

Zoom(Int32, Boolean)

Sets the zoom level of the map viewport with an optional animation.

Declaration
public virtual void Zoom(int zoomLevel, bool animate)
Parameters
System.Int32 zoomLevel

The zoom level to set.
System.Boolean animate

If set to true, the zoom transition will be animated; otherwise, it will be immediate.

Zoom(Int32, Boolean, Point)

Sets the zoom level of the map viewport with an optional animation, centered around a specific point.

Declaration
public virtual void Zoom(int zoomLevel, bool animate, Point center)
Parameters
System.Int32 zoomLevel

The zoom level to set.
System.Boolean animate

If set to true, the zoom transition will be animated; otherwise, it will be immediate.
System.Drawing.Point center

The point in the viewport around which the zoom operation will be centered.

Events

SelectionChanged

Occurs when the selection of visual elements on the map changes, typically when a user clicks on a visual element in the layers.

Declaration
public event EventHandler<MapSelectionChangedEventArgs> SelectionChanged
Event Type
System.EventHandler<MapSelectionChangedEventArgs>

Extension Methods