Class WorkflowDefinitionInstanceDataSource

DataSource control for WorkflowDefinitionInstance

Inheritance

System.Object

WorkflowDefinitionInstanceDataSource

Namespace: EPiServer.WorkflowFoundation.WebControls

Assembly: EPiServer.WorkflowFoundation.dll

Version: 8.11.0

Syntax

public class WorkflowDefinitionInstanceDataSource : GenericDataSource<WorkflowDefinitionInstance, List<WorkflowDefinitionInstance>, Guid>

Constructors

WorkflowDefinitionInstanceDataSource()

Declaration

public WorkflowDefinitionInstanceDataSource()

Fields

CountChanged

Fired when count of fetched data changes

Declaration

public EventHandler<EventArgs> CountChanged

Field Value

Type	Description
System.EventHandler<System.EventArgs>

InstanceDeleted

Fired when an instance is deleted

Declaration

public EventHandler<InstanceDeletedArgs> InstanceDeleted

Field Value

Type	Description
System.EventHandler<InstanceDeletedArgs>

Properties

CanInsert

Gets a value indicating whether this instance can insert.

Declaration

protected override bool CanInsert { get; }

Property Value

Type	Description
System.Boolean	false

CanUpdate

Gets a value indicating whether this instance can update.

Declaration

protected override bool CanUpdate { get; }

Property Value

Type	Description
System.Boolean	false

Count

Gets the number of items fetched

Declaration

public int Count { get; }

Property Value

Type	Description
System.Int32	The count.

InstanceId

Gets or sets the instance id if a specific instance is wanted

Declaration

public Guid InstanceId { get; set; }

Property Value

Type	Description
System.Guid	The instance id.

KeyName

Gets the name of the key.

Declaration

protected override string KeyName { get; }

Property Value

Type	Description
System.String	InstanceId

PageLink

Gets or sets the page link if instances for a specific page is wanted

Declaration

public PageReference PageLink { get; set; }

Property Value

Type	Description
PageReference	The page link.

RequiredAccess

Gets or sets the required access to use when listing instances

Declaration

public AccessLevel RequiredAccess { get; set; }

Property Value

Type	Description
AccessLevel	The required access.

WorkflowDefinitionId

Gets or sets the workflow definition id if instances for a specific definition is wanted

Declaration

public Guid WorkflowDefinitionId { get; set; }

Property Value

Type	Description
System.Guid	The workflow definition id.

WorkflowTypeFullName

Gets or sets the full name of the workflow type if instances for a specific compiled type is wanted

Declaration

public string WorkflowTypeFullName { get; set; }

Property Value

Type	Description
System.String	The full name of the workflow type.

Remarks

Should be the fully qualified name including assembly

Methods

CreateItem(List<WorkflowDefinitionInstance>)

Creates the item. Not implemented

Declaration

protected override WorkflowDefinitionInstance CreateItem(List<WorkflowDefinitionInstance> items)

Parameters

Type	Name	Description
System.Collections.Generic.List<WorkflowDefinitionInstance>	items	The items.

Returns

Type	Description
WorkflowDefinitionInstance

Delete(IDictionary)

Deletes the specified values.

Declaration

public override int Delete(IDictionary values)

Parameters

Type	Name	Description
System.Collections.IDictionary	values	The values.

Returns

Type	Description
System.Int32

DeleteItem(WorkflowDefinitionInstance)

Deletes the item.

Declaration

protected override void DeleteItem(WorkflowDefinitionInstance item)

Parameters

Type	Name	Description
WorkflowDefinitionInstance	item	The item.

IsValid(WorkflowDefinitionInstance, ref String)

Determines whether the specified item is valid.

Declaration

protected override bool IsValid(WorkflowDefinitionInstance item, ref string message)

Parameters

Type	Name	Description
WorkflowDefinitionInstance	item	The item.
System.String	message	The message.

Returns

Type	Description
System.Boolean	`true` if the specified item is valid; otherwise, `false`.

ListItems()

Lists the items.

Declaration

protected override List<WorkflowDefinitionInstance> ListItems()

Returns

Type	Description
System.Collections.Generic.List<WorkflowDefinitionInstance>

ListLoadedItems()

Lists the loaded items.

Declaration

public List<WorkflowDefinitionInstance> ListLoadedItems()

Returns

Type	Description
System.Collections.Generic.List<WorkflowDefinitionInstance>

LoadItem(Guid)

Loads the item.

Declaration

protected override WorkflowDefinitionInstance LoadItem(Guid key)

Parameters

Type	Name	Description
System.Guid	key	The key.

Returns

Type	Description
WorkflowDefinitionInstance

SaveItem(WorkflowDefinitionInstance)

Saves the item. Not implemented

Declaration

protected override void SaveItem(WorkflowDefinitionInstance item)

Parameters

Type	Name	Description
WorkflowDefinitionInstance	item	The item.