Cmdlet

Add-OfficeExcelValidationCustomFormula

Aliases: ExcelValidationCustomFormula

Module: PSWriteOffice
Aliases: ExcelValidationCustomFormula
Inputs: OfficeIMO.Excel.ExcelDocument
Source: AddOfficeExcelValidationCustomFormulaCommand.cs:16 Edit on GitHub

Adds a custom-formula data validation rule to a worksheet range.

Syntax

Add-OfficeExcelValidationCustomFormula
[-AllowBlank <Boolean>]
[-ErrorMessage <String>]
[-ErrorTitle <String>]
[-Formula] <String>
[-HeaderName <String>]
[-HeaderRow <Int32>]
[-IncludeHeader]
[-PassThru]
[[-Range] <String>]
[-TableName <String>]
[<CommonParameters>]

Parameter set: Context

Add-OfficeExcelValidationCustomFormula
[-AllowBlank <Boolean>]
-Document <ExcelDocument>
[-ErrorMessage <String>]
[-ErrorTitle <String>]
[-Formula] <String>
[-HeaderName <String>]
[-HeaderRow <Int32>]
[-IncludeHeader]
[-PassThru]
[[-Range] <String>]
[-Sheet <String>]
[-SheetIndex <Int32>]
[-TableName <String>]
[<CommonParameters>]

Parameter set: Document

Examples

Restrict cells based on a formula.

ExcelSheet 'Data' { Add-OfficeExcelValidationCustomFormula -Range 'F2:F20' -Formula 'LEN(F2)>0' }

Ensures the validation formula evaluates to true.

Parameters

-AllowBlank Boolean optional: Allow blank values.
-ErrorMessage String optional: Error message shown to the user.
-ErrorTitle String optional: Error title shown to the user.
-Formula String requiredposition: 1: Validation formula.
-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.
-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.