FontWeight.Compare(FontWeight, FontWeight) Method

Definition

Namespace:

System.Windows

Assembly:

PresentationCore.dll

Compares two instances of FontWeight.

public:
 static int Compare(System::Windows::FontWeight left, System::Windows::FontWeight right);

public static int Compare (System.Windows.FontWeight left, System.Windows.FontWeight right);

static member Compare : System.Windows.FontWeight * System.Windows.FontWeight -> int

Public Shared Function Compare (left As FontWeight, right As FontWeight) As Integer

Parameters

left

FontWeight

The first FontWeight object to compare.

right

FontWeight

The second FontWeight object to compare.

Returns

Int32

An Int32 value that indicates the relationship between the two instances of FontWeight. When the return value is less than zero, left is less than right. When this value is zero, it indicates that both operands are equal. When the value is greater than zero, it indicates that left is greater than right.

Examples

In the following code example, the Compare method is used to evaluate two FontWeight objects.

// Return the typefaces for the selected font family name and font values.
Typeface typeface1 = new Typeface(new FontFamily("Arial"), FontStyles.Normal, FontWeights.Normal, FontStretches.Normal);
Typeface typeface2 = new Typeface(new FontFamily("Arial"), FontStyles.Normal, FontWeights.UltraBold, FontStretches.Normal);

if (FontWeight.Compare(typeface1.Weight, typeface2.Weight) < 0)
{
    // Code execution follows this path because
    // the FontWeight of typeface1 (Normal) is less than of typeface2 (UltraBold).
}

' Return the typefaces for the selected font family name and font values.
Dim typeface1 As New Typeface(New FontFamily("Arial"), FontStyles.Normal, FontWeights.Normal, FontStretches.Normal)
Dim typeface2 As New Typeface(New FontFamily("Arial"), FontStyles.Normal, FontWeights.UltraBold, FontStretches.Normal)

If FontWeight.Compare(typeface1.Weight, typeface2.Weight) < 0 Then
    ' Code execution follows this path because
    ' the FontWeight of typeface1 (Normal) is less than of typeface2 (UltraBold).
End If

Remarks

Lighter font weights are lesser than heavier font weights. For example, a "Light" or "Normal" font weight is lesser than an "UltraBold" font weight.