OfficeIMO

API Reference

Command

Add-OfficeMarkdownTable

Namespace PSWriteOffice
Inputs
OfficeIMO.Markdown.MarkdownDoc System.Object
Outputs
OfficeIMO.Markdown.MarkdownDoc

Adds a Markdown table from objects.

Remarks

Adds a Markdown table from objects.

Examples

Add a table from input objects.


PS>MarkdownTable -InputObject $rows

Appends a Markdown table using the supplied objects.

Append multiple tables to the same document.


PS>$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.

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.

Syntax

Add-OfficeMarkdownTable [-DisableAutoAlign] [-InputObject <Object>] [-PassThru] [<CommonParameters>]
#
Parameter set: Context

Parameters

DisableAutoAlign SwitchParameter optionalposition: namedpipeline: False
Disable automatic alignment heuristics for tables.
InputObject Object optionalposition: namedpipeline: True (ByValue)
Objects to convert into a Markdown table.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the Markdown document after appending the table.

Outputs

OfficeIMO.Markdown.MarkdownDoc

Add-OfficeMarkdownTable [-DisableAutoAlign] -Document <MarkdownDoc> [-InputObject <Object>] [-PassThru] [<CommonParameters>]
#
Parameter set: Document

Parameters

DisableAutoAlign SwitchParameter optionalposition: namedpipeline: False
Disable automatic alignment heuristics for tables.
Document MarkdownDoc requiredposition: namedpipeline: True (ByValue)
Markdown document to update outside the DSL context.
InputObject Object optionalposition: namedpipeline: True (ByValue)
Objects to convert into a Markdown table.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the Markdown document after appending the table.

Outputs

OfficeIMO.Markdown.MarkdownDoc