API Reference
Cmdlet
Add-OfficeExcelValidationTextLength
Adds a text-length data validation rule to a worksheet range.
Remarks
Adds a text-length data validation rule to a worksheet range.
Examples
Example 1: Restrict values to 1-50 characters.
PS>
ExcelSheet 'Data' { Add-OfficeExcelValidationTextLength -Range 'E2:E20' -Operator Between -Formula1 1 -Formula2 50 }
Ensures text length in E2:E20 is between 1 and 50 characters.
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-OfficeExcelValidationTextLength [-AllowBlank <Boolean>] [-ErrorMessage <String>] [-ErrorTitle <String>] -Formula1 <Int32> [-Formula2 <Nullable`1>] [-HeaderName <String>] [-HeaderRow <Int32>] [-IncludeHeader] -Operator <String> [-PassThru] [-Range <String>] [-TableName <String>] [<CommonParameters>]Parameter set:
ContextParameters
- AllowBlank Boolean
- Allow blank values.
- ErrorMessage String
- Error message shown to the user.
- ErrorTitle String
- Error title shown to the user.
- Formula1 Int32
- Primary length bound.
- Formula2 Nullable`1
- Optional secondary length bound.
- HeaderName String
- Header or table column name used to resolve the target range.
- HeaderRow Int32
- Worksheet header row used when resolving HeaderName without a table. Use 0 for the first row of the used range.
- IncludeHeader SwitchParameter
- Include the header cell in the resolved range.
- Operator String
- Validation operator.
- PassThru SwitchParameter
- Emit the range string after applying validation.
- Range String
- Target range in A1 notation.
- TableName String
- Optional table name for header-based range resolution.
Add-OfficeExcelValidationTextLength [-AllowBlank <Boolean>] -Document <ExcelDocument> [-ErrorMessage <String>] [-ErrorTitle <String>] -Formula1 <Int32> [-Formula2 <Nullable`1>] [-HeaderName <String>] [-HeaderRow <Int32>] [-IncludeHeader] -Operator <String> [-PassThru] [-Range <String>] [-Sheet <String>] [-SheetIndex <Nullable`1>] [-TableName <String>] [<CommonParameters>]Parameter set:
DocumentParameters
- AllowBlank Boolean
- Allow blank values.
- Document ExcelDocument
- Workbook to operate on outside the DSL context.
- ErrorMessage String
- Error message shown to the user.
- ErrorTitle String
- Error title shown to the user.
- Formula1 Int32
- Primary length bound.
- Formula2 Nullable`1
- Optional secondary length bound.
- HeaderName String
- Header or table column name used to resolve the target range.
- HeaderRow Int32
- Worksheet header row used when resolving HeaderName without a table. Use 0 for the first row of the used range.
- IncludeHeader SwitchParameter
- Include the header cell in the resolved range.
- Operator String
- Validation operator.
- PassThru SwitchParameter
- Emit the range string after applying validation.
- Range String
- Target range in A1 notation.
- Sheet String
- Worksheet name when using Document.
- SheetIndex Nullable`1
- Worksheet index (0-based) when using Document.
- TableName String
- Optional table name for header-based range resolution.