Condividi tramite

Classe CommandSet

  • Articolo

Rappresenta un sottoinsieme dei comandi disponibili nei menu di un linguaggio specifico di dominio.Override i metodi di TheLanguageCommandSet per modificare la modalità con cui questi controlli vengono elaborati.

Questa API non è conforme a CLS. 

Gerarchia di ereditarietà

System.Object
  System.MarshalByRefObject
    Microsoft.VisualStudio.Modeling.Shell.CommandSetLibrary
      Microsoft.VisualStudio.Modeling.Shell.CommandSet

Spazio dei nomi:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0.dll)

Sintassi

'Dichiarazione
<CLSCompliantAttribute(False)> _
Public MustInherit Class CommandSet _
    Inherits CommandSetLibrary

[CLSCompliantAttribute(false)]
public abstract class CommandSet : CommandSetLibrary

Il tipo CommandSet espone i seguenti membri.

Costruttori

  Nome Descrizione
Metodo protetto CommandSet Inizializza una nuova istanza di CommandSet classe.

In alto

Proprietà

  Nome Descrizione
Proprietà protetta. CurrentDocData (Ereditato da CommandSetLibrary)
Proprietà protetta. CurrentDocumentSelection (Ereditato da CommandSetLibrary)
Proprietà protetta. CurrentDocView Ottiene la visualizzazione della finestra di documento attivo.
Proprietà protetta. CurrentModelingDocView (Ereditato da CommandSetLibrary)
Proprietà protetta. CurrentSelection (Ereditato da CommandSetLibrary)
Proprietà protetta. MenuService (Ereditato da CommandSetLibrary)
Proprietà protetta. MonitorSelection (Ereditato da CommandSetLibrary)
Proprietà protetta. ServiceProvider (Ereditato da CommandSetLibrary)
Proprietà protetta. SingleDocumentSelection (Ereditato da CommandSetLibrary)
Proprietà protetta. SingleSelection (Ereditato da CommandSetLibrary)

In alto

Metodi

  Nome Descrizione
