Add-OfficeExcelValidationList

Aliases: ExcelValidationList

Namespace PSWriteOffice

Aliases

ExcelValidationList

Inputs

OfficeIMO.Excel.ExcelDocument

Source

Sources/PSWriteOffice/Cmdlets/Excel/AddOfficeExcelValidationListCommand.cs:18 Edit on GitHub

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

Remarks

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

Examples

Authored help example

Example 1: Add a validation list to a range.

PS>


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

Restricts column C to the provided values.

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

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

Parameter set: Context

Parameters

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

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

Parameter set: Document

Parameters

AllowBlank Boolean optionalposition: namedpipeline: False: Allow blank values.
Document ExcelDocument requiredposition: namedpipeline: True (ByValue): Workbook to operate on outside the DSL context.
HeaderName String optionalposition: namedpipeline: Falsealiases: ColumnName: Header or table column name used to resolve the target range.
HeaderRow Int32 optionalposition: namedpipeline: False: Worksheet header row used when resolving HeaderName without a table. Use 0 for the first row of the used range.
IncludeHeader SwitchParameter optionalposition: namedpipeline: False: Include the header cell in the resolved range.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the range string after applying validation.
Range String optionalposition: 0pipeline: False: Target range in A1 notation.
Sheet String optionalposition: namedpipeline: False: Worksheet name when using Document.
SheetIndex Nullable`1 optionalposition: namedpipeline: False: Worksheet index (0-based) when using Document.
TableName String optionalposition: namedpipeline: False: Optional table name for header-based range resolution.
Values String[] requiredposition: 1pipeline: False: Allowed values for the dropdown list.