Skip to content
ConsoleMonster

API Reference

Struct

RichSegment

Edit on GitHub
Namespace ConsoleMonster.Text
Assembly ConsoleMonster
Source RichSegment.cs:12
Base ValueType
Implements
IEquatable<RichSegment>
Modifiers sealed

One span of RichText: literal text or markup, with a style.

Inheritance

  • ValueType
  • RichSegment

Usage

Explore 3 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Accepted by parameters 2

Constructors

public RichSegment(String text, RichStyle style = default, Boolean isMarkup = false) #
RichSegment.cs:12

Creates a segment.

Parameters

text System.String requiredposition: 0
The text.
style ConsoleMonster.Styling.RichStyle = default optionalposition: 1
The style (for markup, a style around the whole markup).
isMarkup System.Boolean = false optionalposition: 2
Whether the text is markup; literal text is never interpreted.

Methods

Equals 2 overloads
public Boolean Equals(RichSegment other) #
RichSegment.cs:27
Returns: Boolean

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

Parameters

other ConsoleMonster.Text.RichSegment requiredposition: 0
An object to compare with this object.

Returns

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

public override Boolean Equals(Object? obj) #
RichSegment.cs:30
Returns: Boolean

Indicates whether this instance and a specified object are equal.

Parameters

obj System.Object? requiredposition: 0
The object to compare with the current instance.

Returns

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

public override Int32 GetHashCode() #
RichSegment.cs:33
Returns: Int32

Returns the hash code for this instance.

Returns

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

public override String ToString() #
RichSegment.cs:36
Returns: String

Returns the fully qualified type name of this instance.

Returns

The fully qualified type name.

Properties

public String Text { get; } #
RichSegment.cs:18

The text.

public RichStyle Style { get; } #
RichSegment.cs:21

The style.

public Boolean IsMarkup { get; } #
RichSegment.cs:24

Whether RichSegment.Text is markup.