SyncUiTask<TBusinessObject> 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. The task is associated with a business object that is selected in the list pane of the Dashboard. The task is started from the task pane of the Dashboard.

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.SelectionTask<TBusinessObject>
Microsoft.WindowsServerSolutions.Administration.ObjectModel.SyncUiTask<TBusinessObject>

Syntax

public sealed class SyncUiTask<TBusinessObject> : SelectionTask<TBusinessObject>
where TBusinessObject : class

generic<typename TBusinessObject>
where TBusinessObject : ref class
public ref class SyncUiTask sealed : SelectionTask<TBusinessObject>

Public NotInheritable Class SyncUiTask(Of TBusinessObject As Class)
    Inherits SelectionTask(Of TBusinessObject)

Type Parameters

TBusinessObject
Represents a business object that encapsulates information and methods that relate to business data or business functionality. The information in a business object is exposed as properties.

Constructors

	Name	Description
	SyncUiTask<TBusinessObject>(String, SyncAction<TBusinessObject>)	Initializes a new instance of the SyncUiTask<TBusinessObject> class with the specified display name and the specified delegate method that performs the action for the task.

Properties

	Name	Description
	ConditionProvider	Gets or sets a Converter<TInput, TOutput> delegate method that is used to convert an instance of a business object to the TaskCondition<TBusinessObject> for the task.(Inherited from SelectionTask<TBusinessObject>.)
	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<TBusinessObject> is specific to a business object that is selected in the list pane of the Dashboard. To define a synchronous task that is not specific to an object, use SyncUiTask.

TBusinessObject represents a business object that encapsulates information and methods that relate to business data or business functionality. The information in a business object is exposed as properties.

A SyncUiTask<TBusinessObject> 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