MarkupLabel Class

[ToolboxBitmap(typeof(MarkupLabel))]
public class MarkupLabel : UIControl, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable

public MarkupLabel()

Remarks

The default constructor initializes all fields to their default values.

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

• LinkColor

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

Property Value

Color:

A Color that represents the background color of 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.

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

Property Value

Font:

The Font object to apply to the text displayed by the control.

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

Property Value

Color:

A Color that represents the foreground color of the control.

public Color LinkColor { get; set; }

Property Value

Color:

A Color that represents the color used to display a normal link. The default color in high contrast environments is specified by the system, otherwise the default is Color.Blue.

See Also

• ActiveLinkColor

public int MaxWidth { get; set; }

Property Value

int:

The maximum width of the element.

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

Property Value

MarkupLabelElement:

The MarkupLabelElement that is the root element.

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

Property Value

string:

The markup text to display in the label.

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.

protected override IList CreateChildren()

Returns

IList:

The IList that should be assigned to the Children property.

Remarks

By default no child collection is created.

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.

Remarks

This method is called by the public Dispose method and the Finalize method. Dispose invokes this method with the disposing parameter set to true. Finalize invokes this method with disposing set to false.

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

• DpiScaleFactor

public Size GetPreferredSize()

Returns

Size:

A Size containing the preferred size of the control.

protected virtual void OnDownloadImage(MarkupLabelDownloadImageEventArgs e)

Parameter	Type	Description
e	MarkupLabelDownloadImageEventArgs	An MarkupLabelDownloadImageEventArgs that contains the event data.

protected override sealed void OnFontChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnLinkClick(MarkupLabelLinkClickEventArgs e)

Parameter	Type	Description
e	MarkupLabelLinkClickEventArgs	An MarkupLabelLinkClickEventArgs that contains the event data.

protected override void OnResize(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

public event MarkupLabelDownloadImageEventHandler DownloadImage

Event Type

MarkupLabelDownloadImageEventHandler

public event MarkupLabelLinkClickEventHandler LinkClick

Event Type

MarkupLabelLinkClickEventHandler