Table of Contents

Class ContentItemAction

Namespace
Kentico.Xperience.Admin.Base
Assembly
Kentico.Xperience.Admin.Base.dll

Represents an action for a content item.

public sealed class ContentItemAction : IContentItemAction
Inheritance
object
ContentItemAction
Implements
Extension Methods

Properties

Actions

Page actions displayed as dropdown menu under current action.

public IReadOnlyCollection<IContentItemAction> Actions { get; init; }

Property Value

IReadOnlyCollection<IContentItemAction>

Remarks

If any actions are added current action is displayed as button with dropdown menu and doesn't execute any action itself.

ButtonColor

Determines the action button style.

public ButtonColor ButtonColor { get; set; }

Property Value

ButtonColor

Remarks

Ignored when action is rendered in dropdown menu created from Actions.

Confirmation

Confirmation for the action.

public ContentItemActionConfirmation Confirmation { get; init; }

Property Value

ContentItemActionConfirmation

Remarks

Ignored when the action is rendered as button with dropdown menu containing Actions.

Disabled

Determines whether the button is disabled or not.

public bool Disabled { get; set; }

Property Value

bool

Icon

Icon of the action.

public string Icon { get; set; }

Property Value

string

IsDestructive

Indicates if the action is destructive.

public bool IsDestructive { get; init; }

Property Value

bool

IsDropdown

Indicates if the action is displayed in dropdown.

public bool IsDropdown { get; init; }

Property Value

bool

IsFormChangeRequiredToExecute

Indicates that the action cannot be executed without unsaved changes on a page.

public bool IsFormChangeRequiredToExecute { get; init; }

Property Value

bool

IsPrimary

Determines if the action button is primary.

[Obsolete("Member is deprecated and will be removed in the next version. Use ContentItemAction.ButtonColor instead.")]
[ObsoleteSince(28, 1)]
public bool IsPrimary { get; set; }

Property Value

bool

Remarks

Ignored when action is rendered in dropdown menu created from Actions.

IsSplitButton

Indicates if the action is displayed as split button with dropdown.

public bool IsSplitButton { get; init; }

Property Value

bool

Remarks

Used in combination with Actions. Enables a button which can perform an action and contains a dropdown at the same time.

Label

Label of the action.

public string Label { get; init; }

Property Value

string

Name

Unique action name.

public string Name { get; init; }

Property Value

string

Remarks

Executes the command with the same name.

Permission

Permission that will be checked to determine whether the user has the permission to execute the action.

public string Permission { get; init; }

Property Value

string

Tooltip

The tooltip for the action.

public string Tooltip { get; set; }

Property Value

string

Url

Url to navigate to when the action is clicked.

public string Url { get; set; }

Property Value

string

UseFormSubmit

If true form submit will be performed before executing command.

public bool UseFormSubmit { get; init; }

Property Value

bool

Remarks

Ignored when the action is rendered as button with dropdown menu containing Actions.