maze-project
Show / Hide Table of Contents

Class BorderBox

The BorderBox class represents a border that can be drawn either as a solid box or as an animated dashed line

Inheritance
object
BorderBox
Namespace: Maze.Maui.Controls.InteractiveGrid
Assembly: Maze.Maui.Controls.dll
Syntax
public class BorderBox : GraphicsView

Constructors

BorderBox(Icon, float)

Constructor

Declaration
public BorderBox(Icon hoverIcon, float dashThickness)
Parameters
Type Name Description
Icon hoverIcon

The icon to be displayed when the mouse pointer hovers over the object

float dashThickness

The thickness of the dashes (in DIPs). This is their height for a horizontal box and their width for a vertical box.

Properties

AnimationCycleIndex

The index within the box animation cycle. Only applies when dash animation is enabled.

Declaration
public int AnimationCycleIndex { get; set; }
Property Value
Type Description
int

Animation cycle index

Color

The color of the box

Declaration
public Color Color { get; set; }
Property Value
Type Description
Color

Box color

DashPattern

The pattern of dashes and gaps used to draw the box (in DIPs). Only applies when dash animation is enabled.

Declaration
public float[] DashPattern { get; }
Property Value
Type Description
float[]

Dash pattern

DashThickness

The thickness of the dashes when the border is drawn (in DIPs). This is their height for a horizontal box and their width for a vertical box. Only applies when dash animation is enabled.

Declaration
public float DashThickness { get; set; }
Property Value
Type Description
float

Dash thickness

HoverIcon

The icon to be displayed when the mouse pointer hovers over the object

Declaration
public Icon HoverIcon { get; set; }
Property Value
Type Description
Icon

Hover icon

Methods

EnableDashAnimation(bool)

Enables or disables dash animation

Declaration
public void EnableDashAnimation(bool enable)
Parameters
Type Name Description
bool enable

Flag indicating whether to enable animation

UpdateDashAnimation()

Updates the dash animation displayed by one cycle. Only applies when dash animation is enabled.

Declaration
public void UpdateDashAnimation()

Events

PanUpdated

The registered pan updated event handler (if any)

Declaration
public event BorderBox.PanUpdatedHandler? PanUpdated
Event Type
Type Description
BorderBox.PanUpdatedHandler

Pan updated event handler

In this article
Back to top Generated by DocFX