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

MarkupLabel Class

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

Represents a label that is capable of formatting simple HTML tags.

[ToolboxBitmap(typeof(MarkupLabel))]
public class MarkupLabel : UIControl, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable
Inheritance:
object MarshalByRefObject Component Control ScrollableControl UIControl object
Implements:
IUIControl IUIElement ILogicalTreeNode IDpiAwareElement IDisposable

Constructors

MarkupLabel()

Initializes an instance of the class.

public MarkupLabel()

Properties

ActiveLinkColor

The color used when displaying an active link.

public Color ActiveLinkColor { get; set; }

Property Value

Color:

A Color that represents the color used to display an active link. The default color is Color.Red.

See Also

BackColor

Gets or sets the background color for the control.

[Browsable(true)]
public override Color BackColor { get; set; }

Property Value

Color:

A Color that represents the background color of the control. The default is the value of the DefaultBackColor property.

BackgroundImage

Gets or sets the background image displayed in the control.

[Browsable(true)]
public override Image? BackgroundImage { get; set; }

Property Value

Image:

An Image that represents the image to display in the background of the control.

Font

Gets or sets the font of the text displayed by the control.

[Browsable(true)]
public override Font Font { get; set; }

Property Value

Font:

The Font to apply to the text displayed by the control. The default is the value of the DefaultFont property.

ForeColor

Gets or sets the foreground color of the control.

[Browsable(true)]
public override Color ForeColor { get; set; }

Property Value

Color:

The foreground Color of the control. The default is the value of the DefaultForeColor property.

LinkColor

The color used when displaying a normal link.

public Color LinkColor { get; set; }

Property Value

Color:

The default color in high contrast environments is specified by the system, otherwise the default is Color.Blue.

See Also

MaxWidth

The maximum width of the element.

public int MaxWidth { get; set; }

Property Value

int

RootElement

The MarkupLabelElement that is the root element.

[Browsable(true)]
public MarkupLabelElement? RootElement { get; }

Property Value

MarkupLabelElement

Text

The markup text to display in the label.

[Browsable(true)]
public override string Text { get; set; }

Property Value

string

Methods

ArrangeOverride(Size)

Positions child elements and determines an arrange size.

protected override Size ArrangeOverride(Size finalSize)
Parameter Type Description
finalSize Size

The final area within the parent that this element should use to arrange itself and its children.

Returns

Size:

The actual size used.

Remarks

Element authors should override this method, call Arrange(Rectangle) on each visible child element and position each child element. It is required that a parent element calls Arrange(Rectangle) on each child or they won't be rendered.

CreateChildren()

Invoked when the collection of child elements is to be created.

protected override IList<ILogicalTreeNode>? CreateChildren()

Returns

IList<ILogicalTreeNode>:

The list that should be assigned to the Children property.

Remarks

By default, no child collection is created.

Dispose(bool)

Releases the unmanaged resources used by the Control and its child controls and optionally releases the managed resources.

protected override void Dispose(bool disposing)
Parameter Type Description
disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

DpiScaleChanged(SizeF)

Called when the DPI-based scale factor of the element changes.

public override void DpiScaleChanged(SizeF scaleFactor)
Parameter Type Description
scaleFactor SizeF

The new scale factor where Width is applied to the x-axis, and Height is applied to the y-axis.

See Also

GetPreferredSize()

Returns the preferred size of the control.

public Size GetPreferredSize()

Returns

Size

OnDownloadImage(MarkupLabelDownloadImageEventArgs)

Raises the DownloadImage event.

protected virtual void OnDownloadImage(MarkupLabelDownloadImageEventArgs e)
Parameter Type Description
e MarkupLabelDownloadImageEventArgs

The event data.

OnFontChanged(EventArgs)

Raises the FontChanged event.

protected override sealed void OnFontChanged(EventArgs e)
Parameter Type Description
e EventArgs

An EventArgs that contains the event data.

OnLinkClick(MarkupLabelLinkClickEventArgs)

Raises the LinkClickevent.

protected virtual void OnLinkClick(MarkupLabelLinkClickEventArgs e)
Parameter Type Description
e MarkupLabelLinkClickEventArgs

The event data.

OnResize(EventArgs)

Raises the Resize event.

protected override void OnResize(EventArgs e)
Parameter Type Description
e EventArgs

An EventArgs that contains the event data.

Events

DownloadImage

Occurs when an image needs to be downloaded for a MarkupLabelImageElement.

public event MarkupLabelDownloadImageEventHandler? DownloadImage

Event Type

MarkupLabelDownloadImageEventHandler

LinkClick

Occurs after a MarkupLabelAnchorElement is clicked.

public event MarkupLabelLinkClickEventHandler? LinkClick

Event Type

MarkupLabelLinkClickEventHandler

Inherited Members

Extension Methods