PoshProgressBar

0.131

PoshProgressBar.psm1-help.xml

<helpItems schema="maml">
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<!--Generated by PS Cmdlet Help Editor-->
    <command:details>
        <command:name>New-ProgressBar</command:name>
        <maml:description>
            <maml:para>Used for creating a new progress bar</maml:para>
        </maml:description>
        <maml:copyright>
            <maml:para />
        </maml:copyright>
        <command:verb>New</command:verb>
        <command:noun>ProgressBar</command:noun>
        <dev:version />
    </command:details>
    <maml:description>
        <maml:para>Creates a new progress bar by dynamically creating some XAML based on the input parameters. See the blog posting for more information.</maml:para>
    </maml:description>
    <command:syntax>
        <command:syntaxItem>
            <maml:name>New-ProgressBar</maml:name>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>IsIndeterminate</maml:name>
                <maml:description>
                    <maml:para>If this is set to $True the progress bar will cycle continuously while the percentage stays at 0%</maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>MaterialDesign</maml:name>
                <maml:description>
                    <maml:para>Specifies that you would like the progress bar to be a Material Design style.</maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>IconPath</maml:name>
                <maml:description>
                    <maml:para>The full path for the icon you would like to use for the progressbar notification and window.</maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>Type</maml:name>
                <maml:description>
                    <maml:para>This is the type or style of your progress bar circular, vertical or horizontal.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>PrimaryColor</maml:name>
                <maml:description>
                    <maml:para>The primary color will affect the color of the progress bar itself.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>AccentColor</maml:name>
                <maml:description>
                    <maml:para>Does nothing at this time.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>Size</maml:name>
                <maml:description>
                    <maml:para>Sets the size of your progress bar.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>Theme</maml:name>
                <maml:description>
                    <maml:para>Light or dark themed background for your progress bar.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>InformationAction</maml:name>
                <maml:description>
                    <maml:para />
                </maml:description>
                <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>InformationVariable</maml:name>
                <maml:description>
                    <maml:para />
                </maml:description>
                <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            </command:parameter>
        </command:syntaxItem>
    </command:syntax>
    <command:parameters>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
            <maml:name>IsIndeterminate</maml:name>
            <maml:description>
                <maml:para>If this is set to $True the progress bar will cycle continuously while the percentage stays at 0%</maml:para>
            </maml:description>
            <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
            <dev:type>
                <maml:name>Boolean</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue>$True</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
            <maml:name>MaterialDesign</maml:name>
            <maml:description>
                <maml:para>Specifies that you would like the progress bar to be a Material Design style.</maml:para>
            </maml:description>
            <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
            <dev:type>
                <maml:name>SwitchParameter</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
            <maml:name>IconPath</maml:name>
            <maml:description>
                <maml:para>The full path for the icon you would like to use for the progressbar notification and window.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            <dev:type>
                <maml:name>String</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue>Blue</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
            <maml:name>Type</maml:name>
            <maml:description>
                <maml:para>This is the type or style of your progress bar circular, vertical or horizontal.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            <dev:type>
                <maml:name>String</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue>Horizontal</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
            <maml:name>PrimaryColor</maml:name>
            <maml:description>
                <maml:para>The primary color will affect the color of the progress bar itself.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            <dev:type>
                <maml:name>String</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue>Blue</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
            <maml:name>AccentColor</maml:name>
            <maml:description>
                <maml:para>Does nothing at this time.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            <dev:type>
                <maml:name>String</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue>LightBlue</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
            <maml:name>Size</maml:name>
            <maml:description>
                <maml:para>Sets the size of your progress bar.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            <dev:type>
                <maml:name>String</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue>Medium</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
            <maml:name>Theme</maml:name>
            <maml:description>
                <maml:para>Light or dark themed background for your progress bar.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            <dev:type>
                <maml:name>String</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue>Light</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
            <maml:name>InformationAction</maml:name>
            <maml:description>
                <maml:para />
            </maml:description>
            <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue>
            <dev:type>
                <maml:name>ActionPreference</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
            <maml:name>InformationVariable</maml:name>
            <maml:description>
                <maml:para />
            </maml:description>
            <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            <dev:type>
                <maml:name>String</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
    </command:parameters>
    <command:inputTypes>
        <command:inputType>
            <dev:type>
                <maml:name></maml:name>
                <maml:uri></maml:uri>
                <maml:description/>
            </dev:type>
            <maml:description>
