Class ProgressStatusEventArgs

Namespace

Stride.Core.Diagnostics

Assembly

Stride.Core.dll

An event indicating the progress of an operation.

public class ProgressStatusEventArgs : EventArgs

Inheritance

object

EventArgs

ProgressStatusEventArgs

Inherited Members

EventArgs.Empty

Constructors

ProgressStatusEventArgs(string)

Initializes a new instance of the ProgressStatusEventArgs class.

public ProgressStatusEventArgs(string message)

Parameters

message string

The message.

ProgressStatusEventArgs(string, int, int)

Initializes a new instance of the ProgressStatusEventArgs class.

public ProgressStatusEventArgs(string message, int currentStep, int stepCount)

Parameters

message string

The message.

currentStep int

The current step.

stepCount int

The step count.

Properties

CurrentStep

Gets or sets the current index of the indicative step. See StepCount remarks.

public int CurrentStep { get; }

Property Value

int

The index of the step.

HasKnownSteps

Gets or sets a value indicating whether this instance has known steps (CurrentStep and StepCount are valid).

public bool HasKnownSteps { get; }

Property Value

bool

true if this instance has known steps; otherwise, false.

Message

Gets or sets the message associated with the progress.

public string Message { get; }

Property Value

string

The message.

StepCount

Gets or sets the step count used to indicate the number expected steps returned by this logger result. See remarks.

public int StepCount { get; }

Property Value

int

The step count, greater than 1. Default is 1

Remarks

This property providea an estimation of the duration of an operation in terms of "step counts". The CurrentStep property returns the current step and gives indication about how much is still being processed.

Exceptions

ArgumentOutOfRangeException

Expecting value >= 1;value