New to Telerik UI for WinForms? Start a free 30-day trial

Base class for geographic map overlays, providing viewport hooks and the fill, border, and text settings used to render them.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.RadMap.dll

Syntax:

C#
public abstract class MapVisualElement : IClusterable, IBorderElement, IBoxStyle, IBoxElement, IFillElement, ITextElement, IShapedElement

Inheritance: objectMapVisualElement

Derived Classes: MapPathBasedVisualElementMapTile

Implements: IBorderElementIBoxElementIBoxStyleIClusterableIFillElementIShapedElementITextElement...

Constructors

Initializes a new instance of the MapVisualElement class.

C#
public MapVisualElement()

Properties

Gets or sets the first fill color; additional colors are used according to NumberOfColors and GradientStyle.

C#
public virtual Color BackColor { get; set; }

Implements: IFillElement.BackColor

Gets or sets the second fill color used by multi-color fill styles.

C#
public virtual Color BackColor2 { get; set; }

Implements: IFillElement.BackColor2

Gets or sets the third fill color used when NumberOfColors is at least three.

C#
public virtual Color BackColor3 { get; set; }

Implements: IFillElement.BackColor3

Gets or sets the fourth fill color used when NumberOfColors is four.

C#
public virtual Color BackColor4 { get; set; }

Implements: IFillElement.BackColor4

Gets or sets the primary border color; additional border colors can provide gradient stops.

C#
public Color BorderColor { get; set; }

Gets or sets the second border gradient color.

C#
public virtual Color BorderColor2 { get; set; }

Gets or sets the third border gradient color.

C#
public virtual Color BorderColor3 { get; set; }

Gets or sets the fourth border gradient color.

C#
public virtual Color BorderColor4 { get; set; }

Gets or sets the custom dash pattern used when the border dash style supports a custom pattern.

C#
public virtual float[] BorderDashPattern { get; set; }

Implements: IBorderElement.BorderDashPattern

Gets or sets the dash style applied to border strokes.

C#
public virtual DashStyle BorderDashStyle { get; set; }

Implements: IBorderElement.BorderDashStyle

Gets or sets the overlap order used when independently styled border edges meet.

C#
public virtual BorderDrawModes BorderDrawMode { get; set; }

Implements: IBorderElement.BorderDrawMode

Gets or sets the combined horizontal and vertical extents occupied by the border.

C#
public virtual SizeF BorderSize { get; set; }

Implements: IBoxElement.BorderSize

Gets or sets the shared border thickness; this property forwards to Width.

C#
public virtual float BorderWidth { get; set; }

Gets or sets the color of the bottom edge when BoxStyle is FourBorders.

C#
public virtual Color BottomColor { get; set; }

Implements: IBoxStyle.BottomColor

Gets or sets the shadow color of the bottom edge in four-border mode.

C#
public virtual Color BottomShadowColor { get; set; }

Implements: IBoxStyle.BottomShadowColor

Gets or sets the bottom-edge thickness used in four-border mode.

C#
public virtual float BottomWidth { get; set; }

Implements: IBoxElement.BottomWidth

Gets or sets whether the border is drawn as one outline, four independently styled edges, or nested inner and outer outlines.

C#
public virtual BorderBoxStyle BoxStyle { get; set; }

Implements: IBorderElement.BoxStyle

Gets or sets the font.

C#
public virtual Font Font { get; set; }
Property Value:

The font.

Implements: ITextElement.Font

Gets or sets the fore color.

C#
public virtual Color ForeColor { get; set; }
Property Value:

The fore color.

Implements: ITextElement.ForeColor

Gets the geographic bounds.

C#
public virtual RectangleG GeographicBounds { get; }
Property Value:

The geographic bounds.

Implements: IClusterable.GeographicBounds

Gets or sets the angle passed to linear and radial fill and border gradients.

C#
public virtual float GradientAngle { get; set; }

Implements: IBorderElement.GradientAngleIFillElement.GradientAngle

Gets or sets a transition position used by gradient styles; in a fill with three or more colors, it positions the second color stop.

C#
public virtual float GradientPercentage { get; set; }

Implements: IFillElement.GradientPercentage

Gets or sets a second transition position used by gradient styles; in a four-color fill, it positions the third color stop.

C#
public virtual float GradientPercentage2 { get; set; }

Implements: IFillElement.GradientPercentage2

Gets or sets the fill and border gradient treatment, such as solid, linear, radial, or glass-like rendering.

C#
public virtual GradientStyles GradientStyle { get; set; }

Implements: IBorderElement.GradientStyleIFillElement.GradientStyle

Gets or sets the combined width of the left and right borders.

C#
public virtual float HorizontalWidth { get; set; }

Implements: IBoxElement.HorizontalWidth

Gets or sets the primary inner-border color used with OuterInnerBorders.

C#
public virtual Color InnerColor { get; set; }

Implements: IBorderElement.InnerColor

Gets or sets the second inner-border gradient color.

C#
public virtual Color InnerColor2 { get; set; }

Implements: IBorderElement.InnerColor2

Gets or sets the third inner-border gradient color.

C#
public virtual Color InnerColor3 { get; set; }

Implements: IBorderElement.InnerColor3

