Avalonia API Reference
Text
Formats a text line.
Definition
Namespace: Avalonia.Media.TextFormatting
Assembly: Avalonia.Base (in Avalonia.Base.dll) Version: 11.3.999
The formatted line.
Assembly: Avalonia.Base (in Avalonia.Base.dll) Version: 11.3.999
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 TextLineF#
abstract FormatLine :
textSource : ITextSource *
firstTextSourceIndex : int *
paragraphWidth : float *
paragraphProperties : TextParagraphProperties *
?previousLineBreak : TextLineBreak
(* Defaults:
let _previousLineBreak = defaultArg previousLineBreak null
*)
-> TextLine Parameters
- textSource ITextSource
- The text source.
- firstTextSourceIndex Int32
- The first character index to start the text line from.
- paragraphWidth Double
- A Double value that specifies the width of the paragraph that the line fills.
- paragraphProperties TextParagraphProperties
- A TextParagraphProperties value that represents paragraph properties, such as TextWrapping, TextAlignment, or TextStyle.
- previousLineBreak 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
TextLineThe formatted line.