Metodo protetto CanDeleteSelectedItems Restituisce true se gli elementi selezionati possono essere eliminati. (Ereditato da CommandSetLibrary)
Metodo pubblico CreateObjRef Critico per la sicurezza. Crea un oggetto che contiene tutte le informazioni rilevanti obbligatorio per generare un proxy utilizzato per comunicare con un oggetto remoto. (Ereditato da MarshalByRefObject)
Metodo protetto DeleteSelectedItems eliminare gli elementi selezionati. (Ereditato da CommandSetLibrary)
Metodo pubblico Equals Determina se l'oggetto specificato equivale all'oggetto corrente. (Ereditato da Object)
Metodo protetto Finalize Consente a un oggetto di provare a liberare risorse ed eseguire altre operazioni di pulitura prima che l'oggetto stesso venga recuperato dalla procedura di Garbage Collection. (Ereditato da Object)
Metodo pubblico GetHashCode Funge da funzione hash per un determinato tipo. (Ereditato da Object)
Metodo pubblico GetLifetimeService Critico per la sicurezza. Recupera l'oggetto corrente del servizio di durata che controlla i criteri di durata dell'istanza. (Ereditato da MarshalByRefObject)
Metodo protetto GetMenuCommands Visualizzare i comandi del menu di scelta rapida. (Esegue l'override di CommandSetLibrary.GetMenuCommands()).
Metodo pubblico GetType Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object)
Metodo pubblico Initialize Inizializzare l'insieme di comando.Chiamate GetMenuCommands e la cache il risultato. (Ereditato da CommandSetLibrary)
Metodo pubblico InitializeLifetimeService Critico per la sicurezza. Ottiene un oggetto di servizio di durata per controllare i criteri di durata dell'istanza. (Ereditato da MarshalByRefObject)
Metodo protetto IsAnyDocumentSelectionCompartment True se qualsiasi elemento nell'elenco di selezione è un raggruppamento. (Ereditato da CommandSetLibrary)
Metodo protetto IsAnyDocumentSelectionMoveableHostShape True se qualsiasi elemento nell'elenco di selezione è una forma mobile host, che non può essere eliminato. (Ereditato da CommandSetLibrary)
Metodo protetto IsAnyDocumentSelectionUndeletable True se qualsiasi elemento di formato nell'elenco di selezione non possono essere eliminati. (Ereditato da CommandSetLibrary)
Metodo protetto IsCurrentDiagramEmpty True se il diagramma non ha figli. (Ereditato da CommandSetLibrary)
Metodo protetto IsDiagramSelected True se il diagramma viene selezionato. (Ereditato da CommandSetLibrary)
Metodo protetto IsExpandableShape Si verifica se un utente possa espandere la forma per visualizzare le proprietà del dominio.
Metodo protetto IsSingleDocumentSelection True se c " è un solo elemento selezionato nel documento attivo. (Ereditato da CommandSetLibrary)
Metodo protetto IsSingleSelection True se c " è un solo elemento selezionato nella finestra o nella finestra degli strumenti di documento attivo. (Ereditato da CommandSetLibrary)
Metodo protetto MemberwiseClone() Consente di creare una copia dei riferimenti dell'oggetto Object corrente. (Ereditato da Object)
Metodo protetto MemberwiseClone(Boolean) Crea una copia superficiale corrente MarshalByRefObject oggetto. (Ereditato da MarshalByRefObject)
Metodo protetto ProcessOnMenuDeleteCommand Chiamato quando l'utente fa clic sul comando di eliminazione o preme il tasto CANC.Rimuove un elemento.Eseguire l'override di questo metodo per modificare tale comportamento.
Metodo protetto ProcessOnMenuEditCompartmentItemCommand Chiamato quando l'utente fa clic sul comando del menu Modifica di un elemento in una forma di raggruppamento.Assume lo stato di modifica del testo.Eseguire l'override di questo metodo per modificare tale comportamento.
Metodo protetto ProcessOnMenuExpandCollapseCommand Chiamato quando l'utente espandere o comprimere un elenco di proprietà che viene assegnato a una forma.
Metodo protetto ProcessOnMenuPageSetupCommand Viene visualizzata la finestra di dialogo di installazione di pagina.Eseguire l'override di questo metodo per modificare tale comportamento.
Metodo protetto ProcessOnMenuPrintCommand Aprire la finestra di dialogo di stampa.Eseguire l'override di questo metodo per modificare tale comportamento.
Metodo protetto ProcessOnMenuPrintPreviewCommand Aprire la finestra di anteprima di stampa.Eseguire l'override di questo metodo per modificare tale comportamento.
Metodo protetto ProcessOnMenuRerouteLineCommand Ripristina il percorso predefinito di un connettore tra due forme.Eseguire l'override di questo metodo per modificare tale comportamento.
Metodo protetto ProcessOnMenuResetDecoratorLocationCommand Eseguire l'override di questo metodo per elaborare il comando di menu di posizione dell'elemento Decorator di reimpostazione.
Metodo protetto ProcessOnMenuResetDecoratorSizeCommand Eseguire l'override di questo metodo per elaborare il comando di menu di dimensione elemento Decorator di reimpostazione.
Metodo protetto ProcessOnMenuSelectAllCommand Chiamato quando l'utente fa clic sul selezionare il comando del menu Modifica, o premere Ctrl-Un.Selezionare tutte le forme in un diagramma.Eseguire l'override del metodo per modificare tale comportamento.
Metodo protetto ProcessOnStatusDeleteCommand Determina se il comando di eliminazione viene visualizzato nel menu di scelta rapida.Chiamato quando l'utente fa clic con il pulsante destro del mouse sul diagramma.
Metodo protetto ProcessOnStatusEditCompartmentItemCommand Determina se il comando di modifica nel menu di scelta rapida.
Metodo protetto ProcessOnStatusExpandCollapseCommand Determina se il comando per comprimere o di espandere viene visualizzato nel menu di scelta rapida.Chiamato quando l'utente fa clic con il pulsante destro del mouse sul diagramma.
Metodo protetto ProcessOnStatusPageSetupCommand Determina se il comando di installazione di pagina viene visualizzato nel menu File.Chiamato quando l'utente fa clic sul menu File mentre il diagramma è attivo.
Metodo protetto ProcessOnStatusPrintCommand Determina se il comando di stampa viene visualizzato nel menu File.Chiamato quando l'utente fa clic sul menu File mentre il diagramma è attivo.
Metodo protetto ProcessOnStatusPrintPreviewCommand Determina se il comando di anteprima di stampa viene visualizzato nel menu.Chiamato quando l'utente fa clic sul menu File mentre il diagramma è attivo.
Metodo protetto ProcessOnStatusRerouteLineCommand Determina se il comando di navigazione viene visualizzato nel menu di scelta rapida.Chiamato quando l'utente fa clic con il pulsante destro del mouse sul diagramma.
Metodo protetto ProcessOnStatusResetDecoratorLocationCommand Determina se il comando di posizione dell'elemento Decorator di resto viene visualizzato nel menu di scelta rapida.Chiamato quando l'utente fa clic con il pulsante destro del mouse sul diagramma.
Metodo protetto ProcessOnStatusResetDecoratorSizeCommand Determina se il comando di dimensione elemento Decorator di reimpostazione automatica viene visualizzato nel menu.Chiamato quando l'utente fa clic con il pulsante destro del mouse sul diagramma.
Metodo protetto ProcessOnStatusSelectAllCommand Determina se il selezionare tutto il comando nel menu.Chiamato quando l'utente fa clic sul menu Modifica durante il diagramma è attivo.
Metodo pubblico ToString Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)

