Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 606 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
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

Guides & Samples

Authored walkthroughs and practical samples linked to this command.

  • Choose a PSWriteOffice Workflow Guide

    Decide between authoring, editing, inspection, conversion, and normalized Reader extraction. Includes examples and cmdlet links.

  • Automate Excel Workbooks Guide

    Build, inspect, validate, compare, repair, and publish workbook workflows from PowerShell. Includes examples and cmdlet links.

  • Validate and Repair Excel Workbooks Guide

    Preflight workbook operations, test integrity and accessibility, diagnose package state, and apply deliberate repairs.

Examples

Authored help example

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.