Get-OfficeExcelStreamingContract

Aliases: ExcelStreamingContract

Namespace PSWriteOffice

Aliases

ExcelStreamingContract

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

System.Management.Automation.PSObject

Source

Sources/PSWriteOffice/Cmdlets/Excel/GetOfficeExcelStreamingContractCommand.cs:20 Edit on GitHub

Reports large-workbook streaming and direct-writer suitability.

Remarks

Reports large-workbook streaming and direct-writer suitability.

Examples

Authored help example

Choose the write path for a large export.

PS>


$contract = Get-OfficeExcelStreamingContract -Path .\LargeExport.xlsx
            [pscustomobject]@{
                EstimatedCells = $contract.EstimatedCellCount
                DirectWriter   = $contract.HasDirectDataSetFastSaveState
                Recommendation = $contract.Recommendation
            }

Reports whether the workbook is already using OfficeIMO direct tabular state and gives a size-based recommendation for future imports or exports.

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-OfficeExcelStreamingContract -InputPath <String> [<CommonParameters>]

Parameter set: Path

Parameters

InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path: Workbook path.

Outputs

System.Management.Automation.PSObject

Get-OfficeExcelStreamingContract -Document <ExcelDocument> [<CommonParameters>]

Parameter set: Document

Parameters

Document ExcelDocument requiredposition: namedpipeline: True (ByValue): Workbook document.

Outputs

System.Management.Automation.PSObject