NewMonitor Method

In This Topic

Create a new monitor with the specified owning object, status, and number of steps

Syntax

Visual Basic
C#

'Declaration
 
Public Function NewMonitor( _
   ByVal owner As Object, _
   ByVal status As String, _
   ByVal maxSteps As Integer _
) As ProgressMonitor

public ProgressMonitor NewMonitor( 
   object owner,
   string status,
   int maxSteps
)

Parameters

owner: The object that is responsible for the proces being tracked (for development purposes, never displayed)
status: A short status message for the user
maxSteps: The maximum number of steps in the process being monitored

Return Value

A new monitor object which will be at the top of the stack

Remarks

While it is possible to specify zero for the number of steps, it is recommended that a guess be made for the maximum number of steps to provide the best UI experience. When in doubt, guess high and reduce later which will make the progress appear to accelerate.

Requirements

Target Platforms: 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

Reference

ProgressMonitorStack Class
ProgressMonitorStack Members

Send Feedback