Class SelectAction

Namespace

NMF.Glsp.Protocol.Selection

Assembly

NMF.Glsp.dll

Triggered when the user changes the selection, e.g. by clicking on a selectable element. The action should trigger a change in the selected state accordingly, so the elements can be rendered differently. The server can send such an action to the client in order to change the selection remotely.

public class SelectAction : ExecutableAction

Inheritance

object

BaseAction

ExecutableAction

SelectAction

Inherited Members

ExecutableAction.RequireTransaction()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

SelectActionKind

The kind value used for this kind of action

public const string SelectActionKind = "elementSelected"

Field Value

string

Properties

DeselectAll

Whether all currently selected elements should be deselected.

public bool? DeselectAll { get; set; }

Property Value

bool?

DeselectedElementsIDs

The identifier of the elements to mark as not selected.

public string[] DeselectedElementsIDs { get; set; }

Property Value

string[]

Kind

Unique identifier specifying the kind of action to process.

public override string Kind { get; }

Property Value

string

SelectedElementsIDs

The identifier of the elements to mark as selected.

public string[] SelectedElementsIDs { get; set; }

Property Value

string[]

Methods

ExecuteAsync(IGlspSession)

Executes the action in the context of the given session

public override Task ExecuteAsync(IGlspSession session)

Parameters

session IGlspSession

The session in which to execute the action

Returns

Task