Test-OfficeExcelTemplateBinding

Aliases: ExcelTemplateBinding, ExcelTemplateValidate

Namespace PSWriteOffice

Aliases

ExcelTemplateBinding ExcelTemplateValidate

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

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

Source

Sources/PSWriteOffice/Cmdlets/Excel/TestOfficeExcelTemplateBindingCommand.cs:23 Edit on GitHub

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

Remarks

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

Examples

Authored help example

Fail fast when a template workbook is missing required values.

PS>


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

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

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

Parameter set: Path

Parameters

AsMarkdown SwitchParameter optionalposition: namedpipeline: False: Return OfficeIMO's Markdown marker report.
Binding IDictionary requiredposition: namedpipeline: False: Template bindings keyed by marker name.
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path: Workbook path.
Quiet SwitchParameter optionalposition: namedpipeline: False: Return only a Boolean pass/fail value.
ThrowOnMissing SwitchParameter optionalposition: namedpipeline: False: Throw when any marker is missing.

Outputs

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

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

Parameter set: Document

Parameters

AsMarkdown SwitchParameter optionalposition: namedpipeline: False: Return OfficeIMO's Markdown marker report.
Binding IDictionary requiredposition: namedpipeline: False: Template bindings keyed by marker name.
Document ExcelDocument requiredposition: namedpipeline: True (ByValue): Workbook document.
Quiet SwitchParameter optionalposition: namedpipeline: False: Return only a Boolean pass/fail value.
ThrowOnMissing SwitchParameter optionalposition: namedpipeline: False: Throw when any marker is missing.

Outputs

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