Cmdlet

Add-OfficeExcelDataSet

Aliases: ExcelDataSet

Module: PSWriteOffice
Aliases: ExcelDataSet
Inputs: System.Data.DataSet
Outputs: OfficeIMO.Excel.ExcelDataSetImportResult
Source: AddOfficeExcelDataSetCommand.cs:20 Edit on GitHub

Writes every table in a DataSet to separate Excel worksheets.

Syntax

Add-OfficeExcelDataSet
[-AutoFit]
[-DataSet] <DataSet>
[-NoAutoFilter]
[-NoHeader]
[-NoRowStripes]
[-NoTable]
[-PassThru]
[-ShowColumnStripes]
[-ShowFirstColumn]
[-ShowLastColumn]
[-TableStyle <ExcelTableStyle>]
[<CommonParameters>]

Parameter set: All Parameter Sets

Description

Uses OfficeIMO.Excel DataSet ingestion so callers can provide data from any .NET provider without PSWriteOffice owning database connections.

Examples

Insert each DataSet table as a worksheet.

New-OfficeExcel -Path .\report.xlsx { Add-OfficeExcelDataSet -DataSet $dataSet -AutoFit }

Creates one worksheet per DataTable and formats each range as an Excel table.

Parameters

-AutoFit SwitchParameter optional: Auto-fit imported table columns.
-DataSet DataSet requiredposition: 0pipeline: True (ByValue): Source DataSet whose tables will become worksheets.
-NoAutoFilter SwitchParameter optional: Disable AutoFilter dropdowns.
-NoHeader SwitchParameter optional: Skip writing headers.
-NoRowStripes SwitchParameter optional: Disable alternating row stripes for created tables.
-NoTable SwitchParameter optional: Write plain ranges instead of Excel tables.
-PassThru SwitchParameter optional: Return import metadata for each worksheet.
-ShowColumnStripes SwitchParameter optional: Enable alternating column stripes for created tables.
-ShowFirstColumn SwitchParameter optional: Emphasize the first table column when the selected style supports it.
-ShowLastColumn SwitchParameter optional: Emphasize the last table column when the selected style supports it.
-TableStyle ExcelTableStyle optional: Built-in table style to apply.; Possible values: TableStyleLight1, TableStyleLight2, TableStyleLight3, TableStyleLight4, TableStyleLight5, TableStyleLight6, TableStyleLight7, TableStyleLight8, TableStyleLight9, TableStyleLight10, TableStyleLight11, TableStyleLight12, TableStyleLight13, TableStyleLight14, TableStyleLight15, TableStyleLight16, TableStyleLight17, TableStyleLight18, TableStyleLight19, TableStyleLight20, TableStyleLight21, TableStyleMedium1, TableStyleMedium2, TableStyleMedium3, TableStyleMedium4, TableStyleMedium5, TableStyleMedium6, TableStyleMedium7, TableStyleMedium8, TableStyleMedium9, TableStyleMedium10, TableStyleMedium11, TableStyleMedium12, TableStyleMedium13, TableStyleMedium14, TableStyleMedium15, TableStyleMedium16, TableStyleMedium17, TableStyleMedium18, TableStyleMedium19, TableStyleMedium20, TableStyleMedium21, TableStyleMedium22, TableStyleMedium23, TableStyleMedium24, TableStyleMedium25, TableStyleMedium26, TableStyleMedium27, TableStyleMedium28, TableStyleDark1, TableStyleDark2, TableStyleDark3, TableStyleDark4, TableStyleDark5, TableStyleDark6, TableStyleDark7, TableStyleDark8, TableStyleDark9, TableStyleDark10, TableStyleDark11

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.