Struct DWriteInlineObjectMetrics

Properties describing the geometric measurement of an application-defined inline object.

Implements

IEquatable<DWriteInlineObjectMetrics>

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 DWriteInlineObjectMetrics : IEquatable<DWriteInlineObjectMetrics>

Properties

Baseline

Gets the distance from the top of the object to the baseline where it is lined up with the adjacent text. If the baseline is at the bottom, baseline simply equals height.

Declaration

public float Baseline { get; }

Property Value

Type	Description
float

Height

Gets the height of the inline object as measured from top to bottom.

Declaration

public float Height { get; }

Property Value

Type	Description
float

SupportsSideways

Gets a value indicating whether the object is to be placed upright or alongside the text baseline for vertical text.

Declaration

public bool SupportsSideways { get; }

Property Value

Type	Description
bool

Width

Gets the width of the inline object.

Declaration

public float Width { get; }

Property Value

Type	Description
float

Methods

Equals(DWriteInlineObjectMetrics)

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

Declaration

public bool Equals(DWriteInlineObjectMetrics other)

Parameters

Type	Name	Description
DWriteInlineObjectMetrics	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 ==(DWriteInlineObjectMetrics, DWriteInlineObjectMetrics)

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

Declaration

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

Parameters

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

Returns

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

operator !=(DWriteInlineObjectMetrics, DWriteInlineObjectMetrics)

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

Declaration

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

Parameters

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

Returns

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

Implements

IEquatable<T>