Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 622 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

Add-OfficeExcelPackageMetadata

Aliases: ExcelConnectionMetadata, ExcelPackageMetadata
Module PSWriteOffice
Aliases
ExcelConnectionMetadata ExcelPackageMetadata
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
System.Management.Automation.PSObject
Source
AddOfficeExcelPackageMetadataCommand.cs:19 Edit on GitHub

Adds explicit workbook package metadata such as connection or query-table XML.

Syntax

Add-OfficeExcelPackageMetadata -Kind <Connection|QueryTable> [-PassThru] [-WorksheetName <String>] -Xml <String> [<CommonParameters>]
#
Parameter set: Context
Add-OfficeExcelPackageMetadata -Kind <Connection|QueryTable> [-PassThru] [-Path] <String> [-WorksheetName <String>] -Xml <String> [<CommonParameters>]
#
Parameter set: Path
Add-OfficeExcelPackageMetadata -Document <ExcelDocument> -Kind <Connection|QueryTable> [-PassThru] [-WorksheetName <String>] -Xml <String> [<CommonParameters>]
#
Parameter set: Document

Examples

Authored help example

Add connection metadata and query-table metadata to an existing workbook.

Add-OfficeExcelPackageMetadata -Path .\Report.xlsx -Kind Connection -Xml $connectionsXml
Add-OfficeExcelPackageMetadata -Path .\Report.xlsx -Kind QueryTable -WorksheetName Data -Xml $queryTableXml

Adds caller-supplied XML metadata parts. OfficeIMO preserves these parts but does not refresh external queries.

Parameters

-Kind OfficeExcelPackageMetadataKind required
Metadata kind to add.
Possible values: Connection, QueryTable
-PassThru SwitchParameter optional
Emit metadata about the added package part.
-WorksheetName String optionalaliases: Sheet, SheetName, Worksheet
Worksheet for query-table metadata. Defaults to the current DSL sheet, or the first worksheet outside the DSL.
-Xml String required
XML payload to add as package metadata.
-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path
Workbook path to update.
-Document ExcelDocument requiredpipeline: True (ByValue)sets: Document
Workbook to update outside the DSL context.

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.