New to Telerik UI for WinForms? Start a free 30-day trial

Stores the measured dimensions, baseline, and inline-box boundaries for one laid-out paragraph line. Line height and baseline reflect the paragraph's configured line-spacing mode.

Definition

Namespace:Telerik.WinForms.Documents.Layout

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

C#
public class ParagraphLineInfo

Inheritance: objectParagraphLineInfo

Constructors

Creates line metrics for a paragraph and initializes the last-word index to indicate that no word has been recorded.

C#
public ParagraphLineInfo(Paragraph paragraph)
Parameters:paragraphParagraph

The paragraph whose line is being measured.

Copies the line metrics and layout references from another line. The paragraph and first inline box references are shared with the source.

C#
public ParagraphLineInfo(ParagraphLineInfo paragraphLineInfo)
Parameters:paragraphLineInfoParagraphLineInfo

The line state to copy.

Properties

Gets the line's baseline offset, adjusted for the paragraph's exact or minimum line-spacing mode.

C#
public float BaselineOffset { get; }

Gets or sets the first inline box associated with this line, used as its layout and navigation anchor.

C#
public InlineLayoutBox FirstInlineBox { get; set; }

Gets or sets the additional vertical spacing inserted before this line when layout moves it around a floating block.

C#
public float FloatingBoxSpacingBefore { get; }

Gets or sets whether the line contains an eligible overflow character that extends beyond its available width. The layout uses this flag to prevent another character from overflowing on the same line.

C#
public bool HasOverflowCharacter { get; }

Gets the calculated line height after applying the paragraph's line-spacing mode.

C#
public float Height { get; }

Gets or sets this line's position in the paragraph's laid-out line sequence.

C#
public int IndexInParagraph { get; }

Gets or sets whether a floating block divided this line into separate horizontal segments.

C#
public bool IsLineSplitByFloatingBox { get; }

Gets or sets the inline-box index of the last word-bearing box on this line, or -1 when none was recorded.

C#
public int LastWordIndex { get; }

Gets the paragraph that owns this line.

C#
public Paragraph Paragraph { get; }
C#
public float TralingExtraSpaceWidth { get; }

Gets or sets the horizontal extent of the line within the width available to it during layout. Floating blocks can reduce that available width.

C#
public float Width { get; }

Gets or sets the number of word-bearing inline boxes counted for this line. Formatting symbols and an overflow character are not included.

C#
public int WordCount { get; }

Methods

Updates the line's greatest measured baseline offset and, when requested, includes the value in automatic line-spacing calculations.

C#
public void UpdateBaselineOffset(float value, bool affectsLineSpacing)
Parameters:valuefloat

The measured offset from a box's top to its baseline.

affectsLineSpacingbool

true to include this offset when calculating automatic line spacing.

Updates the line's greatest measured descent and, when requested, includes the value in automatic line-spacing calculations.

C#
public void UpdateDescent(float value, bool affectsLineSpacing)
Parameters:valuefloat

The measured distance from a box's baseline to its bottom.

affectsLineSpacingbool

true to include this descent when calculating automatic line spacing.