New to Telerik UI for WinFormsStart a free 30-day trial

RadMap

Class

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.RadMap.dll

Syntax:

C#
[TelerikToolboxCategory("Data Controls")]
public class RadMap : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider

Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadMap...

Implements: IAnalyticsProviderIBindableComponentIComponentIComponentTreeHandlerIDisposableIDropTargetILayoutHandlerINotifyPropertyChangedISupportInitializeISupportInitializeNotificationISynchronizeInvokeIWin32Window...

Inherited Members RadControl.isResizing2RadControl.isDisposing2RadControl.invalidResizeRectRadControl.isAccessibilityRequestedRadControl.Dispose(bool)RadControl.Construct()RadControl.CreateBehavior()RadControl.CreateRootElement()RadControl.InitializeRootElement(RootRadElement)RadControl.LoadElementTree()RadControl.LoadElementTree(Size)RadControl.SetBackColorThemeOverrides()RadControl.ResetBackColorThemeOverrides()RadControl.SetForeColorThemeOverrides()RadControl.ResetForeColorThemeOverrides()RadControl.OnKeyDown(KeyEventArgs)RadControl.OnKeyUp(KeyEventArgs)RadControl.OnPreviewKeyDown(PreviewKeyDownEventArgs)RadControl.OnKeyPress(KeyPressEventArgs)RadControl.OnClick(EventArgs)RadControl.OnDoubleClick(EventArgs)RadControl.OnMouseDown(MouseEventArgs)RadControl.OnMouseUp(MouseEventArgs)RadControl.OnMouseEnter(EventArgs)RadControl.OnMouseLeave(EventArgs)RadControl.OnMouseMove(MouseEventArgs)RadControl.OnMouseHover(EventArgs)RadControl.OnMouseWheel(MouseEventArgs)RadControl.OnMouseCaptureChanged(EventArgs)RadControl.OnGotFocus(EventArgs)RadControl.OnLostFocus(EventArgs)RadControl.OnCreateControl()RadControl.OnHandleDestroyed(EventArgs)RadControl.OnParentChanged(EventArgs)RadControl.OnVisibleChanged(EventArgs)RadControl.OnFontChanged(EventArgs)RadControl.OnForeColorChanged(EventArgs)RadControl.OnBackColorChanged(EventArgs)RadControl.OnEnabledChanged(EventArgs)RadControl.OnBindingContextChanged(EventArgs)RadControl.OnLocationChanged(EventArgs)RadControl.OnPaddingChanged(EventArgs)RadControl.OnRightToLeftChanged(EventArgs)RadControl.OnPaint(PaintEventArgs)RadControl.OnLayout(LayoutEventArgs)RadControl.OnAutoSizeChanged(EventArgs)RadControl.WndProc(ref Message)RadControl.OnInvalidated(RadElement)RadControl.OnLoad(Size)RadControl.OnCaptureLosing()RadControl.OnThemeChanged()RadControl.OnToolTipTextNeeded(object, ToolTipTextNeededEventArgs)RadControl.OnScreenTipNeeded(object, ScreenTipNeededEventArgs)RadControl.OnThemeNameChanged(ThemeNameChangedEventArgs)RadControl.ProcessMnemonic(char)RadControl.ProcessFocusRequested(RadElement)RadControl.ProcessCaptureChangeRequested(RadElement, bool)RadControl.ProcessAutoSizeChanged(bool)RadControl.GetInputElement()RadControl.BeginInit()RadControl.EndInit()RadControl.OnNotifyPropertyChanged(string)RadControl.OnNotifyPropertyChanged(PropertyChangedEventArgs)RadControl.GetPreferredSize(Size)RadControl.SetBoundsCore(int, int, int, int, BoundsSpecified)RadControl.GetRootElementDesiredSize(int, int, int, int)RadControl.OnZoomGesture(ZoomGestureEventArgs)RadControl.OnRotateGesture(RotateGestureEventArgs)RadControl.OnPanGesture(PanGestureEventArgs)RadControl.OnTwoFingerTapGesture(GestureEventArgs)RadControl.OnPressAndTapGesture(PressAndTapGestureEventArgs)RadControl.OnGesture(GestureEventArgs)RadControl.ProcessGesture(Message)RadControl.EnableGesture(GestureType)RadControl.DisableGesture(GestureType)RadControl.Refresh()RadControl.SuspendUpdate()RadControl.ResumeUpdate()RadControl.ResumeUpdate(bool)RadControl.InvokeLayoutCallback(LayoutCallback)RadControl.RegisterHostedControl(RadHostItem)RadControl.UnregisterHostedControl(RadHostItem, bool)RadControl.ResolveStyleGroupForElement(StyleGroup, RadObject)RadControl.GetPlainText()RadControl.ShouldSerializeProperty(RadProperty)RadControl.ShouldSerializeProperty(RadProperty, RadObject)RadControl.ResetProperty(RadProperty, RadObject)RadControl.CanEditElementAtDesignTime(RadElement)RadControl.ProcessCodedUIMessage(ref IPCMessage)RadControl.FindPropertyInChildren(RadControl, IPCMessage)RadControl.ScaleControl(SizeF, BoundsSpecified)RadControl.PerformRadAutoScale(BoundsSpecified?)RadControl.GetMonitorDpiScaleFactor(Control)RadControl.SetRadAutoScale(bool)RadControl.EnableDpiScalingRadControl.EnableRadAutoScaleRadControl.EnableRadFormInitialDpiScalingRadControl.EnableImageDpiScalingRadControl.EnableSvgImagesRadControl.IsLoadedRadControl.ElementTreeRadControl.UseCompatibleTextRenderingDefaultValueRadControl.BehaviorRadControl.RootElementRadControl.PaddingRadControl.ThemeNameRadControl.TextRadControl.EnableThemingRadControl.ThemeClassNameRadControl.ImageListRadControl.ImageScalingSizeRadControl.UseCompatibleTextRenderingRadControl.AutoSizeRadControl.MaximumSizeRadControl.MinimumSizeRadControl.FocusableRadControl.SiteRadControl.CausesValidationRadControl.IsInitializingRadControl.SmallImageListRadControl.SmallImageScalingSizeRadControl.IsDesignModeRadControl.IsDisplayedRadControl.FocusedElementRadControl.AllowShowFocusCuesRadControl.ShowItemToolTipsRadControl.CommandBindingsRadControl.EnableKeyMapRadControl.BackColorRadControl.ForeColorRadControl.FontRadControl.ValidationCancelRadControl.EnableAnalyticsRadControl.AnalyticsNameRadControl.EnableRadAccessibilityObjectsRadControl.EnableCodedUITestsRadControl.EnableCodedUITestsDefaultValueRadControl.EnableUIAutomationRadControl.EnableUIAutomationDefaultValueRadControl.ElementInvalidatedRadControl.ToolTipTextNeededRadControl.ScreenTipNeededRadControl.ThemeNameChangedRadControl.InitializedRadControl.PropertyChangedRadControl.ZoomGestureRadControl.RotateGestureRadControl.PanGestureRadControl.TwoFingerTapGestureRadControl.PressAndTapGesture...

