Struct DWriteOverhangMetrics

The DWRITE_OVERHANG_METRICS structure holds how much any visible pixels (in DIPs) overshoot each side of the layout or inline objects.

Implements

IEquatable<DWriteOverhangMetrics>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: JeremyAnsel.DirectX.DWrite

Assembly: JeremyAnsel.DirectX.DWrite.dll

Syntax

public struct DWriteOverhangMetrics : IEquatable<DWriteOverhangMetrics>

Remarks

Positive overhangs indicate that the visible area extends outside the layout box or inline object, while negative values mean there is whitespace inside. The returned values are unaffected by rendering transforms or pixel snapping. Additionally, they may not exactly match final target's pixel bounds after applying grid fitting and hinting.

Properties

Bottom

Gets the distance from the bottom-most visible DIP to its bottom alignment edge.

Declaration

public float Bottom { get; }

Property Value

Type	Description
float

Left

Gets the distance from the left-most visible DIP to its left alignment edge.

Declaration

public float Left { get; }

Property Value

Type	Description
float

Right

Gets the distance from the right-most visible DIP to its right alignment edge.

Declaration

public float Right { get; }

Property Value

Type	Description
float

Top

Gets the distance from the top-most visible DIP to its top alignment edge.

Declaration

public float Top { get; }

Property Value

Type	Description
float

Methods

Equals(DWriteOverhangMetrics)

Determines whether the specified object is equal to the current object.

Declaration

public bool Equals(DWriteOverhangMetrics other)

Parameters

Type	Name	Description
DWriteOverhangMetrics	other	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

ValueType.Equals(object)

GetHashCode()

Returns the hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A 32-bit signed integer that is the hash code for this instance.

Overrides

ValueType.GetHashCode()

Operators

operator ==(DWriteOverhangMetrics, DWriteOverhangMetrics)

Compares two DWriteOverhangMetrics objects. The result specifies whether the values of the two objects are equal.

Declaration

public static bool operator ==(DWriteOverhangMetrics left, DWriteOverhangMetrics right)

Parameters

Type	Name	Description
DWriteOverhangMetrics	left	The left DWriteOverhangMetrics to compare.
DWriteOverhangMetrics	right	The right DWriteOverhangMetrics to compare.

Returns

Type	Description
bool	true if the values of left and right are equal; otherwise, false.

operator !=(DWriteOverhangMetrics, DWriteOverhangMetrics)

Compares two DWriteOverhangMetrics objects. The result specifies whether the values of the two objects are unequal.

Declaration

public static bool operator !=(DWriteOverhangMetrics left, DWriteOverhangMetrics right)

Parameters

Type	Name	Description
DWriteOverhangMetrics	left	The left DWriteOverhangMetrics to compare.
DWriteOverhangMetrics	right	The right DWriteOverhangMetrics to compare.

Returns

Type	Description
bool	true if the values of left and right differ; otherwise, false.

Implements

IEquatable<T>