Table of Contents

Class AddCommandWorkspaceParameters

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

Parameters wrapper class for AddCommand(IList<ActionConfiguration>, AddCommandWorkspaceParameters) method.

public record AddCommandWorkspaceParameters
Inheritance
object
AddCommandWorkspaceParameters
Extension Methods

Constructors

AddCommandWorkspaceParameters(AddCommandWorkspaceParameters) 

protected AddCommandWorkspaceParameters(AddCommandWorkspaceParameters original)

Parameters

original AddCommandWorkspaceParameters

AddCommandWorkspaceParameters(string, string, ActionWorkspaceProperties)

Initializes a new instance of the AddCommandWorkspaceParameters record.

public AddCommandWorkspaceParameters(string commandName, string label, ActionWorkspaceProperties actionWorkspaceProperties)

Parameters

commandName string
label string
actionWorkspaceProperties ActionWorkspaceProperties

Properties

ActionStateEvaluator

Action used for state evaluation per each row.

public Func<ActionConfiguration, IDataContainer, CancellationToken, Task> ActionStateEvaluator { get; init; }

Property Value

Func<ActionConfiguration, IDataContainer, CancellationToken, Task>

Remarks

Please use Task.CompletedTask when no async action is necessary.

ActionWorkspaceProperties

Action workspace properties.

public ActionWorkspaceProperties ActionWorkspaceProperties { get; }

Property Value

ActionWorkspaceProperties

CommandName

Unique action name.

public string CommandName { get; }

Property Value

string

ConfirmationParameters

Confirmation dialog parameters.

public ConfirmationWithContentParameters ConfirmationParameters { get; init; }

Property Value

ConfirmationWithContentParameters

Destructive

Indicates whether action is destructive.

public bool Destructive { get; init; }

Property Value

bool

Remarks

Destructive action is indicated by highlighted icon. By default set to false.

EqualityContract 

protected virtual Type EqualityContract { get; }

Property Value

Type

Icon

Icon of the action.

public string Icon { get; init; }

Property Value

string

Label

Label of the action.

public string Label { get; }

Property Value

string

Title

Gets or sets the tooltip of a button.

public string Title { get; init; }

Property Value

string

Methods

Equals(AddCommandWorkspaceParameters?) 

public virtual bool Equals(AddCommandWorkspaceParameters? other)

Parameters

other AddCommandWorkspaceParameters

Returns

bool

Equals(object?) 

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode() 

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder) 

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString() 

public override string ToString()

Returns

string

Operators

operator ==(AddCommandWorkspaceParameters?, AddCommandWorkspaceParameters?) 

public static bool operator ==(AddCommandWorkspaceParameters? left, AddCommandWorkspaceParameters? right)

Parameters

left AddCommandWorkspaceParameters
right AddCommandWorkspaceParameters

Returns

bool

operator !=(AddCommandWorkspaceParameters?, AddCommandWorkspaceParameters?) 

public static bool operator !=(AddCommandWorkspaceParameters? left, AddCommandWorkspaceParameters? right)

Parameters

left AddCommandWorkspaceParameters
right AddCommandWorkspaceParameters

Returns

bool