<maml:para />
            </maml:description>
        </command:inputType>
    </command:inputTypes>
    <command:returnValues>
        <command:returnValue>
            <dev:type>
                <maml:name></maml:name>
                <maml:uri></maml:uri>
                <maml:description/>
            </dev:type>
            <maml:description>
<maml:para />
            </maml:description>
        </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors></command:terminatingErrors>
    <command:nonTerminatingErrors></command:nonTerminatingErrors>
    <maml:alertSet>
        <maml:title></maml:title>
        <maml:alert>
            <maml:para />
        </maml:alert>
    </maml:alertSet>
    <command:examples>
        <command:example>
            <maml:title>-------------------------- Progress Bars Demo --------------------------</maml:title>
            <maml:introduction>
                <maml:paragraph>PS C:\&gt;</maml:paragraph>
            </maml:introduction>
            <dev:code>$ProgressBars = @()
 
$ProgressBars += New-ProgressBar -MaterialDesign -IsIndeterminate $true -Type Circle -PrimaryColor Green -AccentColor DeepPurple -Size Large -Theme Dark
$ProgressBars += New-ProgressBar -MaterialDesign -Type Horizontal -PrimaryColor Red -AccentColor LightBlue -Size Medium -Theme Light
$ProgressBars += New-ProgressBar -MaterialDesign -Type Vertical -PrimaryColor Amber -AccentColor DeepOrange -Size Large -Theme Dark
$ProgressBars += New-ProgressBar -MaterialDesign -Type Circle -PrimaryColor Blue -AccentColor Cyan -Size Small -Theme Light
 
Start-Sleep -Seconds 2
 
$i = 0
foreach ($File in $Files) {
                    $i++
                    Start-Sleep -Milliseconds 2
                    foreach ($ProgressBar in $ProgressBars) {
     
     
                        Write-ProgressBar `
                                -ProgressBar $ProgressBar `
                                -Activity &quot;Viewing Files&quot; `
                                -PercentComplete (($i/$Files.count) * 100) `
                                -CurrentOperation $File.FullName `
                                -Status $File.Name `
                                -SecondsRemaining ($Files.Count - $i)
 
                    }
 
                }</dev:code>
            <dev:remarks>
                <maml:para>This will create several different style progress bars and run through them for you to get an idea of what they look like</maml:para>
                <maml:para />
                <maml:para />
                <maml:para></maml:para>
            </dev:remarks>
            <command:commandLines>
                <command:commandLine>
                    <command:commandText>
                        <maml:para />
                    </command:commandText>
                </command:commandLine>
            </command:commandLines>
        </command:example>
    </command:examples>
    <maml:relatedLinks>
        <maml:navigationLink>
            <maml:linkText>tiberriver256.github.io/powershell/PowerShellProgress-Pt4/</maml:linkText>
            <maml:uri></maml:uri>
        </maml:navigationLink>
    </maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<!--Generated by PS Cmdlet Help Editor-->
    <command:details>
        <command:name>Close-ProgressBar</command:name>
        <maml:description>
            <maml:para>Used to cleanly close the progress bar and corresponding runspace.</maml:para>
        </maml:description>
        <maml:copyright>
            <maml:para />
        </maml:copyright>
        <command:verb>Close</command:verb>
        <command:noun>ProgressBar</command:noun>
        <dev:version />
    </command:details>
    <maml:description>
        <maml:para />
    </maml:description>
    <command:syntax>
        <command:syntaxItem>
            <maml:name>Close-ProgressBar</maml:name>
            <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0">
                <maml:name>ProgressBar</maml:name>
                <maml:description>
                    <maml:para>This is a progress bar variable which was created using the New-ProgressBar cmdlet.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="true">Object[]</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>InformationAction</maml:name>
                <maml:description>
                    <maml:para />
                </maml:description>
                <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>InformationVariable</maml:name>
                <maml:description>
                    <maml:para />
                </maml:description>
                <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            </command:parameter>
        </command:syntaxItem>
    </command:syntax>
    <command:parameters>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0">
            <maml:name>ProgressBar</maml:name>
            <maml:description>
                <maml:para>This is a progress bar variable which was created using the New-ProgressBar cmdlet.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="true">Object[]</command:parameterValue>
            <dev:type>
                <maml:name>Object[]</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
            <maml:name>InformationAction</maml:name>
            <maml:description>
                <maml:para />
            </maml:description>
            <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue>
            <dev:type>
                <maml:name>ActionPreference</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
            <maml:name>InformationVariable</maml:name>
            <maml:description>
                <maml:para />
            </maml:description>
            <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            <dev:type>
                <maml:name>String</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
    </command:parameters>
    <command:inputTypes>
        <command:inputType>
            <dev:type>
                <maml:name></maml:name>
                <maml:uri></maml:uri>
                <maml:description/>
            </dev:type>
            <maml:description>
