API Reference

Cmdlet

Get-OfficeExcelFormulaAnalysis

Aliases: ExcelFormulaAnalysis, ExcelFormulaAudit
Namespace PSWriteOffice
Aliases
ExcelFormulaAnalysis ExcelFormulaAudit
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
System.Management.Automation.PSObject

Gets workbook formula references, functions, volatile formulas, and external links.

Remarks

Gets workbook formula references, functions, volatile formulas, and external links.

Examples

Authored help example

Find volatile and external-link formulas before publishing a workbook.

PS>


$analysis = Get-OfficeExcelFormulaAnalysis -Path .\Model.xlsx -IncludeFormulas
            $analysis.Formulas |
                Where-Object { $_.IsVolatile -or $_.HasExternalReference } |
                Format-Table SheetName,Address,Formula,IsVolatile,HasExternalReference
        

Uses OfficeIMO formula analysis so scripts can review volatile functions and external workbook references without parsing package XML themselves.

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-OfficeExcelFormulaAnalysis [-IncludeFormulas] -InputPath <String> [<CommonParameters>]
#
Parameter set: Path

Parameters

IncludeFormulas SwitchParameter optionalposition: namedpipeline: False
Include per-cell formula details.
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path
Workbook path.

Outputs

System.Management.Automation.PSObject

Get-OfficeExcelFormulaAnalysis -Document <ExcelDocument> [-IncludeFormulas] [<CommonParameters>]
#
Parameter set: Document

Parameters

Document ExcelDocument requiredposition: namedpipeline: True (ByValue)
Workbook document.
IncludeFormulas SwitchParameter optionalposition: namedpipeline: False
Include per-cell formula details.

Outputs

System.Management.Automation.PSObject