ToolWindow – třída

Při přepsání v odvozené třídě, představuje okno nástroje v generované Návrhář jazyka domény specifické.

Toto rozhraní API není kompatibilní se specifikací CLS. 

Hierarchie dědičnosti

System.Object
  Microsoft.VisualStudio.Shell.WindowPane
    Microsoft.VisualStudio.Modeling.Shell.ModelingWindowPane
      Microsoft.VisualStudio.Modeling.Shell.ToolWindow
        Microsoft.VisualStudio.Modeling.Shell.ModelExplorerToolWindow

Obor názvů:  Microsoft.VisualStudio.Modeling.Shell
Sestavení:  Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (v Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll)

Syntaxe

'Deklarace
<CLSCompliantAttribute(False)> _
Public MustInherit Class ToolWindow _
    Inherits ModelingWindowPane

[CLSCompliantAttribute(false)]
public abstract class ToolWindow : ModelingWindowPane

Typ ToolWindow zveřejňuje následující členy.

Konstruktory

	Název	Popis
	ToolWindow	Vytvoří novou instanci třídy ToolWindow.

Nahoru

Vlastnosti

	Název	Popis
	ActiveInPlaceEditWindow	Získá a nastaví aktivní okno pro úpravy na místě. (Zděděno z ModelingWindowPane.)
	BitmapIndex	Přepsat v odvozené třídě získá při indexu bitové mapy, které se zobrazí vedle názvu okno nástroje.
	BitmapResource	Pokud přepsat v odvozené třídě získá Identifikátor prostředku rastrový obrázek, který se zobrazí vedle názvu okno nástroje.
	Content	(Zděděno z WindowPane.)
	DocData	Získá dokument v paměti.
	EnableUndo	Získá okno nástroje a umožňuje zpět příkaz.
	Frame	Získá IVsWindowFrame , který odpovídá v tomto okně. (Zděděno z ModelingWindowPane.)
	HasSelectableObjects	Získá zakáže okno nástroje Objekty vyberte příkaz, pokud není načten dokument. (Přepisuje ModelingWindowPane.HasSelectableObjects.)
	HasToolBar	Získá okno nástroje a ověří, zda je nutné na panel nástrojů.
	HelpService	Získá nápovědu služby. (Zděděno z ModelingWindowPane.)
	InitializationMode	(Zděděno z WindowPane.)
	MenuService	Získá služba nabídka příkazů. (Zděděno z ModelingWindowPane.)
	PrimarySelection	Získá prvek primární vybrané v podokně okna. (Zděděno z ModelingWindowPane.)
	SelectedElements	Získá prvky, které jsou vybrány v podokně okna. (Zděděno z ModelingWindowPane.)
	SelectionCount	Získá počet prvků, které jsou vybrány v podokně okna. (Zděděno z ModelingWindowPane.)
	SelectionHelpService	Získá nápovědu služby výběru. (Zděděno z ModelingWindowPane.)
	ServiceProvider	Získá poskytovatel metadat, který je místní do tohoto podokna. (Zděděno z ModelingWindowPane.)
	ToolBarHost	Získá IVsToolWindowToolbarHost rozhraní, které určuje, jak zobrazit panely nástrojů v okně nástroje.
	ToolWindowFont	Získá písma pro okno nástroje.
	Window	(Zděděno z WindowPane.)
	WindowTitle	Získá název okno nástroje.

Nahoru

