SAP Business One UI API 10.0 - Objects Reference (10.00.270)

• CreateProgressBar Method

  • UI API

  • • Description

      Creates a progress bar in the status bar.

  • • Syntax

      Visual Basic
      Public Function CreateProgressBar( _    ByVal Text As String, _    ByVal Maximum As Long, _    ByVal Stoppable As Boolean _ ) As ProgressBar

  • • Parameters

      Text

      The title of the progress bar, which appears above the progress bar.

      Maximum

      A long integer specifying the maximum number of steps in the progress bar display.

      Stoppable

      Indicates whether a Stop button is displayed to enable the end user to stop the progress bar.

  • • Return Type

      HRESULT = error code:

      • S_OK - the progress bar was created.
      • (-7300) - the progress bar is already taken by another.

  • • Remarks

      The title can be changed with ProgressBar.Text, for example, to update the progress percentage.

  • • See Also

      StatusBar Object  | Progress Bar Object