Set-OfficeExcelRefreshOnOpen

Aliases: ExcelRefreshOnOpen

Namespace PSWriteOffice

Aliases

ExcelRefreshOnOpen

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

System.Management.Automation.PSObject

Source

Sources/PSWriteOffice/Cmdlets/Excel/SetOfficeExcelRefreshOnOpenCommand.cs:16 Edit on GitHub

Configures workbook data refresh metadata for Excel-compatible applications to run when the file opens.

Remarks

Configures workbook data refresh metadata for Excel-compatible applications to run when the file opens.

Examples

Authored help example

Refresh pivot caches when the workbook opens.

PS>


$refresh = Set-OfficeExcelRefreshOnOpen -Path .\Report.xlsx -PivotTables -Connections -NoSavePivotSourceData -PassThru
            Get-OfficeExcelDataModel -Path .\Report.xlsx |
                Select-Object ConnectionPartCount, QueryTablePartCount

Sets workbook metadata through OfficeIMO so pivot caches refresh on open.

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

Set-OfficeExcelRefreshOnOpen [-Connections] [-Disable] [-NoSavePivotSourceData] [-PassThru] [-PivotTables] [-SavePivotSourceData] [<CommonParameters>]

Parameter set: Context

Parameters

Connections SwitchParameter optionalposition: namedpipeline: False: Update workbook connection refresh-on-open metadata.
Disable SwitchParameter optionalposition: namedpipeline: False: Disable refresh-on-open instead of enabling it.
NoSavePivotSourceData SwitchParameter optionalposition: namedpipeline: False: Do not save pivot cache source data.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the update summary.
PivotTables SwitchParameter optionalposition: namedpipeline: False: Update pivot cache refresh-on-open metadata.
SavePivotSourceData SwitchParameter optionalposition: namedpipeline: False: Preserve pivot cache source data.

Outputs

System.Management.Automation.PSObject

Set-OfficeExcelRefreshOnOpen [-Connections] [-Disable] -InputPath <String> [-NoSavePivotSourceData] [-PassThru] [-PivotTables] [-SavePivotSourceData] [<CommonParameters>]

Parameter set: Path

Parameters

Connections SwitchParameter optionalposition: namedpipeline: False: Update workbook connection refresh-on-open metadata.
Disable SwitchParameter optionalposition: namedpipeline: False: Disable refresh-on-open instead of enabling it.
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path: Workbook path to update.
NoSavePivotSourceData SwitchParameter optionalposition: namedpipeline: False: Do not save pivot cache source data.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the update summary.
PivotTables SwitchParameter optionalposition: namedpipeline: False: Update pivot cache refresh-on-open metadata.
SavePivotSourceData SwitchParameter optionalposition: namedpipeline: False: Preserve pivot cache source data.

Outputs

System.Management.Automation.PSObject

Set-OfficeExcelRefreshOnOpen [-Connections] [-Disable] -Document <ExcelDocument> [-NoSavePivotSourceData] [-PassThru] [-PivotTables] [-SavePivotSourceData] [<CommonParameters>]

Parameter set: Document

Parameters

Connections SwitchParameter optionalposition: namedpipeline: False: Update workbook connection refresh-on-open metadata.
Disable SwitchParameter optionalposition: namedpipeline: False: Disable refresh-on-open instead of enabling it.
Document ExcelDocument requiredposition: namedpipeline: True (ByValue): Workbook to update outside the DSL context.
NoSavePivotSourceData SwitchParameter optionalposition: namedpipeline: False: Do not save pivot cache source data.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the update summary.
PivotTables SwitchParameter optionalposition: namedpipeline: False: Update pivot cache refresh-on-open metadata.
SavePivotSourceData SwitchParameter optionalposition: namedpipeline: False: Preserve pivot cache source data.

Outputs

System.Management.Automation.PSObject