Cmdlet

Add-OfficeExcelAutoFilter

Aliases: ExcelAutoFilter

Module: PSWriteOffice
Aliases: ExcelAutoFilter
Inputs: OfficeIMO.Excel.ExcelDocument
Source: AddOfficeExcelAutoFilterCommand.cs:27 Edit on GitHub

Adds an AutoFilter to the current worksheet.

Syntax

Add-OfficeExcelAutoFilter
[-Criteria <Hashtable>]
[-PassThru]
[-Range] <String>
[<CommonParameters>]

Parameter set: Context

Add-OfficeExcelAutoFilter
[-Criteria <Hashtable>]
-Document <ExcelDocument>
[-PassThru]
[-Range] <String>
[-Sheet <String>]
[-SheetIndex <Int32>]
[<CommonParameters>]

Parameter set: Document

Description

Optional filter criteria can be supplied per column index (0-based within the range).

Examples

Add AutoFilter to a range.

ExcelSheet 'Data' { Add-OfficeExcelAutoFilter -Range 'A1:D200' }

Enables filter dropdowns on the range.

Add AutoFilter with criteria.

Add-OfficeExcelAutoFilter -Range 'A1:D200' -Criteria @{ 2 = 'Open','Hold' }

Filters the third column (0-based within the range) to Open/Hold.

Parameters

-Criteria Hashtable optional: Optional criteria per column index (0-based within the range).
-PassThru SwitchParameter optional: Emit the object created or changed by the command.
-Range String requiredposition: 0: A1 range to apply AutoFilter.
-Document ExcelDocument requiredpipeline: True (ByValue)sets: Document: Workbook to operate on outside the DSL context.
-Sheet String optionalsets: Document: Worksheet name when using Document.
-SheetIndex Int32 optionalsets: Document: Worksheet index (0-based) when using Document.

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.