Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

MarkupLabelUIElement Class

Namespace:
ActiproSoftware.UI.WinForms.Controls.MarkupLabel
Assembly:
ActiproSoftware.Shared.WinForms.dll

Provides the base class for a MarkupLabelUIElement.

public abstract class MarkupLabelUIElement : UIElement, IInputElement, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable
Inheritance:
object MarshalByRefObject MarshalByRefDisposableObject LogicalTreeNodeBase UIElement object
Derived:
MarkupLabelImageUIElement MarkupLabelLineBreakUIElement MarkupLabelTextUIElement
Implements:
IInputElement IUIElement ILogicalTreeNode IDpiAwareElement IDisposable

Constructors

MarkupLabelUIElement(MarkupLabelElement)

Provides the base class for a MarkupLabelUIElement.

protected MarkupLabelUIElement(MarkupLabelElement element)
Parameter Type Description
element MarkupLabelElement

The MarkupLabelElement that owns this element.

Properties

CaptureMouseWhenPressed

Indicates whether to automatically capture the mouse when the element is pressed.

protected override bool CaptureMouseWhenPressed { get; }

Property Value

bool:

true if the mouse should automatically be captured when the element is pressed; otherwise, false.

Descent

The descent from the baseline that the element has.

public virtual int Descent { get; }

Property Value

int

Element

The MarkupLabelElement that owns this element.

public MarkupLabelElement Element { get; }

Property Value

MarkupLabelElement

HardLineBreakBefore

Indicates whether a hard line break should occur before the element.

public virtual bool HardLineBreakBefore { get; }

Property Value

bool:

true if a hard line break should occur before the element; otherwise, false.

InvalidateOnMouseEvents

Indicates whether to invalidate the element when mouse events occur.

protected override bool InvalidateOnMouseEvents { get; }

Property Value

bool:

true if the element should be invalidated when mouse events occur; otherwise, false.

Methods

GetCursor(Point)

Returns the Cursor that should be used when the mouse is over the element at the specified Point.

public override Cursor? GetCursor(Point point)
Parameter Type Description
point Point

The Point to examine.

Returns

Cursor

GetDrawState()

The UIElementDrawState for the element.

public override UIElementDrawState GetDrawState()

Returns

UIElementDrawState

Remarks

The default implementation of this method returns None.

MeasureOverride(Graphics?, Size)

Measures the size in layout required for child elements and determines a size for the element itself.

protected override Size MeasureOverride(Graphics? g, Size availableSize)
Parameter Type Description
g Graphics

The Graphics object to use for measurement.
availableSize Size

The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available.

Returns

Size:

The size that this element determines it needs during layout, based on its calculations of child element sizes.

Remarks

Element authors should override this method, call Measure(Graphics?, Size) on each visible child element and determine the total size required.

OnMouseUp(MouseEventArgs)

Raises the MouseUp event.

protected override void OnMouseUp(MouseEventArgs e)
Parameter Type Description
e MouseEventArgs

The event data.

Inherited Members

Extension Methods