HtmlForgeX

API Reference

Command

New-HtmlXCheckbox

Namespace HtmlForgeX.PowerShell
Outputs
HtmlForgeX.TablerCheckbox

Creates a checkbox control.

Remarks

Part of the HtmlForgeX.PowerShell DSL.

Examples

Imported script example

New-HtmlXCheckbox -Name "terms" -Label "I agree to the terms" -Checked
        

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

New-HtmlXCheckbox [-Checked] [-Description <string>] [-Disabled] [-Hint <string>] [-Inline] [-Label <string>] [-Name <string>] [-Required] [-ValidationMessage <string>] [-ValidationState <Valid|Invalid|Warning>] [-Value <string>] [<CommonParameters>]
#

Parameters

Checked SwitchParameter optionalposition: namedpipeline: false
Mark as checked.
Description string optionalposition: namedpipeline: false
Description text.
Disabled SwitchParameter optionalposition: namedpipeline: false
Mark as disabled.
Hint string optionalposition: namedpipeline: false
Hint text.
Inline SwitchParameter optionalposition: namedpipeline: false
Render inline.
Label string optionalposition: namedpipeline: false
Label text.
Name string optionalposition: namedpipeline: false
Checkbox name/id.
Required SwitchParameter optionalposition: namedpipeline: false
Mark as required.
ValidationMessage string optionalposition: namedpipeline: false
Validation message.
ValidationState ValidationState optionalposition: namedpipeline: falsevalues: 3
Validation state. Possible values: Valid, Invalid, Warning
Possible values: Valid, Invalid, Warning
Value string optionalposition: namedpipeline: false
Checkbox value.

Outputs

HtmlForgeX.TablerCheckbox