Metody

	Název	Popis
	CommitPendingEditForCommand	Po implementaci v odvozené třídě určuje zda čekající úpravy by měla být potvrzena před provedením příkazu. (Zděděno z ModelingWindowPane.)
	CountAllObjects	Získá počet prvků v podokně okna. (Zděděno z ModelingWindowPane.)
	CountObjects	Vrátí počet prvků v podokně okna nebo v aktuálním výběru. (Zděděno z ModelingWindowPane.)
	CountSelectedObjects	Získá počet prvků v aktuálním výběru. (Zděděno z ModelingWindowPane.)
	Dispose()	(Zděděno z WindowPane.)
	Dispose(Boolean)	Uvolní nespravované prostředky používané ToolWindow a volitelně uvolní spravované prostředky. (Přepisuje ModelingWindowPane.Dispose(Boolean).)
	DoSelectObjects	Když je implementován v odvozené třídě, vybere prvky v podokně okna. (Zděděno z ModelingWindowPane.)
	Equals	Určuje, zda se zadaný objekt rovná aktuálnímu objektu. (Zděděno z Object.)
	Finalize	Umožňuje objektu k pokusu uvolnit prostředky a provádět další operace vyčištění před je zažádáno systémem uvolňování paměti. (Zděděno z Object.)
	GetAllObjects	Získá všechny prvky v podokně okna. (Zděděno z ModelingWindowPane.)
	GetComponentSelected	Určuje, zda je vybraná dané součásti. (Zděděno z ModelingWindowPane.)
	GetContainerSelected	Určuje, zda je vybraná daného kontejneru. (Zděděno z ModelingWindowPane.)
	GetHashCode	Slouží jako výchozí funkce hash. (Zděděno z Object.)
	GetObjects	Získá prvky, které jsou aktuálně vybrány nebo prvky, které lze vybrat v podokně okna. (Zděděno z ModelingWindowPane.)
	GetSelectedComponents	Získá součásti, které jsou vybrány v podokně okna. (Zděděno z ModelingWindowPane.)
	GetSelectedObjects	Získá prvky, které jsou vybrány v podokně okna. (Zděděno z ModelingWindowPane.)
	GetService	Získá zadaného typu služby.Přepsat tuto metodu a vrátit službu příkaz vlastní nabídky (Zděděno z ModelingWindowPane.)
	GetSite	Získá na webu, která byla nastavena pomocí SetSite. (Zděděno z ModelingWindowPane.)
	GetType	Získá Type aktuální instance. (Zděděno z Object.)
	Hide	Skryje podokno okna. (Zděděno z ModelingWindowPane.)
	Initialize	Vytvoří novou instanci třídy ToolWindow. (Přepisuje WindowPane.Initialize().)
	LoadUIState	(Zděděno z WindowPane.)
	MemberwiseClone	Vytvoří mělká kopie aktuálního Object. (Zděděno z Object.)
	OnAfterToolWindowCreate	POST-Creation inicializace.
	OnClose	Při zavření podokna okna, odebere z místní nabídky výběru objektů podokně okna. (Zděděno z ModelingWindowPane.)
	OnCreate	Vytvoří okno nástroje. (Přepisuje WindowPane.OnCreate().)
	OnDocumentWindowChanged	Odvozené třídy upozorní, pokud uživatel provede změny v okně dokumentu.
	OnSelectionChanged	Po výběru změny upozorní posluchače událostí. (Zděděno z ModelingWindowPane.)
	OnSelectionChanging	Upozorňuje posluchače událostí před změnami výběru. (Zděděno z ModelingWindowPane.)
	OnToolWindowCreate	Sleduje změny v rámečku v okně dokumentu
	PreProcessMessage	Zpracovává zprávy okna. (Zděděno z ModelingWindowPane.)
	SaveUIState	(Zděděno z WindowPane.)
	SelectObjects	Výběr prvků v podokně okna. (Zděděno z ModelingWindowPane.)
	SetSelectedComponents(ICollection)	Přidá zadané součásti do kontejneru výběr a upozorní prostředí změnit výběr. (Zděděno z ModelingWindowPane.)
	SetSelectedComponents(ICollection, SelectionTypes)	Není aktuálně implementováno. (Zděděno z ModelingWindowPane.)
	SetSite	Inicializuje podoken v životním prostředí. (Zděděno z ModelingWindowPane.)
	Show	Zobrazí podokno okna, přenese se do popředí a je aktivní okno. (Zděděno z ModelingWindowPane.)
	ShowNoActivate	Zobrazí podokno okna, zobrazí se dopředu, ale neumožňuje zvětšení aktivního okna. (Zděděno z ModelingWindowPane.)
	ToString	Vrací řetězec, který představuje aktuální objekt. (Zděděno z Object.)

Nahoru

Události

	Název	Popis
	SelectionChanged	Je aktivována po změně výběru v podokně okna. (Zděděno z ModelingWindowPane.)
	SelectionChanging	Je aktivována před výběrem v podokně okna se změní. (Zděděno z ModelingWindowPane.)

Nahoru

