Struct Underline

Namespace

SharpDX.DirectWrite

Assembly

SharpDX.Direct2D1.dll

Contains information about the width, thickness, offset, run height, reading direction, and flow direction of an underline.

public struct Underline

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Remarks

All coordinates are in device independent pixels (DIPs).

Fields

FlowDirection

A value that indicates the flow direction of the text associated with the underline. This value is used to interpret whether the thickness value advances top to bottom, left to right, or right to left.

public FlowDirection FlowDirection

Field Value

FlowDirection

LocaleName

An array of characters which contains the locale of the text that the underline is being drawn under. For example, in vertical text, the underline belongs on the left for Chinese but on the right for Japanese.

public string LocaleName

Field Value

string

MeasuringMode

The measuring mode can be useful to the renderer to determine how underlines are rendered, such as rounding the thickness to a whole pixel in GDI-compatible modes.

public MeasuringMode MeasuringMode

Field Value

MeasuringMode

Offset

A value that indicates the offset of the underline from the baseline. A positive offset represents a position below the baseline (away from the text) and a negative offset is above (toward the text).

public float Offset

Field Value

float

ReadingDirection

A value that indicates the reading direction of the text associated with the underline. This value is used to interpret whether the width value runs horizontally or vertically.

public ReadingDirection ReadingDirection

Field Value

ReadingDirection

RunHeight

A value that indicates the height of the tallest run where the underline is applied.

public float RunHeight

Field Value

float

Thickness

A value that indicates the thickness of the underline, measured perpendicular to the baseline.

public float Thickness

Field Value

float

Width

A value that indicates the width of the underline, measured parallel to the baseline.

public float Width

Field Value

float