ProgressStatusEventArgs Class

    Namespace: Stride.Core.Diagnostics
    Assembly: Stride.Core.dll

    An event indicating the progress of an operation.

    System.Object → System.EventArgs → ProgressStatusEventArgs
    Derived from ProgressStatusEventArgs: 

    public class ProgressStatusEventArgs : EventArgs
    Name Description
    Constructors
    ProgressStatusEventArgs(String)

    Initializes a new instance of the ProgressStatusEventArgs class.
    ProgressStatusEventArgs(String, Int32, Int32)

    Initializes a new instance of the ProgressStatusEventArgs class.
    Properties
    CurrentStep

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

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

    Gets or sets the message associated with the progress.
    StepCount

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

    Constructors

    ProgressStatusEventArgs(String)

    Initializes a new instance of the ProgressStatusEventArgs class.

    public ProgressStatusEventArgs(string message)
    Parameters
    Type Name Description
    System.String message

    The message.

    ProgressStatusEventArgs(String, Int32, Int32)

    Initializes a new instance of the ProgressStatusEventArgs class.

    public ProgressStatusEventArgs(string message, int currentStep, int stepCount)
    Parameters
    Type Name Description
    System.String message

    The message.
    System.Int32 currentStep

    The current step.
    System.Int32 stepCount

    The step count.
    | Improve this Doc View Source

    Properties

    CurrentStep

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

    public int CurrentStep { get; }
    Property Value
    Type Description
    System.Int32

    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
    Type Description
    System.Boolean

    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
    Type Description
    System.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
    Type Description
    System.Int32

    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
    Type Condition
    System.ArgumentOutOfRangeException

    Expecting value >= 1;value

    Inherited Members

    System.EventArgs.Empty

    Extension Methods