Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Cmdlet

Set-OfficeExcelExecutionPolicy

Aliases: ExcelExecutionPolicy
Module PSWriteOffice
Aliases
ExcelExecutionPolicy
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
OfficeIMO.Excel.ExcelDocument

Configures OfficeIMO Excel execution and validation behavior for a workbook.

Syntax

Set-OfficeExcelExecutionPolicy [-Diagnostics] [-DisableAutoFitImmediateSave] [-MaxDegreeOfParallelism <Int32>] [-Mode <Automatic|Sequential|Parallel>] [-ParallelThreshold <Int32>] [-PassThru] [-WorksheetValidation <Disabled|DiagnosticsOnly|DebugOnly|Always>] [<CommonParameters>]
#
Parameter set: Context
Set-OfficeExcelExecutionPolicy [-Diagnostics] [-DisableAutoFitImmediateSave] [-Document] <ExcelDocument> [-MaxDegreeOfParallelism <Int32>] [-Mode <Automatic|Sequential|Parallel>] [-ParallelThreshold <Int32>] [-PassThru] [-WorksheetValidation <Disabled|DiagnosticsOnly|DebugOnly|Always>] [<CommonParameters>]
#
Parameter set: Document

Examples

Authored help example

Force sequential execution for a workbook.

$workbook | Set-OfficeExcelExecutionPolicy -Mode Sequential

Disables automatic parallel execution decisions for subsequent OfficeIMO operations.

Parameters

-Diagnostics SwitchParameter optional
Request diagnostics-aware validation without wiring verbose callbacks.
-DisableAutoFitImmediateSave SwitchParameter optional
Do not save worksheet parts immediately after AutoFit width/height mutations.
-MaxDegreeOfParallelism Int32 optional
Optional cap for parallel compute phases.
-Mode ExcelExecutionMode optional
Execution mode for large operations.
Possible values: Automatic, Sequential, Parallel
-ParallelThreshold Int32 optional
Global item threshold above which Automatic mode switches to Parallel.
-PassThru SwitchParameter optional
Emit the workbook after updating the policy.
-WorksheetValidation ExcelWorksheetValidationMode optional
Worksheet validation mode for write operations.
Possible values: Disabled, DiagnosticsOnly, DebugOnly, Always
-Document ExcelDocument requiredposition: 0pipeline: True (ByValue)sets: Document
Workbook whose execution policy should be updated.

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.