Class WorkspaceTableActionConfigurationExtensions

Namespace

Kentico.Xperience.Admin.Base

Assembly

Kentico.Xperience.Admin.Base.dll

Contains extension methods for workspace action configuration.

public static class WorkspaceTableActionConfigurationExtensions

Inheritance

object

WorkspaceTableActionConfigurationExtensions

Methods

AddActionWithCustomComponent(IList<ActionConfiguration>, AddActionWithCustomComponentWorkflowParameters)

Adds custom component action under specific workspace.

public static IList<ActionConfiguration> AddActionWithCustomComponent(this IList<ActionConfiguration> configuration, AddActionWithCustomComponentWorkflowParameters addActionWithCustomComponentWorkflowParameters)

Parameters

configuration IList<ActionConfiguration>

Action configuration.

addActionWithCustomComponentWorkflowParameters AddActionWithCustomComponentWorkflowParameters

Action parameters.

Returns

IList<ActionConfiguration>

AddActionWithCustomComponent(IList<ActionConfiguration>, IActionComponent, string, ActionWorkspaceProperties, string, string, bool, bool, Action<ActionConfiguration, IDataContainer>)

Adds custom component action under specific workspace.

public static IList<ActionConfiguration> AddActionWithCustomComponent(this IList<ActionConfiguration> configuration, IActionComponent clientComponent, string label, ActionWorkspaceProperties actionWorkspaceProperties, string icon = null, string title = null, bool destructive = false, bool disabled = false, Action<ActionConfiguration, IDataContainer> actionStateEvaluator = null)

Parameters

configuration IList<ActionConfiguration>

Action configuration.

clientComponent IActionComponent

Name of the component to be used. This name is connected with suffix "Component" when loading corresponding frontend component.

label string

Action label.

actionWorkspaceProperties ActionWorkspaceProperties

Action properties for a workspace.

icon string

Action icon.

title string

Text of the tooltip.

destructive bool

Destructive action indication.

disabled bool

Disabled action.

actionStateEvaluator Action<ActionConfiguration, IDataContainer>

Action used for table action state evaluation per each row.

Returns

IList<ActionConfiguration>

AddCommand(IList<ActionConfiguration>, AddCommandWorkspaceParameters)

Adds command action under specific workspace.

public static IList<ActionConfiguration> AddCommand(this IList<ActionConfiguration> configuration, AddCommandWorkspaceParameters addCommandParameters)

Parameters

configuration IList<ActionConfiguration>

Configuration.

addCommandParameters AddCommandWorkspaceParameters

Action parameters.

Returns

IList<ActionConfiguration>

AddCommand(IList<ActionConfiguration>, string, string, ActionWorkspaceProperties, string, string, string, string, bool, Action<ActionConfiguration, IDataContainer>, ComponentContent, Type)

Adds command action under specific workspace.

public static IList<ActionConfiguration> AddCommand(this IList<ActionConfiguration> configuration, string commandName, string label, ActionWorkspaceProperties actionWorkspaceProperties, string icon = null, string confirmation = null, string confirmationButton = null, string title = null, bool destructive = false, Action<ActionConfiguration, IDataContainer> actionStateEvaluator = null, ComponentContent confirmationContent = null, Type confirmationModel = null)

Parameters

configuration IList<ActionConfiguration>

Configuration.

commandName string

Command name.

label string

Label.

actionWorkspaceProperties ActionWorkspaceProperties

Action properties for a workspace.

icon string

Icon.

confirmation string

Confirmation title.

confirmationButton string

Text of the confirmation button.

title string

Text of the tooltip.

destructive bool

Destructive action indication.

actionStateEvaluator Action<ActionConfiguration, IDataContainer>

Action used for table action state evaluation per each row.

confirmationContent ComponentContent

Content of the confirmation dialog.

confirmationModel Type

Model of form shown in confirmation dialog.

Returns

IList<ActionConfiguration>

AddCommandWithConfirmation(IList<ActionConfiguration>, string, string, ActionWorkspaceProperties, string, string, string, string, string, bool, Action<ActionConfiguration, IDataContainer>, ComponentContent, Type)

