Cmdlet

Add-OfficeMarkdownTable

Aliases: MarkdownTable

Module: PSWriteOffice
Aliases: MarkdownTable
Inputs: OfficeIMO.Markdown.MarkdownDoc System.Object
Outputs: OfficeIMO.Markdown.MarkdownDoc
Source: AddOfficeMarkdownTableCommand.cs:30 Edit on GitHub

Adds a Markdown table from objects.

Syntax

Add-OfficeMarkdownTable
[-CollectionSeparator <String>]
[-DictionaryEntrySeparator <String>]
[-DictionaryKeyValueSeparator <String>]
[-DisableAutoAlign]
[-InputObject] <Object>
[-MaxCollectionItems <Int32>]
[-MaxNestingDepth <Int32>]
[-PassThru]
[-View <Normal|Transpose>]
[<CommonParameters>]

Parameter set: Context

Add-OfficeMarkdownTable
[-CollectionSeparator <String>]
[-DictionaryEntrySeparator <String>]
[-DictionaryKeyValueSeparator <String>]
[-DisableAutoAlign]
-Document <MarkdownDoc>
[-InputObject] <Object>
[-MaxCollectionItems <Int32>]
[-MaxNestingDepth <Int32>]
[-PassThru]
[-View <Normal|Transpose>]
[<CommonParameters>]

Parameter set: Document

Add-OfficeMarkdownTable
[-CollectionSeparator <String>]
[-DictionaryEntrySeparator <String>]
[-DictionaryKeyValueSeparator <String>]
[-DisableAutoAlign]
-Document <MarkdownDoc>
[-InputObject] <Object>
[-MaxCollectionItems <Int32>]
[-MaxNestingDepth <Int32>]
[-PassThru]
[-View <Normal|Transpose>]
[<CommonParameters>]

Parameter set: PipelineDocument

Examples

Add a table from input objects.

MarkdownTable -InputObject $rows

Appends a Markdown table using the supplied objects.

Append multiple tables to the same document.

$doc = New-OfficeMarkdown -Path .\Report.md -NoSave -PassThru
$doc | MarkdownTable -InputObject $summary -PassThru | MarkdownTable -InputObject $details

Creates two tables in sequence within the same Markdown document.

Parameters

-CollectionSeparator String optional: Text used between items when a cell contains a collection.
-DictionaryEntrySeparator String optional: Text used between entries when a cell contains a dictionary.
-DictionaryKeyValueSeparator String optional: Text used between a dictionary key and value.
-DisableAutoAlign SwitchParameter optional: Disable automatic alignment heuristics for tables.
-InputObject Object requiredposition: 0pipeline: True (ByValue): Objects to convert into a Markdown table.
-MaxCollectionItems Int32 optional: Maximum number of items allowed in one nested collection or dictionary cell. Defaults to 1,048,575; increase explicitly for trusted larger values.
-MaxNestingDepth Int32 optional: Maximum nesting depth allowed while normalizing one cell value. Defaults to 64; increase explicitly for trusted deeper values.
-PassThru SwitchParameter optional: Emit the Markdown document after appending the table.
-View OfficeTableView optional: Projection to apply before writing the table.; Possible values: Normal, Transpose
-Document MarkdownDoc requiredpipeline: True (ByValue)sets: Document, PipelineDocument: Markdown document to update outside the DSL context.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.