Table of Contents

Interface IViewModelAction

Namespace
GroupeIsa.Neos.Designer.UIAbstractions
Assembly
GroupeIsa.Neos.Designer.UIAbstractions.dll

Represents the MVVM ViewModel of an UIView Action.

public interface IViewModelAction

Properties

ActionType

Gets or sets the type of the action.

ActionType ActionType { get; set; }

Property Value

ActionType

Badge

Gets the badge of the action.

string Badge { get; }

Property Value

string

BadgeSeverity

Gets or sets the badge severity of the action.

ActionBadgeSeverity BadgeSeverity { get; set; }

Property Value

ActionBadgeSeverity

BeginGroup

Gets or sets a value indicating whether the action starts a group.

bool BeginGroup { get; set; }

Property Value

bool

Caption

Gets or sets the caption of the action.

string Caption { get; set; }

Property Value

string

DatagridContextMenuPosition

Gets or sets the datagrid context menu position.

[Obsolete("Use Locations property instead.")]
int? DatagridContextMenuPosition { get; set; }

Property Value

int?

Description

Gets or sets the description of the action.

string Description { get; set; }

Property Value

string

DisplayMode

Gets or sets the display mode of the action.

ActionDisplayMode DisplayMode { get; set; }

Property Value

ActionDisplayMode

Group

Gets or sets the group (panel location only).

string? Group { get; set; }

Property Value

string

IconId

Gets or sets the icon id of the action.

ImageId? IconId { get; set; }

Property Value

ImageId

IconName

Gets or sets the icon name of the action.

string? IconName { get; set; }

Property Value

string

KeyboardShortcut

Gets or sets the keyboard shortcut.

string? KeyboardShortcut { get; set; }

Property Value

string

Location

Gets or sets the location of the action.

ActionLocation Location { get; set; }

Property Value

ActionLocation

Locations

Gets or sets the locations.

List<ActionLocationEntry> Locations { get; set; }

Property Value

List<ActionLocationEntry>

Name

Gets the name of the action.

string Name { get; }

Property Value

string

ParentActionName

Gets or sets the parent action name.

string? ParentActionName { get; set; }

Property Value

string

Position

Gets or sets the position.

int Position { get; set; }

Property Value

int

PrintSettings

Gets or sets the print settings.

string? PrintSettings { get; set; }

Property Value

string

Size

Gets or sets the size of the action.

ActionSize Size { get; set; }

Property Value

ActionSize

Style

Gets or sets the size of the action.

ActionStyle Style { get; set; }

Property Value

ActionStyle

Methods

ExecuteAsync(object?)

Executes the action, without checking GetVisible(object) or GetEnabled(object).

Task ExecuteAsync(object? item)

Parameters

item object

Item on which the action is executed, or null for an action with no target item.

Returns

Task

A task representing the asynchronous operation.

GetEnabled(object)

Gets a value indicating whether the action is enable.

bool GetEnabled(object item)

Parameters

item object

Item for which the value is obtained.

Returns

bool

Value.

GetVisible(object)

Gets a value indicating whether the action is visible.

bool GetVisible(object item)

Parameters

item object

Item for which the value is obtained.

Returns

bool

Value.