FormatLine Method

Formats a text line.

Definition

Namespace: Avalonia.Media.TextFormatting
Assembly: Avalonia.Base (in Avalonia.Base.dll)

C#

public abstract TextLine? FormatLine(
	ITextSource textSource,
	int firstTextSourceIndex,
	double paragraphWidth,
	TextParagraphProperties paragraphProperties,
	TextLineBreak? previousLineBreak = null
)

VB

Public MustOverride Function FormatLine ( 
	textSource As ITextSource,
	firstTextSourceIndex As Integer,
	paragraphWidth As Double,
	paragraphProperties As TextParagraphProperties,
	Optional previousLineBreak As TextLineBreak = Nothing
) As TextLine

F#

abstract FormatLine : 
        textSource : ITextSource * 
        firstTextSourceIndex : int * 
        paragraphWidth : float * 
        paragraphProperties : TextParagraphProperties * 
        ?previousLineBreak : TextLineBreak 
(* Defaults:
        let _previousLineBreak = defaultArg previousLineBreak null
*)
-> TextLine 

View Source

Parameters

  ITextSource

The text source.

  Int32

The first character index to start the text line from.

  Double

A Double value that specifies the width of the paragraph that the line fills.

  TextParagraphProperties

A TextParagraphProperties value that represents paragraph properties, such as TextWrapping, TextAlignment, or TextStyle.

  TextLineBreak  (Optional)

A TextLineBreak value that specifies the text formatter state, in terms of where the previous line in the paragraph was broken by the text formatting process.

Return Value

TextLine
The formatted line.

See Also

Reference

TextFormatter Class
Avalonia.Media.TextFormatting Namespace