New-UDValidationResult

Synopsis

Creates a new validation result.

Syntax

New-UDValidationResult [-Valid] [[-ValidationError] <String>] [[-Context] <Hashtable>] [-DisablePrevious] [[-ActiveStep] <Int32>] [<CommonParameters>]

Description

Creates a new validation result. This cmdlet should return its value from the OnValidate script block parameter on New-UDForm or New-UDStepper.

Parameters

-Valid

Marks the validation result as valid when supplied; without this switch, the result's valid value is false.

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-ValidationError

An error to display if the is not valid.

Required?                    false
Position?                    1
Default value                Form is invalid.
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Context

Update the context based on validation. This is only used for New-UDStepper.

Required?                    false
Position?                    2
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-DisablePrevious

Disables the previous button. This is only used for New-UDStepper.

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-ActiveStep

Sets the active step. This is only used for New-UDStepper.

Required?                    false
Position?                    3
Default value                -1
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

Common parameters

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters.