Progress.Update Method

Updates progress on the current operation or sub-operation

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

Syntax

Visual Basic
Public Function Update ( _
	fractionDone As Double _
) As Boolean
C#
public bool Update(
	double fractionDone
)
Visual C++
public:
bool Update(
	double fractionDone
)

Parameters

fractionDone
Type: System..::..Double
Fraction of operation or sub-operation completed, between 0 and 1

Return Value

false if user wants to cancel operation, true if they want to continue.

Remarks

Updates the user with a percentage indicating how far a process has reached.

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();
}

Exceptions

ExceptionCondition
System..::..ObjectDisposedException Object has been Disposed
System..::..NotSupportedException Object is Read-Only
System..::..ArgumentOutOfRangeException Argument 'fractionDone' is outside the range 0 to 1

See Also

M:Autodesk.Navisworks.Api.Progress.Update(System.Double)