Class ProgressFraction

Namespace

Hi.Common

Assembly

HiDisp.dll

Represents a progress report implementation. Also exposes an IMessage view (explicitly implemented) so a progress fraction can ride the unified message channel uniformly alongside SimpleMessage / NcDiagnostic: Progress + System, with Msg as the notification and Detail as the detail payload.

public class ProgressFraction : IProgressFraction, IMessage

Inheritance

object

ProgressFraction

Implements

IProgressFraction

IMessage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])

InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)

InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)

ColorUtil.GetGloomyColor(object, double, double)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Constructors

ProgressFraction(NativeProgressFraction)

Initializes a new instance of the ProgressFraction class from a native progress report.

public ProgressFraction(NativeProgressFraction src)

Parameters

src NativeProgressFraction

The native progress report source.

Properties

Denominator

Gets or sets the denominator value for progress calculation.

public int Denominator { get; set; }

Property Value

int

Detail

Gets or sets the detailed information about the progress.

public string Detail { get; set; }

Property Value

string

Msg

Gets or sets the message string.

public string Msg { get; set; }

Property Value

string

Numerator

Gets or sets the numerator value for progress calculation.

public int Numerator { get; set; }

Property Value

int

Methods

GetDenominator()

Gets the denominator value for progress calculation.

public int GetDenominator()

Returns

int

The denominator value.

GetDetail()

Gets the detailed information about the progress.

public string GetDetail()

Returns

string

The detail string.

GetMsg()

Get message.

public string GetMsg()

Returns

string

The message string.

GetNumerator()

Gets the numerator value for progress calculation.

public int GetNumerator()

Returns

int

The numerator value.