In alto

Note

È possibile modificare la modalità di DSL risponda ad alcuni comandi di menu.I controlli che è possibile modificare includono i comandi del menu di scelta rapida e alcuni controlli sul file e i menu Modifica.

Nel progetto DslPackage, sarà presente un file generato chiamato CommandSet.cs, che contiene una dichiarazione parziale di < chiamato classeTheLanguageName>CommandSet.Per modificare il comportamento dei comandi di menu standard, aggiungere un altro file con una definizione parziale della stessa classe.

In questa classe, è possibile eseguire l'override dei metodi definiti nella classe base.

[!NOTA]

Verificare che lo spazio dei nomi nel nuovo file sia lo stesso spazio dei nomi nel CommandSet.cs generato.Nel nuovo file, quando si digita “override„ all'interno della dichiarazione di classe, verrà visualizzato un elenco di metodi che è possibile eseguire l'override.

Ciascun comando è disponibile un ProcessOnStatus…metodo e un ProcessOnMenu…metodo.Il ProcessOnStatus…il metodo determina se il comando nel menu di scelta rapida.Impostare la proprietà visibile del parametro di comando per determinare se il comando è visibile e impostare la proprietà attivata per determinare se la voce di menu è abilitata o inattiva esterno.

Il ProcessOnMenu…il metodo esegue il comando quando l'utente fa clic sulla voce di menu.

[!NOTA]

È possibile definire i comandi aggiuntivi nel file di Commands.vsct.

Per ulteriori informazioni, vedere Procedura: aggiungere un comando al menu di scelta rapida.

Esempi

Questo file viene aggiunto al progetto DslPackage.Impedisce agli utenti del modello DSL di eliminare più di un elemento per volta.

// In the DslPackage project.
namespace Company.Language1 // Check this is correct after creating the file.
{
  internal partial class Language1CommandSet // Same class as the generated class.
  {
    /// <summary>
    /// Called when user right-clicks on the diagram or clicks the Edit menu.
    /// </summary>
    /// <param name="command"></param>
    protected override void ProcessOnStatusDeleteCommand(System.ComponentModel.Design.MenuCommand command)
    {
      if (this.CurrentSelection.Count > 1)
      {
        // If user has selected more than one item, Delete is greyed out.
        command.Enabled = false;
      }
      else
      {
        // Otherwise, default behavior.
        base.ProcessOnStatusDeleteCommand(command);
      }
    }
    /// <summary>
    /// Called when user presses Delete key or clicks the Delete command on a menu.
    /// </summary>
    protected override void ProcessOnMenuDeleteCommand()
    {
      // Allow users to delete only one thing at a time.
      if (this.CurrentSelection.Count <= 1)
      {
        base.ProcessOnMenuDeleteCommand();
      }
    }
  }
}

Codice thread safe

Qualsiasi membro static (Shared in Visual Basic) pubblico di questo tipo è thread-safe. I membri di istanza non sono garantiti come thread-safe.

Vedere anche

Riferimenti

Spazio dei nomi Microsoft.VisualStudio.Modeling.Shell

Altre risorse

Procedura: aggiungere un comando al menu di scelta rapida