Interface IProgress

Provides methods to create and manage an object which can represent progress of the project analysis process.

Namespace: Unity.ProjectAuditor.Editor

Assembly: Unity.ProjectAuditor.Editor.dll

Syntax

public interface IProgress

Properties

IsCancelled

Checks if the progress operation has been cancelled.

Declaration

bool IsCancelled { get; }

Property Value

Type	Description
bool	True if cancelled, otherwise false.

Methods

Advance(string)

Advances the progress object by one step.

Declaration

void Advance(string description = "")

Parameters

Type	Name	Description
string	description	Updated message

Clear()

Clear and hide the progress object.

Declaration

void Clear()

Start(string, string, int)

Initializes the progress object.

Declaration

void Start(string title, string description, int total)

Parameters

Type	Name	Description
string	title	Title
string	description	Description
int	total	Number of steps