Class BaseMapElement

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
BaseMapElement
MiniMapElement
RadMapElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.RadMap.dll

Syntax

public class BaseMapElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IImageElement, ITextPrimitive, ITextProvider, IMapViewport

Constructors

BaseMapElement()

Initializes a new instance of the BaseMapElement class.

Declaration
public BaseMapElement()

Fields

TileOffsetProperty

Declaration
public static RadProperty TileOffsetProperty
Field Value
RadProperty

TileScaleProperty

Declaration
public static RadProperty TileScaleProperty
Field Value
RadProperty

Properties

Center

Gets or sets the center of the viewport in geo coordinates.

Declaration
public PointG Center { get; set; }
Property Value
PointG

The center.
Implements

CenterPixel

Gets or sets the coordinates of the center of the viewport in pixels.

Declaration
public PointL CenterPixel { get; set; }
Property Value
PointL

The center pixel.
Implements

EnablePanning

Gets or sets a value indicating whether panning is allowed.

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

EnableZooming

Gets or sets a value indicating whether zooming is allowed.

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

InputBehavior

Gets or sets the input behavior that will handle the user input.

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

The input behavior.

IsAnimationActive

Gets a value indicating whether an animation is active.

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

true if an animation is active; otherwise, false.

IsUpdateSuspended

Gets a value indicating whether updates are suspended.

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

true if updates are suspended; otherwise, false.

Layers

Gets the layers collection of the map element.

Declaration
public MapLayerCollection Layers { get; }
Property Value
MapLayerCollection

The layers.

NumberOfWraparounds

Gets the number of wraparounds visible in the viewport.

Declaration
public int NumberOfWraparounds { get; }
Property Value
System.Int32

The number of wraparounds.
Implements

PanOffset

Gets or sets the current pan offset of the viewport in pixels.

Declaration
public SizeL PanOffset { get; set; }
Property Value
SizeL

The pan offset.
Implements

Providers

Gets the providers collection of the map element.

Declaration
public MapProviderCollection Providers { get; }
Property Value
MapProviderCollection

The providers.

SelectedElements

Gets a collection of the selected elements.

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

The selected elements.

TileOffset

Gets or sets the tile offset. This property is used for animations of the viewport.

Declaration
public SizeF TileOffset { get; set; }
Property Value
System.Drawing.SizeF

The tile offset.

TileScale

Gets or sets the tile scale. This property is used for animations of the viewport.

Declaration
public SizeF TileScale { get; set; }
Property Value
System.Drawing.SizeF

The tile scale.

Viewport

Gets or sets the currently visible viewport in geo coordinates.

Declaration
public RectangleG Viewport { get; set; }
Property Value
RectangleG

The viewport.
Implements

ViewportInPixels

Gets or sets the viewport in pixels.

Declaration
public RectangleL ViewportInPixels { get; set; }
Property Value
RectangleL

The viewport in pixels.
Implements

Wraparound

Gets or sets a value indicating whether wraparound is enabled.

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

true if wraparound is enabled; otherwise, false.
Implements

ZoomLevel

Gets or sets the current zoom level.

Declaration
public virtual int ZoomLevel { get; set; }
Property Value
System.Int32

The zoom level.
Implements

Methods

ArrangeOverride(SizeF)

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

Returns
System.Drawing.SizeF

Overrides

BeginUpdate()

Suspends updates.

Declaration
public void BeginUpdate()

BringIntoView(PointG)

Brings the specified geo point into the center of the viewport.

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

The location.

BringIntoView(PointG, Int32)

Brings the specified geo point into the center of the viewport and zooms the viewport to the specified zoom level.

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

The location.
System.Int32 zoomLevel

The zoom level.

BringIntoView(RectangleG)

Calculates the best zoom level that will fit the specified rectangle and centers it in the viewport.

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

The rectangle.

CalculateViewport(SizeF)

