Clear-OfficeExcelAutoFilter

Aliases: ExcelAutoFilterClear

Namespace PSWriteOffice

Aliases

ExcelAutoFilterClear

Inputs

OfficeIMO.Excel.ExcelDocument

Source

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

Clears any AutoFilter on the current worksheet.

Remarks

Clears any AutoFilter on the current worksheet.

Examples

Authored help example

Example 1: Remove AutoFilter from the active sheet.

PS>


ExcelSheet 'Data' { Clear-OfficeExcelAutoFilter }

Removes filter dropdowns and criteria.

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

Clear-OfficeExcelAutoFilter [<CommonParameters>]

Parameter set: Context

Clear-OfficeExcelAutoFilter -Document <ExcelDocument> [-Sheet <String>] [-SheetIndex <Nullable`1>] [<CommonParameters>]

Parameter set: Document

Parameters

Document ExcelDocument requiredposition: namedpipeline: True (ByValue): Workbook to operate on outside the DSL context.
Sheet String optionalposition: namedpipeline: False: Worksheet name when using Document.
SheetIndex Nullable`1 optionalposition: namedpipeline: False: Worksheet index (0-based) when using Document.