Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeRichTextLine

OfficeIMO.Drawing

Namespace
OfficeIMO.Drawing
Assembly
OfficeIMO.Core
Source revision
ba882f6b0d07 with working tree changes
Modifiers
sealed

Describes one measured line of rich text.

Inheritance

  • object
  • OfficeRichTextLine

Usage

Explore 2 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Accepted by parameters 1

Constructors

OfficeRichTextLine 2 overloads
public OfficeRichTextLine(IReadOnlyList<OfficeRichTextSegment> segments) #

Creates a line with renderer-resolved height and no horizontal offset.

Parameters

segments System.Collections.Generic.IReadOnlyList<OfficeIMO.Drawing.OfficeRichTextSegment> required
public OfficeRichTextLine(IReadOnlyList<OfficeRichTextSegment> segments, double lineHeight = 0, double offsetX = 0) #

Creates a measured rich text line.

Parameters

segments System.Collections.Generic.IReadOnlyList<OfficeIMO.Drawing.OfficeRichTextSegment> required
Measured segments on the line.
lineHeight double = 0 optional
Optional resolved height for this line. A value of zero lets block renderers fall back to the containing layout line height.
offsetX double = 0 optional
Additional x offset relative to the text frame. Negative offsets retain aligned text that extends beyond its left edge.

Properties

public IReadOnlyList<OfficeRichTextSegment> Segments { get; } #

Gets measured rich text segments on the line.

public double Width { get; } #

Gets the total measured line width.

public double FontSize { get; } #

Gets the largest font size used by this line.

public double LineHeight { get; } #

Gets the resolved line height for this line, or zero when the containing block line height should be used.

public double OffsetX { get; } #

Gets the additional x offset relative to the text frame, including negative offsets for aligned overflow.