Project

PSWriteOffice

PowerShell document automation across OfficeIMO's document, spreadsheet, presentation, PDF, Project, Access, EPUB, invoicing, and conversion engines.

View on GitHub Releases Get package
Stars 654
Forks 82
Open issues 1
Total downloads 4,320,051
Release OfficeIMO-v3.5.3
Language: C# Updated: 2026-11-03
Cmdlet

Get-OfficeExcelPreflight

Aliases: ExcelPreflight
Module
PSWriteOffice
Aliases
ExcelPreflight
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
System.Management.Automation.PSObject System.String
Source
GetOfficeExcelPreflightCommand.cs:21 Edit on GitHub

Runs OfficeIMO Excel feature and workflow preflight checks.

Syntax

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

Examples

Check workbook edit and export readiness.

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

Parameters

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

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.