Cmdlet

Test-OfficeExcelTemplateBinding

Aliases: ExcelTemplateBinding, ExcelTemplateValidate

Module PSWriteOffice

Aliases

ExcelTemplateBinding ExcelTemplateValidate

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

System.Management.Automation.PSObject System.String System.Boolean

Source

TestOfficeExcelTemplateBindingCommand.cs:26 Edit on GitHub

Validates Excel template markers against supplied bindings before applying a template.

Syntax

Test-OfficeExcelTemplateBinding [-AsMarkdown] -Binding <IDictionary> [-Path] <String> [-Quiet] [-ThrowOnMissing] [<CommonParameters>]

Parameter set: Path

Test-OfficeExcelTemplateBinding [-AsMarkdown] -Binding <IDictionary> -Document <ExcelDocument> [-Quiet] [-ThrowOnMissing] [<CommonParameters>]

Parameter set: Document

Examples

Authored help example

Fail fast when a template workbook is missing required values.

$bindings = @{
    CustomerName = 'Northwind'
    InvoiceDate  = Get-Date
    Total        = 1250.75
}
$result = Test-OfficeExcelTemplateBinding -Path .\InvoiceTemplate.xlsx -Binding $bindings -AsMarkdown
$result | Set-Content .\InvoiceTemplateBinding.md

Uses OfficeIMO template inspection and returns either structured missing-marker data or the reusable Markdown marker report.

Parameters

-AsMarkdown SwitchParameter optional: Return OfficeIMO's Markdown marker report.
-Binding IDictionary required: Template bindings keyed by marker name.
-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path: Workbook path.
-Quiet SwitchParameter optional: Return only a Boolean pass/fail value.
-ThrowOnMissing SwitchParameter optional: Throw when any marker is missing.
-Document ExcelDocument requiredpipeline: True (ByValue)sets: Document: Workbook 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.