Constructors

Initializes a new instance of the RadMap class.

C#
public RadMap()

Properties

Gets the default size of the RadMap control.

C#
protected override Size DefaultSize { get; }

Overrides: Control.DefaultSize

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

C#
public MapInputBehavior InputBehavior { get; set; }

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

C#
public bool IsUpdateSuspended { get; }
Property Value:

true if updates are suspended; otherwise, false.

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

C#
public MapLayerCollection Layers { get; }

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

C#
public RadMapElement MapElement { get; }

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

C#
public MapProviderCollection Providers { get; }

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

C#
public List<MapVisualElement> SelectedElements { get; }

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

C#
public bool ShowLegend { get; set; }

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

C#
public bool ShowMiniMap { get; set; }

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

C#
public bool ShowNavigationBar { get; set; }

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

C#
public bool ShowScaleIndicator { get; set; }

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

C#
public bool ShowSearchBar { get; set; }

Methods

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

C#
public void BeginUpdate()

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

C#
public virtual void BringIntoView(PointG location, int zoomLevel)
Parameters:locationPointG

The geographic location to center the map on.

zoomLevelint

The zoom level to set for the map.

Centers the map viewport on the specified geographic location.

C#
public virtual void BringIntoView(PointG location)
Parameters:locationPointG

The geographic location to center the map on.

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

C#
public virtual void BringIntoView(RectangleG rectangle)
Parameters:rectangleRectangleG

The geographic rectangle to bring into view.

Creates child elements of the RadMap control.

C#
protected override void CreateChildItems(RadElement parent)
Parameters:parentRadElement

The parent element to which child elements will be added.

Overrides: RadControl.CreateChildItems(RadElement)

Creates a new instance of the RadMapElement class.

C#
protected virtual RadMapElement CreateMapElement()
Returns:

RadMapElement

A new instance of the RadMapElement class.

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

C#
public void EndUpdate()

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

C#
public void EndUpdate(bool update)
Parameters:updatebool

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

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

C#
protected override bool IsInputKey(Keys keyData)
Parameters:keyDataKeys

One of the Keys values.

Returns:

bool

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

Overrides: RadControl.IsInputKey(Keys)

Moves the map viewport to the specified coordinates in pixels.

C#
public virtual void Pan(long x, long y)
Parameters:xlong

The x-coordinate in pixels.

ylong

The y-coordinate in pixels.

Moves the map viewport by the specified amount in pixels.

C#
public virtual void Pan(SizeL delta)
Parameters:deltaSizeL

The amount to move the viewport in pixels.

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

C#
public virtual void Zoom(int zoomLevel, bool animate, Point center)
Parameters:zoomLevelint

The zoom level to set.

animatebool

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

centerPoint

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

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

C#
public virtual void Zoom(int zoomLevel, bool animate)
Parameters:zoomLevelint

The zoom level to set.

animatebool

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

Sets the zoom level of the map viewport.

C#
public virtual void Zoom(int zoomLevel)
Parameters:zoomLevelint

The zoom level to set.

Events

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

C#
public event EventHandler<MapSelectionChangedEventArgs> SelectionChanged