Class TextRunFormattingChange

Namespace

ComOfficeKit.Model

Assembly

ComOfficeKit.dll

A change to a run's formatting for ReplacingFormatting(int, string, int, int, TextRunFormattingChange, TableCellAddress?): each part set by its value, cleared by its Clear… flag (the run then takes its placeholder's or its theme's), or, with neither, left. Bold, italic, underline and strikethrough are set on or off, or left.

public sealed record TextRunFormattingChange : IEquatable<TextRunFormattingChange>

Inheritance

object

TextRunFormattingChange

Implements

IEquatable<TextRunFormattingChange>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

TextRunFormattingChange()

public TextRunFormattingChange()

Properties

BaselinePercent

The raise (superscript, above 0) or drop (subscript, below 0) to set, in percent of the size.

public double? BaselinePercent { get; init; }

Property Value

double?

Bold

Bold on or off.

public bool? Bold { get; init; }

Property Value

bool?

ClearBaselinePercent

True to clear the raise or drop: the run sits on the line.

public bool ClearBaselinePercent { get; init; }

Property Value

bool

ClearColorHex

True to clear the colour.

public bool ClearColorHex { get; init; }

Property Value

bool

ClearFontFamily

True to clear the font.

public bool ClearFontFamily { get; init; }

Property Value

bool

ClearFontSizePt

True to clear the size.

public bool ClearFontSizePt { get; init; }

Property Value

bool

ClearHighlightHex

True to clear the highlight.

public bool ClearHighlightHex { get; init; }

Property Value

bool

ColorHex

The colour to set, RRGGBB.

public string? ColorHex { get; init; }

Property Value

string

FontFamily

The font to set, by its name.

public string? FontFamily { get; init; }

Property Value

string

FontSizePt

The size to set, from 1 to 4,000 pt.

public double? FontSizePt { get; init; }

Property Value

double?

HighlightHex

The highlight to set, RRGGBB.

public string? HighlightHex { get; init; }

Property Value

string

Italic

Italic on or off.

public bool? Italic { get; init; }

Property Value

bool?

Strikethrough

Strikethrough on or off.

public bool? Strikethrough { get; init; }

Property Value

bool?

Underline

Underline on or off.

public bool? Underline { get; init; }

Property Value

bool?

Methods

Equals(TextRunFormattingChange?)

public bool Equals(TextRunFormattingChange? other)

Parameters

other TextRunFormattingChange

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 ==(TextRunFormattingChange?, TextRunFormattingChange?)

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

Parameters

left TextRunFormattingChange

right TextRunFormattingChange

Returns

bool

operator !=(TextRunFormattingChange?, TextRunFormattingChange?)

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

Parameters

left TextRunFormattingChange

right TextRunFormattingChange

Returns

bool