Application.BeginProgress Method (String, String)

Provides an instance of the Progress class which starts reporting of progress of an operation, typically displaying a progress bar or dialog to the end user.

Namespace: Autodesk.Navisworks.Api
Assembly: Autodesk.Navisworks.Api (in Autodesk.Navisworks.Api.dll)

Syntax

Visual Basic
Public Shared Function BeginProgress ( _
	title As String, _
	message As String _
) As Progress
C#
public static Progress BeginProgress(
	string title,
	string message
)
Visual C++
public:
static Progress^ BeginProgress(
	String^ title, 
	String^ message
)

Parameters

title
Type: System..::..String
Title for the overall progress operation (title for Navisworks progress dialog)
message
Type: System..::..String
Message describing the current operation (body of Navisworks progress dialog)

Remarks

Returns a Progress object which can be used to update the user as to how far a process has run.

Examples

CopyUsing a Progress object
/// <summary>
/// Shows the basic concept of using the Progress class
/// </summary>
private static void SimpleProgressExample()
{
   //first get reference to an instance of the Progress class
   Progress progress = Autodesk.Navisworks.Api.Application.BeginProgress();

   double stage;

   for (stage = 0.0; stage < 1.0; stage += 0.1)
   {
      //Update progress bar
      progress.Update(stage);

      //Do something for a period of time
      System.Threading.Thread.Sleep(1000);
   }

   //Update progress bar to 100%
   progress.Update(1.0);

   //notify the API that the operation has finished
   Autodesk.Navisworks.Api.Application.EndProgress();
}

See Also

M:Autodesk.Navisworks.Api.Application.BeginProgress(System.String,System.String)