Get Started

API Reference

Cmdlet

Get-OfficeExcelPreflight

Aliases: ExcelPreflight
Namespace PSWriteOffice
Aliases
ExcelPreflight
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
System.Management.Automation.PSObject System.String
Source
Sources/PSWriteOffice/Cmdlets/Excel/GetOfficeExcelPreflightCommand.cs:18 Edit on GitHub

Runs OfficeIMO Excel feature and workflow preflight checks.

Remarks

Runs OfficeIMO Excel feature and workflow preflight checks.

Examples

Authored help example

Check workbook edit and export readiness.

PS>


$preflight = Get-OfficeExcelPreflight -Path .\Report.xlsx -Capability EditCellValues,ExportPdfReport -IncludeFeatures -IncludeRepairHints
            $preflight.Capabilities |
                Where-Object Passed -eq $false

Returns reusable OfficeIMO capability diagnostics and discovered workbook features.

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

Get-OfficeExcelPreflight [-AsMarkdown] [-Capability <ReadWorkbookData>] [-IncludeFeatures] [-IncludeRepairHints] -InputPath <String> [-ThrowOnFailure] [<CommonParameters>]
#
Parameter set: Path

Parameters

AsMarkdown SwitchParameter optionalposition: namedpipeline: False
Return OfficeIMO's Markdown preflight report instead of structured objects.
Capability ExcelPreflightCapability[] optionalposition: namedpipeline: Falsevalues: 7
Capabilities to evaluate or enforce. Defaults to all capabilities.
Possible values: ReadWorkbookData, EditCellValues, EditWorkbookStructure, UseCachedFormulaValues, CalculateFormulas, BindTemplate, ExportPdfReport
IncludeFeatures SwitchParameter optionalposition: namedpipeline: False
Include discovered feature rows in object output.
IncludeRepairHints SwitchParameter optionalposition: namedpipeline: False
Include actionable OfficeIMO repair hints for blocked capabilities.
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path
Path to the workbook.
ThrowOnFailure SwitchParameter optionalposition: namedpipeline: False
Throw when any requested capability is unavailable. Without -Capability, throws when advanced features need review.

Outputs

System.Management.Automation.PSObject System.String

Get-OfficeExcelPreflight [-AsMarkdown] [-Capability <ReadWorkbookData>] -Document <ExcelDocument> [-IncludeFeatures] [-IncludeRepairHints] [-ThrowOnFailure] [<CommonParameters>]
#
Parameter set: Document

Parameters

AsMarkdown SwitchParameter optionalposition: namedpipeline: False
Return OfficeIMO's Markdown preflight report instead of structured objects.
Capability ExcelPreflightCapability[] optionalposition: namedpipeline: Falsevalues: 7
Capabilities to evaluate or enforce. Defaults to all capabilities.
Possible values: ReadWorkbookData, EditCellValues, EditWorkbookStructure, UseCachedFormulaValues, CalculateFormulas, BindTemplate, ExportPdfReport
Document ExcelDocument requiredposition: namedpipeline: True (ByValue)
Workbook to inspect.
IncludeFeatures SwitchParameter optionalposition: namedpipeline: False
Include discovered feature rows in object output.
IncludeRepairHints SwitchParameter optionalposition: namedpipeline: False
Include actionable OfficeIMO repair hints for blocked capabilities.
ThrowOnFailure SwitchParameter optionalposition: namedpipeline: False
Throw when any requested capability is unavailable. Without -Capability, throws when advanced features need review.

Outputs

System.Management.Automation.PSObject System.String