Declaration
protected virtual void CalculateViewport(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

EndUpdate()

Resumes updates and performs an update.

Declaration
public void EndUpdate()

EndUpdate(Boolean)

Resumes updates and performs an update if specified by the update parameter.

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

if set to true an update is performed.

InitializeFields()

Declaration
protected override void InitializeFields()
Overrides

OnDoubleClick(EventArgs)

Declaration
protected override void OnDoubleClick(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnGesture(GestureEventArgs)

Declaration
protected override void OnGesture(GestureEventArgs args)
Parameters
GestureEventArgs args

Overrides

OnKeyDown(KeyEventArgs)

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

Overrides

OnKeyPress(KeyPressEventArgs)

Declaration
protected override void OnKeyPress(KeyPressEventArgs e)
Parameters
System.Windows.Forms.KeyPressEventArgs e

Overrides

OnKeyUp(KeyEventArgs)

Declaration
protected override void OnKeyUp(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

Overrides

OnMouseDown(MouseEventArgs)

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnMouseEnter(EventArgs)

Declaration
protected override void OnMouseEnter(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnMouseHover(EventArgs)

Declaration
protected override void OnMouseHover(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnMouseLeave(EventArgs)

Declaration
protected override void OnMouseLeave(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnMouseMove(MouseEventArgs)

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnMouseUp(MouseEventArgs)

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnMouseWheel(MouseEventArgs)

Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnPanGesture(PanGestureEventArgs)

Declaration
protected override void OnPanGesture(PanGestureEventArgs args)
Parameters
PanGestureEventArgs args

Overrides

OnPressAndTapGesture(PressAndTapGestureEventArgs)

Declaration
protected override void OnPressAndTapGesture(PressAndTapGestureEventArgs args)
Parameters
PressAndTapGestureEventArgs args

Overrides

OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

OnProviderInitializationComplete(IMapProvider)

Called when a map provider is initialized.

Declaration
public virtual void OnProviderInitializationComplete(IMapProvider mapProvider)
Parameters
IMapProvider mapProvider

The map provider.

OnProviderUpdated(IMapProvider)

Called when a provider updated occurs.

Declaration
public virtual void OnProviderUpdated(IMapProvider mapProvider)
Parameters
IMapProvider mapProvider

The map provider that was updated.

OnRotateGesture(RotateGestureEventArgs)

Declaration
protected override void OnRotateGesture(RotateGestureEventArgs args)
Parameters
RotateGestureEventArgs args

Overrides

OnScaleAnimationFinished(Object, AnimationStatusEventArgs)

Called when a zoom animation finishes.

Declaration
protected virtual void OnScaleAnimationFinished(object sender, AnimationStatusEventArgs e)
Parameters
System.Object sender

The sender.
AnimationStatusEventArgs e

The AnimationStatusEventArgs instance containing the event data.

OnSelectionChanged(MapSelectionChangedEventArgs)

Fires the SelectionChanged event.

Declaration
protected virtual void OnSelectionChanged(MapSelectionChangedEventArgs e)
Parameters
MapSelectionChangedEventArgs e

The MapSelectionChangedEventArgs instance containing the event data.

OnTwoFingerTapGesture(GestureEventArgs)

Declaration
protected override void OnTwoFingerTapGesture(GestureEventArgs args)
Parameters
GestureEventArgs args

Overrides

OnViewportChanged(ViewportChangeAction)

Called after the viewport changes.

Declaration
protected virtual void OnViewportChanged(ViewportChangeAction action)
Parameters
ViewportChangeAction action

The change action.

OnViewportChanged(ViewportChangedEventArgs)

Fires the ViewportChanged event.

Declaration
protected virtual void OnViewportChanged(ViewportChangedEventArgs e)
Parameters
ViewportChangedEventArgs e

The ViewportChangedEventArgs instance containing the event data.

OnZoomGesture(ZoomGestureEventArgs)

Declaration
protected override void OnZoomGesture(ZoomGestureEventArgs args)
Parameters
ZoomGestureEventArgs args

Overrides

PaintElement(IGraphics)

Paints the element, the providers content and the layers.

Declaration
protected virtual void PaintElement(IGraphics graphics)
Parameters
IGraphics graphics

The graphics.

PaintElement(IGraphics, Single, SizeF)

Declaration
protected override void PaintElement(IGraphics graphics, float angle, SizeF scale)
Parameters
IGraphics graphics

System.Single angle

System.Drawing.SizeF scale

Overrides

PaintLayers(IGraphics)

Paints the content of the layers.

Declaration
protected virtual void PaintLayers(IGraphics graphics)
Parameters
IGraphics graphics

The graphics.

PaintProvidersContent(IGraphics)

Paints the content of the providers.

Declaration
protected virtual void PaintProvidersContent(IGraphics graphics)
Parameters
IGraphics graphics

The graphics.

PaintZoomImage(IGraphics)

Paints the zoom image whild a zoom animation is ongoing.

Declaration
protected virtual void PaintZoomImage(IGraphics graphics)
Parameters
IGraphics graphics

The graphics.

Pan(Int64, Int64)

Pans the viewport to the specified x and y coordinates.

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

The x coordinate.
System.Int64 y

The y coordinate.

Pan(SizeL)

Pans the viewport with the specified delta.

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

The delta.

UpdatePanOffset()

Declaration
protected virtual void UpdatePanOffset()

UpdatePanOffset(Int64, Int64)

Declaration
protected virtual void UpdatePanOffset(long x, long y)
Parameters
System.Int64 x

System.Int64 y

UpdateViewport()

Declaration
protected virtual void UpdateViewport()

Zoom(Int32)

Zooms the viewport to the specified zoom level.

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

The zoom level.

Zoom(Int32, Boolean)

Zooms the viewport to the specified zoom level.

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

The zoom level.
System.Boolean animate

if set to true the zoom will be animated.

Zoom(Int32, Boolean, Point)

Zooms the viewport to the specified zoom level.

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

The zoom level.
System.Boolean animate

if set to true the zoom will be animated.
System.Drawing.Point center

The point in the viewport around where the zoom should be performed.

Events

SelectionChanged

Occurs when the selection changed.

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

ViewportChanged

Occurs when the viewport changed.

Declaration
public event EventHandler<ViewportChangedEventArgs> ViewportChanged
Event Type
System.EventHandler<ViewportChangedEventArgs>

Extension Methods