IArrayItemCommand Interface

Definition

Namespace:

Microsoft.VisualStudio.Utilities.UnifiedSettings

Assembly:

Microsoft.VisualStudio.Utilities.dll

Package:

Microsoft.VisualStudio.Utilities v17.12.40391

public interface IArrayItemCommand

type IArrayItemCommand = interface

Public Interface IArrayItemCommand

Properties

DefaultActionPriority	Double-clicking or pressing Enter on an array item will invoke the enabled command with the lowest DefaultActionPriority that is >= 0. For example, if you proffer "Run" and "Edit" array item commands, and you want double-clicking to invoke the Run command for items that enable it, but otherwise invoke the Edit command, you could define Run to have DefaultActionPriority 0 and Edit to have DefaultActionPriority 1. Return -1 for commands that should never be default-invokable. Note that if built-in actions like "Edit" are present, they may take priority over custom actions. (Built-in actions can be hidden via registration.)
Description	Gets an optional localized description of the command. This may be displayed in a tooltip.
Title	Gets a localized string representing the command. This should be short, like "Open" or "Apply".

Methods

Invoke(IDictionary<String,Object>)	Invokes the command on the item represented by arrayItemContent. Each key in arrayItemContent matches a property defined in the array setting, and the corresponding value is the current value of that property. This will always be invoked on the main thread.
IsEnabledAsync(IDictionary<String,Object>, CancellationToken)	Computes whether the command should be enabled for the item represented by arrayItemContent. Each key in arrayItemContent matches a property defined in the array setting, and the corresponding value is the current value of that property.