Gets or sets the fourth inner-border gradient color.

C#
public virtual Color InnerColor4 { get; set; }

Implements: IBorderElement.InnerColor4

Gets a value indicating whether this instance is visible in the viewport.

C#
public abstract bool IsInViewport { get; }
Property Value:

true if this instance is visible in the viewport.; otherwise, false.

Gets a value indicating whether this instance is selected.

C#
public virtual bool IsSelected { get; }
Property Value:

true if this instance is selected; otherwise, false.

Gets or sets a value indicating whether this instance is visible.

C#
public virtual bool IsVisible { get; set; }
Property Value:

true if this instance is visible; otherwise, false.

Gets the layer this element is added to.

C#
public MapLayer Layer { get; }
Property Value:

The layer.

Gets or sets the color of the left edge when BoxStyle is FourBorders.

C#
public virtual Color LeftColor { get; set; }

Implements: IBoxStyle.LeftColor

Gets or sets the shadow color of the left edge in four-border mode.

C#
public virtual Color LeftShadowColor { get; set; }

Implements: IBoxStyle.LeftShadowColor

Gets or sets the left-edge thickness used in four-border mode.

C#
public virtual float LeftWidth { get; set; }

Implements: IBoxElement.LeftWidth

Gets or sets the location.

C#
public virtual PointG Location { get; set; }
Property Value:

The location.

Implements: IClusterable.Location

Gets or sets how many of the four fill colors participate in rendering.

C#
public virtual int NumberOfColors { get; set; }

Implements: IFillElement.NumberOfColors

Gets or sets the top-left inset of the element's border box.

C#
public virtual SizeF Offset { get; set; }

Implements: IBoxElement.Offset

C#
public virtual object RawResource { get; set; }

Implements: ITextElement.RawResource

Gets or sets the color of the right edge when BoxStyle is FourBorders.

C#
public virtual Color RightColor { get; set; }

Implements: IBoxStyle.RightColor

Gets or sets the shadow color of the right edge in four-border mode.

C#
public virtual Color RightShadowColor { get; set; }

Implements: IBoxStyle.RightShadowColor

Gets or sets the right-edge thickness used in four-border mode.

C#
public virtual float RightWidth { get; set; }

Implements: IBoxElement.RightWidth

Gets or sets the optional element shape returned by GetCurrentShape().

C#
public ElementShape Shape { get; set; }

Gets or sets the element's pixel dimensions, used by point and pin overlays to size their marker paths.

C#
public virtual Size Size { get; set; }

Implements: IFillElement.Size

Gets or sets the smoothing mode applied while the fill and border are drawn.

C#
public virtual SmoothingMode SmoothingMode { get; set; }

Implements: IBorderElement.SmoothingModeIFillElement.SmoothingMode

Gets or sets application data associated with this element; the map renderer does not interpret the value.

C#
public object Tag { get; set; }

Gets or sets the text.

C#
public virtual string Text { get; set; }
Property Value:

The text.

Implements: ITextElement.Text

Gets or sets the text of the tool tip for this element.

C#
public virtual string ToolTipText { get; set; }
Property Value:

The tool tip text.

Implements: IClusterable.ToolTipText

Gets or sets the color of the top edge when BoxStyle is FourBorders.

C#
public virtual Color TopColor { get; set; }

Implements: IBoxStyle.TopColor

Gets or sets the shadow color of the top edge in four-border mode.

C#
public virtual Color TopShadowColor { get; set; }

Implements: IBoxStyle.TopShadowColor

Gets or sets the top-edge thickness used in four-border mode.

C#
public virtual float TopWidth { get; set; }

Implements: IBoxElement.TopWidth

Gets or sets the combined width of the top and bottom borders.

C#
public virtual float VerticalWidth { get; set; }

Implements: IBoxElement.VerticalWidth

Methods

Returns the shape assigned to Shape for consumers that request the element's current drawing shape.

C#
public virtual ElementShape GetCurrentShape()
Returns:

ElementShape

The assigned shape, or null when no shape is set.

Implements: IShapedElement.GetCurrentShape()

Gets the geographic bounds of elements that consist of more than one figure.

C#
public virtual RectangleG[] GetGeographicBounds()
Returns:

RectangleG[]

RectangleG[].

Tests whether a map-pixel point falls within any geographic bounds of the element, including horizontal wraparound copies.

C#
public virtual bool HitTest(PointG pointG, PointL pointL, IMapViewport viewport)
Parameters:pointGPointG

The geographic coordinate corresponding to the point being tested.

pointLPointL

The map-pixel coordinate tested against the projected bounds.

viewportIMapViewport

The viewport whose zoom level determines the projection and wraparound range.

Returns:

bool

true if the point is inside one of the projected bounds; otherwise, false.

Paints the element to the specified graphics.

C#
public abstract void Paint(IGraphics graphics, IMapViewport viewport)
Parameters:graphicsIGraphics

The graphics.

viewportIMapViewport

The viewport.

Called when the viewport changes.

C#
public abstract void ViewportChanged(IMapViewport viewport, ViewportChangeAction action)
Parameters:viewportIMapViewport

The viewport.

actionViewportChangeAction

The action.