<maml:para />
            </maml:description>
        </command:inputType>
    </command:inputTypes>
    <command:returnValues>
        <command:returnValue>
            <dev:type>
                <maml:name></maml:name>
                <maml:uri></maml:uri>
                <maml:description/>
            </dev:type>
            <maml:description>
<maml:para />
            </maml:description>
        </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors></command:terminatingErrors>
    <command:nonTerminatingErrors></command:nonTerminatingErrors>
    <maml:alertSet>
        <maml:title></maml:title>
        <maml:alert>
            <maml:para />
        </maml:alert>
    </maml:alertSet>
    <command:examples>
    </command:examples>
    <maml:relatedLinks>
    </maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<!--Generated by PS Cmdlet Help Editor-->
    <command:details>
        <command:name>Write-ProgressBar</command:name>
        <maml:description>
            <maml:para>Used for sending progress information to an existing progress bar</maml:para>
        </maml:description>
        <maml:copyright>
            <maml:para />
        </maml:copyright>
        <command:verb>Write</command:verb>
        <command:noun>ProgressBar</command:noun>
        <dev:version />
    </command:details>
    <maml:description>
        <maml:para>Used for sending progress information to an existing progress bar this takes a progress bar object as a parameter and passes progress information to it.</maml:para>
    </maml:description>
    <command:syntax>
        <command:syntaxItem>
            <maml:name>Write-ProgressBar</maml:name>
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0">
                <maml:name>ProgressBar</maml:name>
                <maml:description>
                    <maml:para>The progress bar you are going to be writing progress into</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
            </command:parameter>
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1">
                <maml:name>Activity</maml:name>
                <maml:description>
                    <maml:para>Specifies the line of text used in the title of your progress bar window. </maml:para>
                    <maml:para>This text describes the activity whose progress is being reported.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2">
                <maml:name>PercentComplete</maml:name>
                <maml:description>
                    <maml:para>Specifies the percentage of the activity that is completed.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3">
                <maml:name>Status</maml:name>
                <maml:description>
                    <maml:para>Specifies the first line of text immediately below your progress bar. </maml:para>
                    <maml:para>This text describes current state of the activity.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4">
                <maml:name>SecondsRemaining</maml:name>
                <maml:description>
                    <maml:para>Specifies the projected number of seconds remaining until the activity is completed.</maml:para>
                    <maml:para>This will be converted into HH:MM:SS time format when rendered in your progress bar.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5">
                <maml:name>CurrentOperation</maml:name>
                <maml:description>
                    <maml:para>Specifies the third line of text below the progress bar. </maml:para>
                    <maml:para>This text describes the operation that is currently taking place.</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>InformationAction</maml:name>
                <maml:description>
                    <maml:para />
                </maml:description>
                <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>InformationVariable</maml:name>
                <maml:description>
                    <maml:para />
                </maml:description>
                <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            </command:parameter>
        </command:syntaxItem>
    </command:syntax>
    <command:parameters>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0">
            <maml:name>ProgressBar</maml:name>
            <maml:description>
                <maml:para>The progress bar you are going to be writing progress into</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
            <dev:type>
                <maml:name>Object</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1">
            <maml:name>Activity</maml:name>
            <maml:description>
                <maml:para>Specifies the line of text used in the title of your progress bar window. </maml:para>
                <maml:para>This text describes the activity whose progress is being reported.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            <dev:type>
                <maml:name>String</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2">
            <maml:name>PercentComplete</maml:name>
            <maml:description>
                <maml:para>Specifies the percentage of the activity that is completed.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
            <dev:type>
                <maml:name>Int32</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3">
            <maml:name>Status</maml:name>
            <maml:description>
                <maml:para>Specifies the first line of text immediately below your progress bar. </maml:para>
                <maml:para>This text describes current state of the activity.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            <dev:type>
                <maml:name>String</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4">
            <maml:name>SecondsRemaining</maml:name>
            <maml:description>
                <maml:para>Specifies the projected number of seconds remaining until the activity is completed.</maml:para>
                <maml:para>This will be converted into HH:MM:SS time format when rendered in your progress bar.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
            <dev:type>
                <maml:name>Int32</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5">
            <maml:name>CurrentOperation</maml:name>
            <maml:description>
                <maml:para>Specifies the third line of text below the progress bar. </maml:para>
                <maml:para>This text describes the operation that is currently taking place.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            <dev:type>
                <maml:name>String</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
            <maml:name>InformationAction</maml:name>
            <maml:description>
                <maml:para />
            </maml:description>
            <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue>
            <dev:type>
                <maml:name>ActionPreference</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
            <maml:name>InformationVariable</maml:name>
            <maml:description>
                <maml:para />
            </maml:description>
            <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            <dev:type>
                <maml:name>String</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
    </command:parameters>
    <command:inputTypes>
        <command:inputType>
            <dev:type>
                <maml:name></maml:name>
                <maml:uri></maml:uri>
                <maml:description/>
            </dev:type>
            <maml:description>
