API Reference

Cmdlet

Add-OfficeExcelValidationTime

Aliases: ExcelValidationTime
Namespace PSWriteOffice
Aliases
ExcelValidationTime
Inputs
OfficeIMO.Excel.ExcelDocument

Adds a time data validation rule to a worksheet range.

Remarks

Adds a time data validation rule to a worksheet range.

Examples

Authored help example

Example 1: Restrict values to before 5PM.

PS>


ExcelSheet 'Data' { Add-OfficeExcelValidationTime -Range 'D2:D20' -Operator LessThan -Formula1 ([TimeSpan]::FromHours(17)) }
        

Ensures times in D2:D20 are before 17:00.

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-OfficeExcelValidationTime [-AllowBlank <Boolean>] [-ErrorMessage <String>] [-ErrorTitle <String>] -Formula1 <TimeSpan> [-Formula2 <Nullable`1>] [-HeaderName <String>] [-HeaderRow <Int32>] [-IncludeHeader] -Operator <String> [-PassThru] [-Range <String>] [-TableName <String>] [<CommonParameters>]
#
Parameter set: Context

Parameters

AllowBlank Boolean optionalposition: namedpipeline: False
Allow blank values.
ErrorMessage String optionalposition: namedpipeline: False
Error message shown to the user.
ErrorTitle String optionalposition: namedpipeline: False
Error title shown to the user.
Formula1 TimeSpan requiredposition: 2pipeline: False
Primary time bound.
Formula2 Nullable`1 optionalposition: namedpipeline: False
Optional secondary time bound.
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.
Operator String requiredposition: 1pipeline: False
Validation operator.
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.
Add-OfficeExcelValidationTime [-AllowBlank <Boolean>] -Document <ExcelDocument> [-ErrorMessage <String>] [-ErrorTitle <String>] -Formula1 <TimeSpan> [-Formula2 <Nullable`1>] [-HeaderName <String>] [-HeaderRow <Int32>] [-IncludeHeader] -Operator <String> [-PassThru] [-Range <String>] [-Sheet <String>] [-SheetIndex <Nullable`1>] [-TableName <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.
ErrorMessage String optionalposition: namedpipeline: False
Error message shown to the user.
ErrorTitle String optionalposition: namedpipeline: False
Error title shown to the user.
Formula1 TimeSpan requiredposition: 2pipeline: False
Primary time bound.
Formula2 Nullable`1 optionalposition: namedpipeline: False
Optional secondary time bound.
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.
Operator String requiredposition: 1pipeline: False
Validation operator.
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.