HtmlForgeX

API Reference

Command

New-HtmlXProgress

Namespace HtmlForgeX.PowerShell
Outputs
HtmlForgeX.TablerProgressBar

Creates a Tabler progress bar container.

Remarks

Part of the HtmlForgeX.PowerShell DSL.

Examples

Imported script example

New-HtmlXProgress {
        

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-HtmlXProgress [-Content <ScriptBlock>] [-Margin <TopAuto>] [-Padding <TopAuto>] [-Types <Separated|Small|Indeterminate>] [<CommonParameters>]
#

Parameters

Content ScriptBlock optionalposition: 0pipeline: false
Scriptblock that adds progress items.
Margin TablerMargin optionalposition: namedpipeline: falsevalues: 49
Optional margin utility. Possible values: TopAuto, TopZero, TopQuarter, TopHalf, TopNormal, TopOneAndHalf, TopTriple, BottomAuto, BottomZero, BottomQuarter, BottomHalf, BottomNormal, BottomOneAndHalf, BottomTriple, StartAuto, StartZero, StartQuarter, StartHalf, StartNormal, StartOneAndHalf, StartTriple, EndAuto, EndZero, EndQuarter, EndHalf, EndNormal, EndOneAndHalf, EndTriple, HorizontalAuto, HorizontalZero, HorizontalQuarter, HorizontalHalf, HorizontalNormal, HorizontalOneAndHalf, HorizontalTriple, VerticalAuto, VerticalZero, VerticalQuarter, VerticalHalf, VerticalNormal, VerticalOneAndHalf, VerticalTriple, AllAuto, AllZero, AllQuarter, AllHalf, AllNormal, AllOneAndHalf, AllTriple
Possible values: TopAuto, TopZero, TopQuarter, TopHalf, TopNormal, TopOneAndHalf, TopTriple, BottomAuto, BottomZero, BottomQuarter, BottomHalf, BottomNormal, BottomOneAndHalf, BottomTriple, StartAuto, StartZero, StartQuarter, StartHalf, StartNormal, StartOneAndHalf, StartTriple, EndAuto, EndZero, EndQuarter, EndHalf, EndNormal, EndOneAndHalf, EndTriple, HorizontalAuto, HorizontalZero, HorizontalQuarter, HorizontalHalf, HorizontalNormal, HorizontalOneAndHalf, HorizontalTriple, VerticalAuto, VerticalZero, VerticalQuarter, VerticalHalf, VerticalNormal, VerticalOneAndHalf, VerticalTriple, AllAuto, AllZero, AllQuarter, AllHalf, AllNormal, AllOneAndHalf, AllTriple
Padding TablerPadding optionalposition: namedpipeline: falsevalues: 49
Optional padding utility. Possible values: TopAuto, TopZero, TopQuarter, TopHalf, TopNormal, TopOneAndHalf, TopTriple, BottomAuto, BottomZero, BottomQuarter, BottomHalf, BottomNormal, BottomOneAndHalf, BottomTriple, StartAuto, StartZero, StartQuarter, StartHalf, StartNormal, StartOneAndHalf, StartTriple, EndAuto, EndZero, EndQuarter, EndHalf, EndNormal, EndOneAndHalf, EndTriple, HorizontalAuto, HorizontalZero, HorizontalQuarter, HorizontalHalf, HorizontalNormal, HorizontalOneAndHalf, HorizontalTriple, VerticalAuto, VerticalZero, VerticalQuarter, VerticalHalf, VerticalNormal, VerticalOneAndHalf, VerticalTriple, AllAuto, AllZero, AllQuarter, AllHalf, AllNormal, AllOneAndHalf, AllTriple
Possible values: TopAuto, TopZero, TopQuarter, TopHalf, TopNormal, TopOneAndHalf, TopTriple, BottomAuto, BottomZero, BottomQuarter, BottomHalf, BottomNormal, BottomOneAndHalf, BottomTriple, StartAuto, StartZero, StartQuarter, StartHalf, StartNormal, StartOneAndHalf, StartTriple, EndAuto, EndZero, EndQuarter, EndHalf, EndNormal, EndOneAndHalf, EndTriple, HorizontalAuto, HorizontalZero, HorizontalQuarter, HorizontalHalf, HorizontalNormal, HorizontalOneAndHalf, HorizontalTriple, VerticalAuto, VerticalZero, VerticalQuarter, VerticalHalf, VerticalNormal, VerticalOneAndHalf, VerticalTriple, AllAuto, AllZero, AllQuarter, AllHalf, AllNormal, AllOneAndHalf, AllTriple
Types TablerProgressBarType[] optionalposition: namedpipeline: falsevalues: 3
Progress bar types to apply. Possible values: Separated, Small, Indeterminate
Possible values: Separated, Small, Indeterminate

Outputs

HtmlForgeX.TablerProgressBar