TextConstants TextConstants TextConstants TextConstants Class

Definition

Defines a set of constants that are used with various methods in the Windows.UI.Text namespace.

public : static class TextConstants
public static class TextConstants
Public Static Class TextConstants
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

AutoColor AutoColor AutoColor AutoColor

Gets the default color.

public : static Color AutoColor { get; }
public static Color AutoColor { get; }
Public Static ReadOnly Property AutoColor As Color
var color = Windows.UI.Text.TextConstants.autoColor;
Value
Color Color Color Color

The default color.

Remarks

When a color argument has this value, the appropriate system default color is used.

MaxUnitCount MaxUnitCount MaxUnitCount MaxUnitCount

Gets the maximum unit count.

public : static int MaxUnitCount { get; }
public static int MaxUnitCount { get; }
Public Static ReadOnly Property MaxUnitCount As int
var int = Windows.UI.Text.TextConstants.maxUnitCount;
Value
int int int int

The maximum unit count.

Remarks

This value is used as a large positive count for the ITextRange.Move, ITextRange.MoveEnd, and ITextRange.MoveStart methods.

MinUnitCount MinUnitCount MinUnitCount MinUnitCount

Gets the minimum unit count.

public : static int MinUnitCount { get; }
public static int MinUnitCount { get; }
Public Static ReadOnly Property MinUnitCount As int
var int = Windows.UI.Text.TextConstants.minUnitCount;
Value
int int int int

The minimum unit count.

Remarks

This value is used as a large negative count for the ITextRange.Move, ITextRange.MoveEnd, and ITextRange.MoveStart methods.

UndefinedColor UndefinedColor UndefinedColor UndefinedColor

Gets the undefined color value.

public : static Color UndefinedColor { get; }
public static Color UndefinedColor { get; }
Public Static ReadOnly Property UndefinedColor As Color
var color = Windows.UI.Text.TextConstants.undefinedColor;
Value
Color Color Color Color

The undefined color.

Remarks

When retrieving a character-format color property, this value indicates that a range has at least two text runs with different values of that character-format color property. When setting a character-format color property, this value indicates that the property is undefined; that is, it will not be applied if the ITextCharacterFormat is applied to a range. This value is used with properties such as ITextCharacterFormat.BackgroundColor.

UndefinedFloatValue UndefinedFloatValue UndefinedFloatValue UndefinedFloatValue

Gets the undefined floating-point value.

public : static float UndefinedFloatValue { get; }
public static float UndefinedFloatValue { get; }
Public Static ReadOnly Property UndefinedFloatValue As float
var float = Windows.UI.Text.TextConstants.undefinedFloatValue;
Value
float float float float

The undefined floating-point value.

Remarks

When retrieving a floating-point format property, this value indicates that a range has at least two text runs with different values of that property. When setting such a property, this value indicates that the property is undefined; that is, it will not be applied if the ITextCharacterFormat or ITextParagraphFormat is applied to a range. This value is used with properties such as ITextCharacterFormat.Size.

UndefinedFontStretch UndefinedFontStretch UndefinedFontStretch UndefinedFontStretch

Gets the undefined font stretch value.

public : static FontStretch UndefinedFontStretch { get; }
public static FontStretch UndefinedFontStretch { get; }
Public Static ReadOnly Property UndefinedFontStretch As FontStretch
var fontStretch = Windows.UI.Text.TextConstants.undefinedFontStretch;
Value
FontStretch FontStretch FontStretch FontStretch

The undefined font stretch value.

Remarks

When retrieving the font-stretch property, this value indicates that a range has at least two text runs with different values of that property. When setting a font-stretch property, this value indicates that the property is undefined; that is, it will not be applied if the ITextCharacterFormat is applied to a range. This value is used with the ITextCharacterFormat.FontStretch property.

UndefinedFontStyle UndefinedFontStyle UndefinedFontStyle UndefinedFontStyle

Gets the undefined font style.

public : static FontStyle UndefinedFontStyle { get; }
public static FontStyle UndefinedFontStyle { get; }
Public Static ReadOnly Property UndefinedFontStyle As FontStyle
var fontStyle = Windows.UI.Text.TextConstants.undefinedFontStyle;
Value
FontStyle FontStyle FontStyle FontStyle

The undefined font style.

Remarks

When retrieving the font-style property, this value indicates that a range has at least two text runs with different values of that property. When setting the font-style property, this value indicates that the property is undefined; that is, it will not be applied if the ITextCharacterFormat is applied to a range. This value is used with the ITextCharacterFormat.FontStyle property.

UndefinedInt32Value UndefinedInt32Value UndefinedInt32Value UndefinedInt32Value

Gets the undefined 32-bit integer value.

public : static int UndefinedInt32Value { get; }
public static int UndefinedInt32Value { get; }
Public Static ReadOnly Property UndefinedInt32Value As int
var int = Windows.UI.Text.TextConstants.undefinedInt32Value;
Value
int int int int

The undefined 32-bit integer value.

Remarks

When retrieving an integer format property, this value indicates that a range has at least two text runs with different values of that property. When setting such a property, this value indicates that the property is undefined; that is, it will not be applied if the ITextCharacterFormat or ITextParagraphFormat is applied to a range. This value is used with properties such as ITextCharacterFormat.ListStart.