Class RichTextCharacterFormat

Namespace

RichEdit.Maui

Assembly

RichEdit.Maui.dll

Defines immutable character formatting.

public sealed record RichTextCharacterFormat : IEquatable<RichTextCharacterFormat>

Inheritance

object

RichTextCharacterFormat

Implements

IEquatable<RichTextCharacterFormat>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

RichTextCharacterFormat()

public RichTextCharacterFormat()

Properties

AllCaps

Gets whether uppercase presentation is requested.

public bool AllCaps { get; init; }

Property Value

bool

BackgroundColor

Gets the solid text background color, or null for no highlight.

public Color? BackgroundColor { get; init; }

Property Value

Color

BaselineOffset

Gets the additional baseline offset in points.

public double BaselineOffset { get; init; }

Property Value

double

Bold

Gets whether FontWeight represents a bold weight.

public bool Bold { get; }

Property Value

bool

CharacterSpacing

Gets additional character spacing in points.

public double CharacterSpacing { get; init; }

Property Value

double

Default

Gets an inherited, otherwise neutral character format.

public static RichTextCharacterFormat Default { get; }

Property Value

RichTextCharacterFormat

Direction

Gets explicit character direction.

public RichTextDirection Direction { get; init; }

Property Value

RichTextDirection

FontFamily

Gets the authored font family, or null to inherit.

public string? FontFamily { get; init; }

Property Value

string

FontSize

Gets the authored font size in points, or null to inherit.

public double? FontSize { get; init; }

Property Value

double?

FontWeight

Gets the numeric font weight from 1 through 1000.

public int FontWeight { get; init; }

Property Value

int

ForegroundColor

Gets the authored foreground color, or null to inherit.

public Color? ForegroundColor { get; init; }

Property Value

Color

Hidden

Gets whether text is hidden.

public bool Hidden { get; init; }

Property Value

bool

HorizontalScale

Gets the horizontal glyph scale, where 1 is unchanged.

public double HorizontalScale { get; init; }

Property Value

double

Italic

Gets whether italic styling is enabled.

public bool Italic { get; init; }

Property Value

bool

Kerning

Gets the kerning preference.

public RichTextFeatureMode Kerning { get; init; }

Property Value

RichTextFeatureMode

LanguageTag

Gets the BCP 47 language tag, or null when unspecified.

public string? LanguageTag { get; init; }

Property Value

string

Ligatures

Gets the ligature preference.

public RichTextFeatureMode Ligatures { get; init; }

Property Value

RichTextFeatureMode

Outline

Gets whether the outline effect is requested.

public bool Outline { get; init; }

Property Value

bool

Script

Gets the superscript or subscript state.

public RichTextScript Script { get; init; }

Property Value

RichTextScript

Shading

Gets the RTF shading amount from 0 through 10000.

public int Shading { get; init; }

Property Value

int

ShadingBackgroundColor

Gets the RTF shading background color.

public Color? ShadingBackgroundColor { get; init; }

Property Value

Color

ShadingForegroundColor

Gets the RTF shading foreground color.

public Color? ShadingForegroundColor { get; init; }

Property Value

Color

Shadow

Gets whether the shadow effect is requested.

public bool Shadow { get; init; }

Property Value

bool

SmallCaps

Gets whether small-cap glyphs are requested.

public bool SmallCaps { get; init; }

Property Value

bool

Strikethrough

Gets the strikethrough style.

public RichTextStrikethroughStyle Strikethrough { get; init; }

Property Value

RichTextStrikethroughStyle

StrikethroughColor

Gets the strikethrough color, or null for the text color.

public Color? StrikethroughColor { get; init; }

Property Value

Color

StyleName

Gets the named character style, or null when unspecified.

public string? StyleName { get; init; }

Property Value

string

Underline

Gets the underline style.

public RichTextUnderlineStyle Underline { get; init; }

Property Value

RichTextUnderlineStyle

UnderlineColor

Gets the underline color, or null for the text color.

public Color? UnderlineColor { get; init; }

Property Value

Color

Methods

Equals(RichTextCharacterFormat?)

public bool Equals(RichTextCharacterFormat? other)

Parameters

other RichTextCharacterFormat

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(RichTextCharacterFormat?, RichTextCharacterFormat?)

public static bool operator ==(RichTextCharacterFormat? left, RichTextCharacterFormat? right)

Parameters

left RichTextCharacterFormat

right RichTextCharacterFormat

Returns

bool

operator !=(RichTextCharacterFormat?, RichTextCharacterFormat?)

public static bool operator !=(RichTextCharacterFormat? left, RichTextCharacterFormat? right)

Parameters

left RichTextCharacterFormat

right RichTextCharacterFormat

Returns

bool