ListInfo Struct

Defines list information returned when trying to parse a list item with ListItemParser.TryParse

public struct ListInfo

Constructors

NameDescription
ListInfo(char)Initializes a new instance of the ListInfo struct.
ListInfo(char, string, char, string)Initializes a new instance of the ListInfo struct.

ListInfo overloads

ListInfo(char)

ListInfo.cs

Initializes a new instance of the ListInfo struct.

public ListInfo(char bulletType)
Parameters
bulletType char
Type of the bullet (e.g: '1', 'a', 'A', 'i', 'I').

ListInfo(char, string, char, string)

ListInfo.cs

Initializes a new instance of the ListInfo struct.

public ListInfo(char bulletType, string orderedStart, char orderedDelimiter, string defaultOrderedStart)
Parameters
bulletType char
Type of the bullet (e.g: '1', 'a', 'A', 'i', 'I')
orderedStart string
The string used as a starting sequence for an ordered list.
orderedDelimiter char
The ordered delimiter found when parsing this list (e.g: the character `)` after `1)`)
defaultOrderedStart string
The default string used as a starting sequence for the ordered list (e.g: '1' for an numbered ordered list)

Properties

NameDescription
BulletTypeGets or sets the type of the bullet (e.g: '1', 'a', 'A', 'i', 'I').
DefaultOrderedStartGets or sets default string used as a starting sequence for the ordered list (e.g: '1' for an numbered ordered list)
OrderedDelimiterGets or sets the ordered delimiter found when parsing this list (e.g: the character `)` after `1)`)
OrderedStartGets or sets the string used as a starting sequence for an ordered list
SourceBulletGets or sets the source bullet.

BulletType

ListInfo.cs

Gets or sets the type of the bullet (e.g: '1', 'a', 'A', 'i', 'I').

public char BulletType { readonly get; set; }

Property value

char

DefaultOrderedStart

ListInfo.cs

Gets or sets default string used as a starting sequence for the ordered list (e.g: '1' for an numbered ordered list)

public string? DefaultOrderedStart { readonly get; set; }

Property value

string?

OrderedDelimiter

ListInfo.cs

Gets or sets the ordered delimiter found when parsing this list (e.g: the character `)` after `1)`)

public char OrderedDelimiter { readonly get; set; }

Property value

char

OrderedStart

ListInfo.cs

Gets or sets the string used as a starting sequence for an ordered list

public string? OrderedStart { readonly get; set; }

Property value

string?

SourceBullet

ListInfo.cs

Gets or sets the source bullet.

public StringSlice SourceBullet { readonly get; set; }

Property value

StringSlice