Function Reference

Abort

Checks to see if the user has requested to abort the current operation.

Syntax:

wwprogress:Abort()

Returns:

bool: True if abort requested, false otherwise.

Cancel

Forces an abort to ocurr with Cancel as reason.

Syntax:

wwprogress:Cancel()

End

End the current progress step.

Syntax:

wwprogress:End()

Example:

<xsl:variable name="VarProgressEnd" select="wwprogress:End()" />

QueueAlert

Queue an alert to display.

Syntax:

wwprogress:QueueAlert($message)

Parameters:

Example:

<xsl:variable name="VarAlert" select="wwprogress:QueueAlert('Processing complete!')" />

Retry

Forces an abort to ocurr with Retry as reason.

Syntax:

wwprogress:Retry()

SetStatus

Set the status bar for the current progress step.

Syntax:

wwprogress:SetStatus($message)

Parameters:

Example:

<xsl:variable name="VarParagraphCount" select="count($VarParagraphs)" />
<xsl:variable name = "VarProgressParagraphsStart" select="wwprogress:Start($VarParagraphCount)" />
<xsl:variable name = "VarProgressParagraphsStatus" select="wwprogress:SetStatus(concat('Processing ', $VarParagraphCount))" />
<xsl:for-each select = "$VarParagraphs" >
< xsl:variable name = "VarParagraph" select="." />

<xsl:variable name = "VarProgressParagraphStart" select="wwprogress:Start(1)" />

<xsl:variable name = "VarProgressParagraphStatus" select="wwprogress:SetStatus('Processing paragraph ', position(), ' of ', $VarParagraphCount, '.'))" />

<xsl:variable name = "VarProgressParagraphEnd" select="wwprogress:End()" />
</xsl:for-each>
<xsl:variable name = "VarProgressParagraphsEnd" select="wwprogress:End()" />

Start

Create a new progress step with the given number of sub-steps.

Syntax:

wwprogress:Start($totalSubSteps)

Parameters:

Example:

<xsl:variable name="VarProgressTotalStart" select="wwprogress:Start(2)" />

<xsl:variable name = "VarProgressStep1Start" select="wwprogress:Start(1)" />
<xsl:variable name = "VarProgressStep1End" select="wwprogress:End()" />

<xsl:variable name = "VarProgressStep2Start" select="wwprogress:Start(1)" />
<xsl:variable name = "VarProgressStep2End" select="wwprogress:End()" />

<xsl:variable name = "VarProgressTotalEnd" select="wwprogress:End()" />