Table of Contents

Class AddActionWithCustomComponentParameters

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

Parameters wrapper class for AddActionWithCustomComponent(IList<ActionConfiguration>, AddActionWithCustomComponentParameters) method.

public record AddActionWithCustomComponentParameters
Inheritance
object
AddActionWithCustomComponentParameters
Extension Methods

Constructors

AddActionWithCustomComponentParameters(AddActionWithCustomComponentParameters) 

protected AddActionWithCustomComponentParameters(AddActionWithCustomComponentParameters original)

Parameters

original AddActionWithCustomComponentParameters

AddActionWithCustomComponentParameters(string, IActionComponent)

Initializes a new instance of the AddActionWithCustomComponentParameters record.

public AddActionWithCustomComponentParameters(string label, IActionComponent actionComponent)

Parameters

label string
actionComponent IActionComponent

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.

ClientComponent

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

public IActionComponent ClientComponent { get; }

Property Value

IActionComponent

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.

Disabled

Disabled action indication.

public bool Disabled { get; init; }

Property Value

bool

Remarks

Actions with custom component requires to set this flag when no sufficient permissions are met. Permissions are not automatically checked by used commands as they are part of component implementation. 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(AddActionWithCustomComponentParameters?) 

public virtual bool Equals(AddActionWithCustomComponentParameters? other)

Parameters

other AddActionWithCustomComponentParameters

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 ==(AddActionWithCustomComponentParameters?, AddActionWithCustomComponentParameters?) 

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

Parameters

left AddActionWithCustomComponentParameters
right AddActionWithCustomComponentParameters

Returns

bool

operator !=(AddActionWithCustomComponentParameters?, AddActionWithCustomComponentParameters?) 

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

Parameters

left AddActionWithCustomComponentParameters
right AddActionWithCustomComponentParameters

Returns

bool