Search Results for

    Show / Hide Table of Contents

    Class RulerWidget

    Inheritance
    object
    BaseWidget
    RulerWidget
    Implements
    IWidget
    Inherited Members
    BaseWidget.InputAreaType
    BaseWidget.HorizontalAlignment
    BaseWidget.VerticalAlignment
    BaseWidget.Margin
    BaseWidget.Position
    BaseWidget.Width
    BaseWidget.Height
    BaseWidget.Envelope
    BaseWidget.Enabled
    BaseWidget.InputTransparent
    BaseWidget.WithTappedEvent
    BaseWidget.WithPointerPressedEvent
    BaseWidget.WithPointerMovedEvent
    BaseWidget.WithPointerReleased
    BaseWidget.Tapped
    BaseWidget.PointerPressed
    BaseWidget.PointerMoved
    BaseWidget.PointerReleased
    BaseWidget.UpdateEnvelope(double, double, double, double)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Mapsui.Widgets.InfoWidgets
    Assembly: Mapsui.dll
    Syntax
    public class RulerWidget : BaseWidget, IWidget

    Constructors

    | Edit this page View Source

    RulerWidget()

    Declaration
    public RulerWidget()

    Properties

    | Edit this page View Source

    Color

    Declaration
    public Color Color { get; set; }
    Property Value
    Type Description
    Color
    | Edit this page View Source

    ColorOfBeginAndEndDots

    Declaration
    public Color ColorOfBeginAndEndDots { get; set; }
    Property Value
    Type Description
    Color
    | Edit this page View Source

    CurrentPosition

    Declaration
    public MPoint? CurrentPosition { get; }
    Property Value
    Type Description
    MPoint
    | Edit this page View Source

    DistanceInKilometers

    Declaration
    public double? DistanceInKilometers { get; }
    Property Value
    Type Description
    double?
    | Edit this page View Source

    InfoBox

    Declaration
    public TextBoxWidget InfoBox { get; set; }
    Property Value
    Type Description
    TextBoxWidget
    | Edit this page View Source

    IsActive

    Declaration
    public bool IsActive { get; set; }
    Property Value
    Type Description
    bool
    | Edit this page View Source

    ShowInfoNextToRuler

    Gets or sets a value indicating whether the info should be shown next to the ruler. When set to false you can use the RulerWidget.InfoBox fields to position it like any other widget.

    Declaration
    public bool ShowInfoNextToRuler { get; set; }
    Property Value
    Type Description
    bool
    | Edit this page View Source

    StartPosition

    Declaration
    public MPoint? StartPosition { get; }
    Property Value
    Type Description
    MPoint

    Methods

    | Edit this page View Source

    OnPointerMoved(WidgetEventArgs)

    Function, which handles the widget pointer moved event

    Declaration
    public override void OnPointerMoved(WidgetEventArgs e)
    Parameters
    Type Name Description
    WidgetEventArgs e

    Arguments for this widget touch

    Overrides
    BaseWidget.OnPointerMoved(WidgetEventArgs)
    | Edit this page View Source

    OnPointerPressed(WidgetEventArgs)

    Function, which handles the widget pointer pressed event

    Declaration
    public override void OnPointerPressed(WidgetEventArgs e)
    Parameters
    Type Name Description
    WidgetEventArgs e

    Arguments for this widget touch

    Overrides
    BaseWidget.OnPointerPressed(WidgetEventArgs)
    | Edit this page View Source

    OnPointerReleased(WidgetEventArgs)

    Function, which handles the widget pointer released event

    Declaration
    public override void OnPointerReleased(WidgetEventArgs e)
    Parameters
    Type Name Description
    WidgetEventArgs e

    Arguments for this widget touch

    Overrides
    BaseWidget.OnPointerReleased(WidgetEventArgs)
    | Edit this page View Source

    OnTapped(WidgetEventArgs)

    Function, which handles the widget tapped event

    Declaration
    public override void OnTapped(WidgetEventArgs e)
    Parameters
    Type Name Description
    WidgetEventArgs e

    Arguments for this widget touch

    Overrides
    BaseWidget.OnTapped(WidgetEventArgs)
    | Edit this page View Source

    Reset()

    Declaration
    public void Reset()
    | Edit this page View Source

    SnapToFeature(Func<MPoint?, IFeature?>)

    Declaration
    public (IFeature? startFeature, IFeature? currentFeature) SnapToFeature(Func<MPoint?, IFeature?> getFeaturesToSnapTo)
    Parameters
    Type Name Description
    Func<MPoint, IFeature> getFeaturesToSnapTo
    Returns
    Type Description
    (IFeature startFeature, IFeature currentFeature)

    Events

    | Edit this page View Source

    DistanceUpdated

    Declaration
    public event EventHandler<RulerWidget.RulerWidgetUpdatedEventArgs>? DistanceUpdated
    Event Type
    Type Description
    EventHandler<RulerWidget.RulerWidgetUpdatedEventArgs>

    Implements

    IWidget

    Extension Methods

    DisposableExtension.DisposeIfDisposable(object?)
    • Edit this page
    • View Source
    In this article
    Back to top Generated by DocFX