In This Article

MarkupLabelElement Class

Provides the base class for a MarkupLabel element.

public abstract class MarkupLabelElement : LogicalTreeNodeBase, IDisposable, ILogicalTreeNode
Inheritance:
object MarshalByRefObject MarshalByRefDisposableObject LogicalTreeNodeBase object
Derived:
MarkupLabelAnchorElement MarkupLabelBodyElement MarkupLabelBoldElement MarkupLabelEmphasisElement MarkupLabelImageElement MarkupLabelItalicElement MarkupLabelLineBreakElement MarkupLabelSpanElement MarkupLabelStrongElement MarkupLabelTextElement MarkupLabelUnderlineElement
Implements:
IDisposable ILogicalTreeNode

Constructors

MarkupLabelElement(string?)

Initializes an instance of the class.

public MarkupLabelElement(string? elementName)
Parameter Type Description
elementName string

The name of the element represented by this class.

Properties

Children

The collection of child objects.

public IList<ILogicalTreeNode> Children { get; }

Property Value

IList<ILogicalTreeNode>

ClassName

The class name of the element.

public string? ClassName { get; set; }

Property Value

string

CssData

The MarkupLabelCssData specifying CSS data for the element.

public MarkupLabelCssData CssData { get; }

Property Value

MarkupLabelCssData

DpiScaleFactor

The DPI scale factor to be applied when rendering the element, where Width is applied to the x-axis, and Height is applied to the y-axis.

protected virtual SizeF DpiScaleFactor { get; }

Property Value

SizeF

ElementName

The name of the element represented by this class.

public string? ElementName { get; }

Property Value

string

Id

The id of the element.

public string? Id { get; set; }

Property Value

string

MarkupLabel

The MarkupLabel that owns the element.

public virtual MarkupLabel? MarkupLabel { get; }

Property Value

MarkupLabel

Parent

The object that is parent to this object.

public MarkupLabelElement Parent { get; }

Property Value

MarkupLabelElement

Style

The CSS style string for the element.

public string Style { get; set; }

Property Value

string

VerticalAlignment

A MarkupLabelElementVerticalAlignment indicating the vertical alignment.

public MarkupLabelElementVerticalAlignment VerticalAlignment { get; set; }

Property Value

MarkupLabelElementVerticalAlignment

Methods

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, a null value is returned.

CreateUIElement(IUIElement)

Creates the IUIElement tree from the element.

protected virtual void CreateUIElement(IUIElement parentUIElement)
Parameter Type Description
parentUIElement IUIElement

The parent IUIElement.

GetBackColor(UIElementDrawState)

Returns the background Color to use for drawing the element.

public virtual Color GetBackColor(UIElementDrawState drawState)
Parameter Type Description
drawState UIElementDrawState

A UIElementDrawState indicating the draw state.

Returns

Color

GetDefaultCssData()

Returns the default MarkupLabelCssData for the element.

public virtual MarkupLabelCssData GetDefaultCssData()

Returns

MarkupLabelCssData

GetFont()

Returns the Font to use for drawing text in the element.

public Font GetFont()

Returns

Font

GetFont(string?, float, MarkupLabelFontWeight, MarkupLabelFontStyle, MarkupLabelTextDecoration, UIElementDrawState)

Returns the Font to use for drawing text in the element.

public virtual Font GetFont(string? fontFamily, float fontSize, MarkupLabelFontWeight fontWeight, MarkupLabelFontStyle fontStyle, MarkupLabelTextDecoration textDecoration, UIElementDrawState drawState)
Parameter Type Description
fontFamily string

The font family.

fontSize float

The font size.

fontWeight MarkupLabelFontWeight

A MarkupLabelFontWeight indicating the font weight.

fontStyle MarkupLabelFontStyle

A MarkupLabelFontStyle indicating the font style.

textDecoration MarkupLabelTextDecoration

A MarkupLabelTextDecoration indicating the text decoration.

drawState UIElementDrawState

A UIElementDrawState indicating the draw state.

Returns

Font

GetForeColor(UIElementDrawState)

The foreground Color to use for drawing the element.

public virtual Color GetForeColor(UIElementDrawState drawState)
Parameter Type Description
drawState UIElementDrawState

A UIElementDrawState indicating the draw state.

Returns

Color

ToString()

Returns the string representation of this object.

public override string? ToString()

Returns

string:

The string representation of this object.

Inherited Members

Extension Methods