Class BaseWidget

Inheritance

object

BaseWidget

Implements

IWidget

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Mapsui.Widgets

Assembly: Mapsui.dll

Syntax

public abstract class BaseWidget : IWidget

Properties

| Edit this page View Source

Enabled

Is Widget visible on screen

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
bool

| Edit this page View Source

Envelope

Envelope of Widget

Declaration

public MRect? Envelope { get; set; }

Property Value

Type	Description
MRect

| Edit this page View Source

Height

Height of Widget

Declaration

public double Height { get; set; }

Property Value

Type	Description
double

| Edit this page View Source

HorizontalAlignment

Horizontal alignment of Widget

Declaration

public HorizontalAlignment HorizontalAlignment { get; set; }

Property Value

Type	Description
HorizontalAlignment

| Edit this page View Source

InputAreaType

Type of area to use for touch events. The default is WidgetArea. This needs to be set to 'Map' in the constructor if widget want to receive manipulation events from all over the map.

Declaration

public InputAreaType InputAreaType { get; init; }

Property Value

Type	Description
InputAreaType

| Edit this page View Source

InputTransparent

Declaration

public bool InputTransparent { get; init; }

Property Value

Type	Description
bool

| Edit this page View Source

Margin

Margin outside of the widget

Declaration

public MRect Margin { get; set; }

Property Value

Type	Description
MRect

| Edit this page View Source

Position

Position for absolute alignment

Declaration

public MPoint Position { get; set; }

Property Value

Type	Description
MPoint

| Edit this page View Source

VerticalAlignment

Vertical alignment of Widget

Declaration

public VerticalAlignment VerticalAlignment { get; set; }

Property Value

Type	Description
VerticalAlignment

| Edit this page View Source

Width

Width of Widget

Declaration

public double Width { get; set; }

Property Value

Type	Description
double

| Edit this page View Source

WithPointerMovedEvent

This is an init only property to allow PointerMoved event initialization within an expression body method.

Declaration

public EventHandler<WidgetEventArgs>? WithPointerMovedEvent { init; }

Property Value

Type	Description
EventHandler<WidgetEventArgs>

| Edit this page View Source

WithPointerPressedEvent

This is an init only property to allow PointerPressed event initialization within an expression body method.

Declaration

public EventHandler<WidgetEventArgs>? WithPointerPressedEvent { init; }

Property Value

Type	Description
EventHandler<WidgetEventArgs>

| Edit this page View Source

WithPointerReleased

This is an init only property to allow PointerReleased event initialization within an expression body method.

Declaration

public EventHandler<WidgetEventArgs>? WithPointerReleased { init; }

Property Value

Type	Description
EventHandler<WidgetEventArgs>

| Edit this page View Source

WithTappedEvent

This is an init only property to allow Tapped event initialization within an expression body method.

Declaration

public EventHandler<WidgetEventArgs>? WithTappedEvent { init; }

Property Value

Type	Description
EventHandler<WidgetEventArgs>

Methods

| Edit this page View Source

OnPointerMoved(WidgetEventArgs)

Function, which handles the widget pointer moved event

Declaration

public virtual void OnPointerMoved(WidgetEventArgs e)

Parameters

Type	Name	Description
WidgetEventArgs	e	Arguments for this widget touch

| Edit this page View Source

OnPointerPressed(WidgetEventArgs)

Function, which handles the widget pointer pressed event

Declaration

public virtual void OnPointerPressed(WidgetEventArgs e)

Parameters

Type	Name	Description
WidgetEventArgs	e	Arguments for this widget touch

| Edit this page View Source

OnPointerReleased(WidgetEventArgs)

Function, which handles the widget pointer released event

Declaration

public virtual void OnPointerReleased(WidgetEventArgs e)

Parameters

Type	Name	Description
WidgetEventArgs	e	Arguments for this widget touch

| Edit this page View Source

OnTapped(WidgetEventArgs)

Function, which handles the widget tapped event

Declaration

public virtual void OnTapped(WidgetEventArgs e)

Parameters

Type	Name	Description
WidgetEventArgs	e	Arguments for this widget touch

| Edit this page View Source

UpdateEnvelope(double, double, double, double)

Declaration

public void UpdateEnvelope(double maxWidth, double maxHeight, double screenWidth, double screenHeight)

Parameters

Type	Name	Description
double	maxWidth
double	maxHeight
double	screenWidth
double	screenHeight

Events

| Edit this page View Source

PointerMoved

Event which is called if widget is moved.

Declaration

public event EventHandler<WidgetEventArgs>? PointerMoved

Event Type

Type	Description
EventHandler<WidgetEventArgs>

| Edit this page View Source

PointerPressed

Event which is called if widget is pressed.

Declaration

public event EventHandler<WidgetEventArgs>? PointerPressed

Event Type

Type	Description
EventHandler<WidgetEventArgs>

| Edit this page View Source

PointerReleased

Event which is called if widget is released.

Declaration

public event EventHandler<WidgetEventArgs>? PointerReleased

Event Type

Type	Description
EventHandler<WidgetEventArgs>

| Edit this page View Source

Tapped

Event which is called if widget is tapped.

Declaration

public event EventHandler<WidgetEventArgs>? Tapped

Event Type

Type	Description
EventHandler<WidgetEventArgs>

Implements

IWidget

Extension Methods

DisposableExtension.DisposeIfDisposable(object?)