ISuggestedAction Interface

Definition

Important

This API is not CLS-compliant.

A possible action suggested to be performed. Examples of such suggested actions include quick fixes for syntax errors, suggestions aimed on improving code quality or refactorings. Suggested actions are provided by ISuggestedActionsSource instances and represented by a LightBulb presenter as menu items in a LightBulb dropdown menu.

public interface class ISuggestedAction : IDisposable, Microsoft::VisualStudio::Utilities::ITelemetryIdProvider<Guid>
[System.CLSCompliant(false)]
public interface ISuggestedAction : IDisposable, Microsoft.VisualStudio.Utilities.ITelemetryIdProvider<Guid>
[<System.CLSCompliant(false)>]
type ISuggestedAction = interface
    interface IDisposable
    interface ITelemetryIdProvider<Guid>
Public Interface ISuggestedAction
Implements IDisposable, ITelemetryIdProvider(Of Guid)
Derived
Attributes
Implements

Properties

DisplayText

Gets the localized text representing the suggested action.

HasActionSets

Gets whether this action has nested suggested action sets.

HasPreview

Gets whether this suggested action can provide a preview via GetPreviewAsync(CancellationToken) method call.

IconAutomationText

Gets the text to be used as the automation name for the icon when it's displayed.

IconMoniker

Gets an optional icon representing the suggested action or null if this suggested action doesn't have an icon.

InputGestureText

Gets the text describing an input gesture that will apply the suggested action.

Methods

GetActionSetsAsync(CancellationToken)

Gets a list of nested sets of suggested actions.

GetPreviewAsync(CancellationToken)

Gets an object visually representing a preview of the suggested action.

Invoke(CancellationToken)

Invokes the suggested action.

TryGetTelemetryId(TId)

Tries to get a unique ID for telemetry purposes.

(Inherited from ITelemetryIdProvider<TId>)

Applies to