Adds command action with confirmation dialog under specific workspace.

public static IList<ActionConfiguration> AddCommandWithConfirmation(this IList<ActionConfiguration> configuration, string commandName, string label, ActionWorkspaceProperties actionWorkspaceProperties, string confirmation, string confirmationButton, string confirmationDetail = null, string icon = null, string title = null, bool destructive = false, Action<ActionConfiguration, IDataContainer> actionStateEvaluator = null, ComponentContent confirmationContent = null, Type confirmationModel = null)

Parameters

configuration IList<ActionConfiguration>

Configuration.

commandName string

Command name.

label string

Label.

actionWorkspaceProperties ActionWorkspaceProperties

Action properties for a workspace.

confirmation string

Confirmation title.

confirmationButton string

Text of the confirmation button.

confirmationDetail string

Confirmation text.

icon string

Icon.

title string

Text of the tooltip.

destructive bool

Destructive action indication.

actionStateEvaluator Action<ActionConfiguration, IDataContainer>

Action used for table action state evaluation per each row.

confirmationContent ComponentContent

Confirmation content.

confirmationModel Type

Model of form shown in confirmation dialog.

Returns

IList<ActionConfiguration>

AddDeleteAction(IList<ActionConfiguration>, AddDeleteActionWorkspaceParameters)

Adds a delete table action under specific workspace.

public static IList<ActionConfiguration> AddDeleteAction(this IList<ActionConfiguration> configuration, AddDeleteActionWorkspaceParameters addDeleteActionParameters)

Parameters

configuration IList<ActionConfiguration>

Action configuration.

addDeleteActionParameters AddDeleteActionWorkspaceParameters

Action parameters.

Returns

IList<ActionConfiguration>

AddDeleteAction(IList<ActionConfiguration>, string, ActionWorkspaceProperties, string, Action<ActionConfiguration, IDataContainer>, string)

Adds a delete table action under specific workspace.

public static IList<ActionConfiguration> AddDeleteAction(this IList<ActionConfiguration> configuration, string commandName, ActionWorkspaceProperties actionWorkspaceProperties, string label = null, Action<ActionConfiguration, IDataContainer> actionStateEvaluator = null, string title = null)

Parameters

configuration IList<ActionConfiguration>

Action configuration.

commandName string

Command name.

actionWorkspaceProperties ActionWorkspaceProperties

Action properties for a workspace.

label string

Command label.

actionStateEvaluator Action<ActionConfiguration, IDataContainer>

Action used for table action state evaluation per each row.

title string

Command title for tooltip.

Returns

IList<ActionConfiguration>

AddLink<TPage>(IList<ActionConfiguration>, int, AddLinkParameters)

Adds link action for a page under specific workspace.

public static IList<ActionConfiguration> AddLink<TPage>(this IList<ActionConfiguration> configuration, int workspaceId, AddLinkParameters addLinkParameters)

Parameters

configuration IList<ActionConfiguration>

Configuration.

workspaceId int

Workspace ID.

addLinkParameters AddLinkParameters

Action parameters.

Returns

IList<ActionConfiguration>

Type Parameters

TPage

AddLink<TPage>(IList<ActionConfiguration>, string, int, string, string, string, string, Action<ActionConfiguration, IDataContainer>, PageParameterValues)

Adds link action for a page under specific workspace.

public static IList<ActionConfiguration> AddLink<TPage>(this IList<ActionConfiguration> configuration, string label, int workspaceId, string icon = null, string confirmation = null, string confirmationButton = null, string title = null, Action<ActionConfiguration, IDataContainer> actionStateEvaluator = null, PageParameterValues parameters = null)

Parameters

configuration IList<ActionConfiguration>

Configuration.

label string

Label.

workspaceId int

Workspace ID.

icon string

Icon.

confirmation string

Confirmation title.

confirmationButton string

Confirmation button text.

title string

Text of the tooltip.

actionStateEvaluator Action<ActionConfiguration, IDataContainer>

Action used for table action state evaluation per each row.

parameters PageParameterValues

Parameter values to be substituted into the URL.

Returns

IList<ActionConfiguration>

Type Parameters

TPage