Codeunit 5505366 M365 Status Management

Codeunit 5505366 M365 Status Management

Methods

SetTitle

procedure SetTitle(newTitle: Text)

Set a title for the dialog.

Parameters / Return Value

  • newTitle Text

    Text


AddCaption

procedure AddCaption(caption: Text)

Append a caption to the list of fields to be shown in the status dialog.

Parameters / Return Value

  • caption Text

    Text


Open

procedure Open(totalSteps: BigInteger; newRefreshingPeriodInMs: Integer): Boolean

Open a status dialog window, creating the template from the captions (AddCaption()). Also creates a template for the counter to represent totalRecords as max. The refreshing period in milliseconds can be specified, too.

Parameters / Return Value

  • totalSteps BigInteger

    BigInteger

  • newRefreshingPeriodInMs Integer

    Integer

  • Returns Boolean

    Boolean


Open

procedure Open(totalSteps: BigInteger): Boolean

Open a status dialog window, creating the template from the captions (AddCaption()). Also creates a template for the counter to represent totalRecords as max. The refreshing period is set to 2 seconds.

Parameters / Return Value

  • totalSteps BigInteger

    BigInteger

  • Returns Boolean

    Boolean


IsInitialized

procedure IsInitialized(): Boolean

Returns whether the dialog/status was initialized or not.

Parameters / Return Value

  • Returns Boolean

    Boolean


Update

procedure Update(currentStep: BigInteger): Boolean

Update and refresh the status dialog with the current counter, pass 0 if Status Management should automatically calculate the current progress. Refreshing is done on a 2 second basis, means every 2 seconds the windows is updated/refreshed. This can be changed in procedure Open().

Parameters / Return Value

  • currentStep BigInteger

    BigInteger

  • Returns Boolean

    Boolean


Update

procedure Update(): Boolean

Refresh/update the status dialog using the automatic counter.

Parameters / Return Value

  • Returns Boolean

    Boolean


Set

procedure Set(captionVariant: Variant; captionValue: Variant; newTotalSteps: BigInteger)

Set the specified caption to the passed value. captionVariant can be the caption text or the caption index. You can also pass a new value for the number of total steps.

Parameters / Return Value

  • captionVariant Variant

    Variant

  • captionValue Variant

    Variant

  • newTotalSteps BigInteger

    BigInteger


Set

procedure Set(captionVariant: Variant; captionValue: Variant)

Set the specified caption to the passed value. captionVariant can be the caption text or the caption index.

Parameters / Return Value

  • captionVariant Variant

    Variant

  • captionValue Variant

    Text


Set

procedure Set(newTotalSteps: BigInteger)

Set the new number of total steps.

Parameters / Return Value

  • newTotalSteps BigInteger

    BigInteger


Close

procedure Close()

Close a status dialog window.



EOS Labs -