New-UDFormValidationResult

Creates a new validation result.

Synopsis

Creates a new validation result.

Syntax

New-UDFormValidationResult [-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

-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 [<SwitchParameter>]
        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

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).