FormatText Method

Returns the formatted text label for the specified object that implements IProgressBarInfo.

Syntax

Visual Basic

'Declaration
 
Public Shared Function FormatText( _
   ByVal ctrl As IProgressBarInfo, _
   ByVal label As String _
) As String

C#

public static string FormatText( 
   IProgressBarInfo ctrl,
   string label
)

Parameters

ctrl

Class used to obtain the information.

label

Label to use when formatting. If null, uses the label from the specified IProgressBarInfo.

Return Value

Formatted string based on the values of the specified IProgressBarInfo.

Remarks

The FormatText method provides a way to determine the text that is or would be displayed based on the label and data from the class implementing the IProgressBarInfo interface.

The UltraProgressBar control implements the IProgressBarInfo interface.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2