Explicitní implementace rozhraní

	Název	Popis
	IVsWindowPane.ClosePane	Zastaralé. (Zděděno z WindowPane.)
	IVsUIElementPane.CloseUIElementPane	(Zděděno z WindowPane.)
	IVsWindowPane.CreatePaneWindow	Zastaralé. (Zděděno z WindowPane.)
	IVsUIElementPane.CreateUIElementPane	(Zděděno z WindowPane.)
	IOleCommandTarget.Exec	(Zděděno z WindowPane.)
	IVsWindowPane.GetDefaultSize	Zastaralé. (Zděděno z WindowPane.)
	IVsUIElementPane.GetDefaultUIElementSize	(Zděděno z WindowPane.)
	IServiceProvider.GetService	(Zděděno z WindowPane.)
	IVsUIElementPane.LoadUIElementState	(Zděděno z WindowPane.)
	IVsWindowPane.LoadViewState	Zastaralé. (Zděděno z WindowPane.)
	IOleCommandTarget.QueryStatus	(Zděděno z WindowPane.)
	IVsUIElementPane.SaveUIElementState	(Zděděno z WindowPane.)
	IVsWindowPane.SaveViewState	Zastaralé. (Zděděno z WindowPane.)
	IVsWindowPane.SetSite	Zastaralé. (Zděděno z WindowPane.)
	IVsUIElementPane.SetUIElementSite	(Zděděno z WindowPane.)
	IVsWindowPane.TranslateAccelerator	Zastaralé. (Zděděno z WindowPane.)
	IVsUIElementPane.TranslateUIElementAccelerator	(Zděděno z WindowPane.)

Nahoru

Poznámky

Chcete-li přidat okno nástroje generované Designer, je třeba zaregistrovat okna.Další informace naleznete v tématu ModelingPackage.

Příklady

Následující příklad přidá nástroj okno Okno nástroje vlastní do projektu jazyka specifické pro doménu s názvem RegisterTools.Při otevření projektu v Návrháři generované kartě v tomto okně zobrazeném vedle Průzkumník řešení.Klepnete-li na této kartě, popisek, který čte je okno Vlastní nástroj se zobrazí uprostřed okno nástroje.

Tento kód zaregistruje okno nástroje:

using VSShellInterop = Microsoft.VisualStudio.Shell.Interop;
using VSShell = Microsoft.VisualStudio.Shell;
using DslShell = Microsoft.VisualStudio.Modeling.Shell;
using DslDesign = Microsoft.VisualStudio.Modeling.Design;
using VSTextTemplatingHost = Microsoft.VisualStudio.TextTemplating.VSHost;

namespace MS.RegisterTools.DslPackage
{
    [VSShell::ProvideToolWindowVisibility(typeof(CustomToolWindow), 
              Constants.RegisterToolsEditorFactoryId)]
    [VSShell::ProvideToolWindow(typeof(CustomToolWindow), 
              MultiInstances = false, 
              Style = VSShell::VsDockStyle.Tabbed, 
              Orientation = VSShell::ToolWindowOrientation.Right, 
              Window = "{3AE79031-E1BC-11D0-8F78-00A0C9110057}")]

    internal partial class RegisterToolsPackage
    {
        //Initializes the base class for the package
        protected override void Initialize()
        {
            base.Initialize();

            //Registers the custom tool window
            this.AddToolWindow(typeof(CustomToolWindow));
        }
    }
}

Tento kód definuje okno nástroje:

using System;
using System.Windows.Forms;
using VSShellInterop = Microsoft.VisualStudio.Shell.Interop;
using VSShell = Microsoft.VisualStudio.Shell;
using DslShell = Microsoft.VisualStudio.Modeling.Shell;
using DslDesign = Microsoft.VisualStudio.Modeling.Design;
using VSTextTemplatingHost = Microsoft.VisualStudio.TextTemplating.VSHost;

namespace MS.RegisterTools.DslPackage
{

    //Creates a tool window and gives it a title, icon, and label
    internal class CustomToolWindow : DslShell.ToolWindow
    {

        //defines a label
  private Label myLabel;
        
        //creates the tool window
  public CustomToolWindow(IServiceProvider serviceProvider) : base(serviceProvider)
  { 
  }

        //gets the icon for the tool window
        protected override int BitmapResource
        {
            get { return 104; }
        }

        //gets the index for the icon
        protected override int BitmapIndex
        {
            get { return 0; }
        }

        //gets the name of the tool window
        public override string WindowTitle
        {
            get { return "Custom Window"; }
        }

        //sets up a label
  protected override void OnToolWindowCreate()
  {
      this.myLabel = new Label();
this.myLabel.TextAlign = System.Drawing.ContentAlignment.MiddleCenter;
this.myLabel.Text = "This is the custom tool window";
   }

        //puts a label on the tool window
  public override System.Windows.Forms.IWin32Window Window
  {
       get { return this.myLabel; }
  }
    }
}

Bezpečný přístup z více vláken

Všechny veřejné členy static (Shared v jazyce Visual Basic) tohoto typu jsou bezpečné pro přístup z více vláken. Není zaručeno, že členy instancí jsou bezpečné pro přístup z více vláken.

Viz také

Referenční dokumentace

Microsoft.VisualStudio.Modeling.Shell – obor názvů