<maml:para />
            </maml:description>
        </command:inputType>
    </command:inputTypes>
    <command:returnValues>
        <command:returnValue>
            <dev:type>
                <maml:name></maml:name>
                <maml:uri></maml:uri>
                <maml:description/>
            </dev:type>
            <maml:description>
<maml:para />
            </maml:description>
        </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors></command:terminatingErrors>
    <command:nonTerminatingErrors></command:nonTerminatingErrors>
    <maml:alertSet>
        <maml:title></maml:title>
        <maml:alert>
            <maml:para />
        </maml:alert>
    </maml:alertSet>
    <command:examples>
        <command:example>
            <maml:title>-------------------------- Simple percentage --------------------------</maml:title>
            <maml:introduction>
                <maml:paragraph>PS C:\&gt;</maml:paragraph>
            </maml:introduction>
            <dev:code>$ProgressBar = New-ProgressBar
 
1..100 | foreach {
 
    Write-ProgressBar -ProgressBar $ProgressBar -PercentComplete $_
    Start-Sleep -Milliseconds 20
}
 
Close-ProgressBar $ProgressBar</dev:code>
            <dev:remarks>
                <maml:para>This command displays the progress of a For loop that counts from 1 to 100.</maml:para>
                <maml:para />
                <maml:para />
                <maml:para></maml:para>
            </dev:remarks>
            <command:commandLines>
                <command:commandLine>
                    <command:commandText>
                        <maml:para />
                    </command:commandText>
                </command:commandLine>
            </command:commandLines>
        </command:example>
        <command:example>
            <maml:title>-------------------------- Adding the details --------------------------</maml:title>
            <maml:introduction>
                <maml:paragraph>PS C:\&gt;</maml:paragraph>
            </maml:introduction>
            <dev:code>$ProgressBar = New-ProgressBar -MaterialDesign
 
1..100 | foreach {
 
    Write-ProgressBar -ProgressBar $ProgressBar `
                        -Activity &quot;Counting to 100&quot; `
                        -PercentComplete $_ `
                        -Status &quot;Currently couting $_ out of 100&quot; `
                        -CurrentOperation &quot;$_&quot; `
                        -SecondsRemaining ( ( 200 * ( 100 - $_ ) ) / 1000 )
 
    Start-Sleep -Milliseconds 200
 
}
 
Close-ProgressBar $ProgressBar</dev:code>
            <dev:remarks>
                <maml:para>This will create a new progress bar count from 1 to 100 pause for 100 milliseconds before continuing and report on the progress of it.</maml:para>
                <maml:para />
                <maml:para />
                <maml:para></maml:para>
            </dev:remarks>
            <command:commandLines>
                <command:commandLine>
                    <command:commandText>
                        <maml:para />
                    </command:commandText>
                </command:commandLine>
            </command:commandLines>
        </command:example>
    </command:examples>
    <maml:relatedLinks>
        <maml:navigationLink>
            <maml:linkText></maml:linkText>
            <maml:uri></maml:uri>
        </maml:navigationLink>
    </maml:relatedLinks>
</command:command>
</helpItems>