Cmdlet

Add-OfficeExcelValidationList

Aliases: ExcelValidationList

Module: PSWriteOffice
Aliases: ExcelValidationList
Inputs: OfficeIMO.Excel.ExcelDocument
Source: AddOfficeExcelValidationListCommand.cs:18 Edit on GitHub

Adds a list-based data validation to a worksheet range.

Syntax

Add-OfficeExcelValidationList
[-AllowBlank <Boolean>]
[-HeaderName <String>]
[-HeaderRow <Int32>]
[-IncludeHeader]
[-PassThru]
[[-Range] <String>]
[-TableName <String>]
[-Values] <String[]>
[<CommonParameters>]

Parameter set: Context

Add-OfficeExcelValidationList
[-AllowBlank <Boolean>]
-Document <ExcelDocument>
[-HeaderName <String>]
[-HeaderRow <Int32>]
[-IncludeHeader]
[-PassThru]
[[-Range] <String>]
[-Sheet <String>]
[-SheetIndex <Int32>]
[-TableName <String>]
[-Values] <String[]>
[<CommonParameters>]

Parameter set: Document

Description

When invoked inside the Excel DSL, applies to the current worksheet.

Examples

Add a validation list to a range.

ExcelSheet 'Data' { Add-OfficeExcelValidationList -Range 'C2:C50' -Values 'New','In Progress','Done' }

Restricts column C to the provided values.

Parameters

-AllowBlank Boolean optional: Allow blank values.
-HeaderName String optionalaliases: ColumnName: Header or table column name used to resolve the target range.
-HeaderRow Int32 optional: Worksheet header row used when resolving HeaderName without a table. Use 0 for the first row of the used range.
-IncludeHeader SwitchParameter optional: Include the header cell in the resolved range.
-PassThru SwitchParameter optional: Emit the range string after applying validation.
-Range String optionalposition: 0: Target range in A1 notation.
-TableName String optional: Optional table name for header-based range resolution.
-Values String[] requiredposition: 1: Allowed values for the dropdown list.
-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.