Skip to main content

LineBreak Struct

Definition​

Assembly:Avalonia.Base
Package:Avalonia

Information about a potential line break position

public struct LineBreak

Inheritance: ValueType -> LineBreak

Implements: IEquatable<LineBreak>

Constructors​

NameDescription
LineBreakConstructor

LineBreak Constructor​

Constructor

public LineBreak(int positionMeasure, int positionWrap, bool required)

Parameters​

positionMeasure int

The code point index to measure to

positionWrap int

The code point index to actually break the line at

required bool

True if this is a required line break; otherwise false

Methods​

NameDescription
Equals (2 overloads)No summary available.
GetHashCodeNo summary available.
ToStringNo summary available.

Equals overloads​

Equals Method​

public bool Equals(Avalonia.Media.TextFormatting.Unicode.LineBreak other)
Parameters​

other Avalonia.Media.TextFormatting.Unicode.LineBreak

Returns​

bool

Equals Method​

public bool Equals(object obj)
Parameters​

obj object

Returns​

bool

GetHashCode Method​

public int GetHashCode()

Returns​

int

ToString Method​

public string ToString()

Returns​

string

Properties​

NameDescription
PositionMeasureThe break position, before any trailing whitespace
PositionWrapThe break position, after any trailing whitespace
RequiredTrue if there should be a forced line break here

PositionMeasure Property​

The break position, before any trailing whitespace

public int PositionMeasure { get; set; }

Remarks​

This doesn't include trailing whitespace

PositionWrap Property​

The break position, after any trailing whitespace

public int PositionWrap { get; set; }

Remarks​

This includes trailing whitespace

Required Property​

True if there should be a forced line break here

public bool Required { get; set; }