Interface IContextActionService

Interface that provides support for the context actions.

Namespace: DataWeb.Structure

Assembly: DataWeb.Core.dll

Syntax

public interface IContextActionService

Methods

GetLocalAction(string, string, ContextActionType)

Gets a local action.

Declaration

ContextAction GetLocalAction(string title, string name, ContextActionType type)

Parameters

Type	Name	Description
string	title	The title of the action.
string	name	The name of the local action.
ContextActionType	type	The ContextActionType of the action.

Returns

Type	Description
ContextAction

GetNavigationAction(string, Step, List<Step>)

Gets a navigation action.

Declaration

ContextAction GetNavigationAction(string title, ContextAction.Step currentStep, List<ContextAction.Step> newSteps)

Parameters

Type	Name	Description
string	title	The title of the action.
ContextAction.Step	currentStep	The current ContextAction.Step in the navigation context.
List<ContextAction.Step>	newSteps	The new ContextAction.Step objects to be added to the navigation context.

Returns

Type	Description
ContextAction

GetNavigationAction(string, List<Step>)

Gets a navigation action.

Declaration

ContextAction GetNavigationAction(string title, List<ContextAction.Step> newSteps)

Parameters

Type	Name	Description
string	title	The title of the action.
List<ContextAction.Step>	newSteps	The new ContextAction.Step objects to be added to the navigation context.

Returns

Type	Description
ContextAction

GetRemoteAction(string, string, ContextActionType, string, string, bool, bool, bool, bool)

Gets a remote action.

Declaration

ContextAction GetRemoteAction(string title, string name, ContextActionType type, string context = null, string dialogFormName = null, bool isConfirmRequired = false, bool isSaveItemBeforeProcess = false, bool isReloadAfterProcess = false, bool isDownloadResult = false)

Parameters

Type	Name	Description
string	title	The title of the action.
string	name	The name of the remote action.
ContextActionType	type	The ContextActionType of the action.
string	context	The context of the action.
string	dialogFormName	The name of the dialog form.
bool	isConfirmRequired	The action requires a confirmation.
bool	isSaveItemBeforeProcess	Saves the item before the action starts.
bool	isReloadAfterProcess	Reload the context after the action.
bool	isDownloadResult	The result of the action is a file.

Returns

Type	Description
ContextAction