FontWeight.Compare Method (FontWeight, FontWeight)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Compares two instances of FontWeight.

Namespace:   System.Windows
Assembly:  PresentationCore (in PresentationCore.dll)

public static int Compare(
	FontWeight left,
	FontWeight right
)

Parameters

left
Type: System.Windows.FontWeight

The first FontWeight object to compare.

right
Type: System.Windows.FontWeight

The second FontWeight object to compare.

Return Value

Type: System.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.

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

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).
}

.NET Framework
Available since 3.0
Return to top
Show: