ConsoleTableBuilderExtensions

Full name Microsoft.VisualBasic.ApplicationServices.Terminal.TablePrinter.ConsoleTableBuilderExtensions Assembly Microsoft.VisualBasic.Runtime Members 24

01 Syntax

Microsoft.VisualBasic.ApplicationServices.Terminal.TablePrinter.ConsoleTableBuilderExtensions

02 Methods

Name	Overloads	Summary
WithTitle	3	Add title row on top of table
WithTextAlignment	1	Text alignment definition
Export	1	export the table print content string
ExportAndWrite	1	export the table content as string and do console write
ExportAndWriteLine	1	console write line of the table data
RealLength	1	Get the real width for do console print of a string
AddColumn	1
WithColumn	1
AddRow	1
WithMetadataRow	1
WithPaddingLeft	1
WithPaddingRight	1
WithFormatter	1
WithColumnFormatter	1
WithHeaderTextAlignment	1
WithMinLength	1
TrimColumn	1
WithFormat	1
WithCharMapDefinition	3
WithHeaderCharMapDefinition	1

03 Members

method WithTitle #

WithTitle(ConsoleTableBuilder, String, TextAligntment)

Add title row on top of table

Parameters

Name	Type	Description
`builder`	ConsoleTableBuilder	-
`title`	`String`	-

method WithTitle overload 2 #

WithTitle(ConsoleTableBuilder, String, ConsoleColor, TextAligntment)

Add title row on top of table

Parameters

Name	Type	Description
`builder`	ConsoleTableBuilder	-
`title`	`String`	-
`foregroundColor`	`ConsoleColor`	text color

method WithTitle overload 3 #

WithTitle(ConsoleTableBuilder, String, ConsoleColor, ConsoleColor, TextAligntment)

Add title row on top of table

Parameters

Name	Type	Description
`builder`	ConsoleTableBuilder	-
`title`	`String`	-
`foregroundColor`	`ConsoleColor`	text color
`backgroundColor`	`ConsoleColor`	background color

method WithTextAlignment #

WithTextAlignment(ConsoleTableBuilder, Dictionary(Of Int32, TextAligntment))

Text alignment definition

Parameters

Name	Type	Description
`builder`	ConsoleTableBuilder	-
`alignmentData`	`Dictionary(Of Int32, TextAligntment)`	-

method Export #

Export(ConsoleTableBuilder)

export the table print content string

Parameters

Name	Type	Description
`builder`	ConsoleTableBuilder	-

method ExportAndWrite #

ExportAndWrite(ConsoleTableBuilder, TableAligntment)

export the table content as string and do console write

Parameters

Name	Type	Description
`builder`	ConsoleTableBuilder	-
`alignment`	`TableAligntment`	-

method ExportAndWriteLine #

ExportAndWriteLine(ConsoleTableBuilder, TableAligntment)

console write line of the table data

Parameters

Name	Type	Description
`builder`	ConsoleTableBuilder	-
`alignment`	`TableAligntment`	-

method RealLength #

RealLength(String, Boolean)

Get the real width for do console print of a string

Remarks

1 char width for ascii character, and 2 char width for chinese character.

Parameters

Name	Type	Description
`value`	`String`	-
`withUtf8Characters`	`Boolean`	-

method AddColumn #

AddColumn(ConsoleTableBuilder, String)

method WithColumn #

WithColumn(ConsoleTableBuilder, List(Of String))

method AddRow #

AddRow(ConsoleTableBuilder, Object())

method WithMetadataRow #

WithMetadataRow(ConsoleTableBuilder, MetaRowPositions, Func(Of ConsoleTableBuilder, String))

method WithPaddingLeft #

WithPaddingLeft(ConsoleTableBuilder, String)

method WithPaddingRight #

WithPaddingRight(ConsoleTableBuilder, String)

method WithFormatter #

WithFormatter(ConsoleTableBuilder, Int32, Func(Of String, String))

method WithColumnFormatter #

WithColumnFormatter(ConsoleTableBuilder, Int32, Func(Of String, String))

method WithHeaderTextAlignment #

WithHeaderTextAlignment(ConsoleTableBuilder, Dictionary(Of Int32, TextAligntment))

method WithMinLength #

WithMinLength(ConsoleTableBuilder, Dictionary(Of Int32, Int32))

method TrimColumn #

TrimColumn(ConsoleTableBuilder, Boolean)

method WithFormat #

WithFormat(ConsoleTableBuilder, ConsoleTableBuilderFormat)

method WithCharMapDefinition overload 3 #

WithCharMapDefinition(ConsoleTableBuilder)

method WithCharMapDefinition overload 2 #

WithCharMapDefinition(ConsoleTableBuilder, Dictionary(Of CharMapPositions, Char))

method WithCharMapDefinition #

WithCharMapDefinition(ConsoleTableBuilder, Dictionary(Of CharMapPositions, Char), Dictionary(Of HeaderCharMapPositions, Char))

method WithHeaderCharMapDefinition #

WithHeaderCharMapDefinition(ConsoleTableBuilder, Dictionary(Of HeaderCharMapPositions, Char))