UnicodeLineBreak Struct

Namespace: Meziantou.Framework
Assembly: Meziantou.Framework.Unicode.dll
Package: Meziantou.Framework.Unicode 2.0.15
Source: UnicodeLineBreak.cs
Available in package assets: net10.0net11.0

Represents a position where a line can or must break.

public readonly struct UnicodeLineBreak : IEquatable<UnicodeLineBreak>

Implements

IEquatable<UnicodeLineBreak>

Properties

Name	Description
Index	Gets the index of the first UTF-16 code unit of the next line: the line breaks before it.
IsMandatory	Gets a value indicating whether the line must break: after a line feed, a paragraph separator and the like, and at the end of the text.

Index

UnicodeLineBreak.cs

Gets the index of the first UTF-16 code unit of the next line: the line breaks before it.

public int Index { get; }

Property value

int

IsMandatory

UnicodeLineBreak.cs

Gets a value indicating whether the line must break: after a line feed, a paragraph separator and the like, and at the end of the text.

public bool IsMandatory { get; }

Property value

bool

Methods

Name	Description
Equals(UnicodeLineBreak)	Indicates whether the current object is equal to another object of the same type.
Equals(object?)	Indicates whether this instance and a specified object are equal.
GetHashCode()	Returns the hash code for this instance.

Equals overloads

Equals(UnicodeLineBreak)

UnicodeLineBreak.cs

Indicates whether the current object is equal to another object of the same type.

public bool Equals(UnicodeLineBreak other)

Parameters

other UnicodeLineBreak: An object to compare with this object.

Returns

bool true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

UnicodeLineBreak.cs

Indicates whether this instance and a specified object are equal.

public override bool Equals(object? obj)

Parameters

obj object?: The object to compare with the current instance.

Returns

bool true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

UnicodeLineBreak.cs

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int A 32-bit signed integer that is the hash code for this instance.

Operators

Name	Description
operator ==(UnicodeLineBreak, UnicodeLineBreak)	Determines whether two values are equal.
operator !=(UnicodeLineBreak, UnicodeLineBreak)	Determines whether two values are different.

operator ==(UnicodeLineBreak, UnicodeLineBreak)

UnicodeLineBreak.cs

Determines whether two values are equal.

public static bool operator ==(UnicodeLineBreak left, UnicodeLineBreak right)

Parameters

left UnicodeLineBreak: The first value.
right UnicodeLineBreak: The second value.

Returns

bool true when the values are equal.

operator !=(UnicodeLineBreak, UnicodeLineBreak)

UnicodeLineBreak.cs

Determines whether two values are different.

public static bool operator !=(UnicodeLineBreak left, UnicodeLineBreak right)

Parameters

left UnicodeLineBreak: The first value.
right UnicodeLineBreak: The second value.

Returns

bool true when the values are different.