SyncUiTask Class

Article
09/23/2016

Represents a task that starts the user interface of a process and blocks the use of the Dashboard until the task is complete.

Namespace: Microsoft.WindowsServerSolutions.Administration.ObjectModel
Assembly: Microsoft.WindowsServerSolutions.Administration.ObjectModel (in Microsoft.WindowsServerSolutions.Administration.ObjectModel.dll)

Inheritance Hierarchy

System.Object
System.MarshalByRefObject
Microsoft.WindowsServerSolutions.Administration.ObjectModel.Task
Microsoft.WindowsServerSolutions.Administration.ObjectModel.SyncUiTask

Syntax

public sealed class SyncUiTask : Task

public ref class SyncUiTask sealed : Task

Public NotInheritable Class SyncUiTask
    Inherits Task

Constructors

	Name	Description
	SyncUiTask(Guid, String, SyncAction)	Initializes a new instance of the SyncUiTask class with the specified identifier, display name, and the specified delegate method that performs the action for the task.
	SyncUiTask(Guid, String, SyncAction, Boolean)	Creates a new instance of the SyncUiTask object, using the specified ID, display name, action, and global parameter.
	SyncUiTask(String, SyncAction)	Initializes a new instance of the SyncUiTask class with the specified display name and the specified delegate method that performs the action for the task.
	SyncUiTask(String, SyncAction, Boolean)	Creates a new instance of the SyncUiTask using the specified display name, action, and global flag.

Properties

	Name	Description
	ConditionProvider	Gets and sets the condition provider.
	Description	Gets or sets the description of the Task object.(Inherited from Task.)
	DisplayName	Gets the display name of the Task object.(Inherited from Task.)
	Icon	Obsolete. Gets or sets the Icon that is associated with the Task object.(Inherited from Task.)
	ID	Gets the identifier of the task.(Inherited from Task.)
	Tag	Gets or sets an object that is used to identify the Task.(Inherited from Task.)
	TaskStatus	Gets and sets the status of the current task.(Inherited from Task.)

Methods

	Name	Description
	CreateObjRef(Type)	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from Task.)
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetLifetimeService()	(Inherited from MarshalByRefObject.)
	GetType()	(Inherited from Object.)
	InitializeLifetimeService()	Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from Task.)
	ToString()	(Inherited from Object.)

Events

	Name	Description
	Completed	Represents an event that is raised when a task either successfully or unsuccessfully completes.(Inherited from Task.)
	Started	Represents an event that is raised when the task successfully starts.(Inherited from Task.)

Remarks

A task that is defined as SyncUiTask is not specific to objects listed in the list pane of the Dashboard. To define a synchronous task that is specific to an object that is selected in the Dashboard, use SyncUiTask<TBusinessObject>.

A SyncUiTask must be added to a TaskCollection to be displayed in the task pane of the Dashboard.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via