4.10扩展属性、 任务列表、 输出和选项 Windows

扩展属性、 任务列表、 输出和选项 Windows

Visual Studio 2015

其他版本

 

若要了解有关 Visual Studio 2017 RC 的最新文档，请参阅 Visual Studio 2017 RC 文档。

您可以访问 Visual Studio 中的任何工具窗口。 本演练演示如何将工具窗口有关的信息集成到一个新选项页和上的新设置属性页上，以及如何将写入到任务列表和输出windows。

先决条件

启动 Visual Studio 2015 中，您并不安装 Visual Studio SDK 从下载中心获得。 它将包括作为 Visual Studio 安装程序中的可选功能。 您还可以在以后安装 VS SDK。 有关详细信息，请参阅安装 Visual Studio SDK。

使用一个工具窗口创建扩展

1. 创建一个名为项目TodoList使用 VSIX 模板，并将添加一个名为的自定义工具窗口项模板TodoWindow。

    说明

   有关使用一个工具窗口创建扩展的详细信息，请参阅使用一个工具窗口创建扩展。

设置工具窗口

添加在其中可键入一个新的 ToDo 项目，以添加新项到列表中，一个按钮和列表框中显示的项在列表中的文本框。

1. 在 TodoWindow.xaml，从 UserControl 中删除按钮、 文本框中，和 StackPanel 控件。

    说明

   此时不会删除button1_Click事件处理程序，则将在稍后的步骤中重用。

2. 从所有 WPF 控件部分工具箱，拖动画布到网格控件。

3. 拖动TextBox、按钮，和一个ListBox到画布上。 排列元素，使文本框和按钮在同一级别，以及 ListBox 填充其余部分的下方，如下面的图片中所示的窗口。

   

4. 在 XAML 窗格中，找到按钮，并将其内容的属性设置为添加。 通过添加重新连接到按钮控件按钮事件处理程序Click="button1_Click"属性。 画布块应如下所示︰

   XML

   <Canvas HorizontalAlignment="Left" Width="306">      <TextBox x:Name="textBox" HorizontalAlignment="Left" Height="23" Margin="10,10,0,0" TextWrapping="Wrap" Text="TextBox" VerticalAlignment="Top" Width="208"/>          <Button x:Name="button" Content="Add" HorizontalAlignment="Left" Margin="236,13,0,0" VerticalAlignment="Top" Width="48" Click="button1_Click"/>          <ListBox x:Name="listBox" HorizontalAlignment="Left" Height="222" Margin="10,56,0,0" VerticalAlignment="Top" Width="274"/>  </Canvas>  

自定义构造函数

1. 在 TodoWindowControl.xaml.cs 文件中，添加以下 using 语句︰

   C#

   using System;  

2. 添加对 TodoWindow 的公共引用并让 TodoWindowControl 构造函数采用 TodoWindow 参数。 该代码应如下所示︰

   C#

   public TodoWindow parent;  public TodoWindowControl(TodoWindow window)  {      InitializeComponent();      parent = window;  }  

3. TodoWindow.cs，在将更改 TodoWindowControl 构造函数，以便包括 TodoWindow 参数。 该代码应如下所示︰

   C#

   public TodoWindow() : base(null)  {      this.Caption = "TodoWindow";      this.BitmapResourceID = 301;      this.BitmapIndex = 1;       this.Content = new TodoWindowControl(this);  }  

创建选项页

您可以提供中的页选项对话框中，以便用户可以更改工具窗口中的设置。 创建选项页需要两个类，用于描述的选项和 TodoListPackage.cs 或 TodoListPackage.vb 文件中的条目。

1. 添加一个名为类ToolsOptions.cs。 使 ToolsOptions 类继承自DialogPage。

   C#

   class ToolsOptions : DialogPage  {  }  

2. 添加以下 using 语句︰

   C#

   using Microsoft.VisualStudio.Shell;  

3. 在本演练中选项页提供了名为 DaysAhead 只能有一个选项。 添加一个名为的私有字段daysAhead和一个名为属性DaysAhead到 ToolsOptions 类︰

   C#

   private double daysAhead;  public double DaysAhead  {      get { return daysAhead; }      set { daysAhead = value; }  }  

现在，您必须使该项目注意该选项页。

向用户提供选项页

1. 在 TodoWindowPackage.cs，添加ProvideOptionPageAttribute到 TodoWindowPackage 类︰

   C#

   [ProvideOptionPage(typeof(ToolsOptions), "ToDo", "General", 101, 106, true)]  

2. ProvideOptionPage 构造函数的第一个参数是类 ToolsOptions，以前创建的类型。 第二个参数，"ToDo"是中类别的名称选项对话框。 第三个参数，"常规"是的子类别的名称选项选项页将在其中可用的对话框。 接下来两个参数是字符串; 尝试添加的资源 Id第一种是该类别的名称，第二个是子类别的名称。 最后一个参数确定是否可以通过使用自动化访问此页。

   当用户打开选项页上时，它应类似于下图。

   

   请注意该类别ToDo和 subcategory常规。

使数据可用于属性窗口

通过创建一个名为将有关的各个项的信息存储在 ToDo 列表中的 TodoItem 类可以使任务列表信息可用。

1. 添加一个名为类TodoItem.cs。

   向用户提供的工具窗口时，将由 TodoItems 表示列表框中的项。 当用户选择其中一项在列表框中，属性窗口将显示与项有关的信息。

   若要使数据中可用属性窗口中，您将数据转换为具有两个特殊属性的公共属性Description和Category。 Description是在底部显示的文本属性窗口。 Category确定该属性应出现时属性窗口显示在按分类顺序视图。 如下图中属性窗口处于按分类顺序视图中，名称中的属性ToDo 字段选择类别后，和的说明名称属性显示在窗口的底部。

   

2. 添加以下 using 语句 TodoItem.cs 文件。

   C#

   using System.ComponentModel;  using System.Windows.Forms;  using Microsoft.VisualStudio.Shell.Interop;  

3. 添加public到类声明的访问修饰符。

   C#

   public class TodoItem  {  }  

   添加两个属性名称和 DueDate。 我们将更高版本执行的 UpdateList() 和 CheckForErrors()。

   C#

   public class TodoItem  {      private TodoWindowControl parent;      private string name;      [Description("Name of the ToDo item")]      [Category("ToDo Fields")]      public string Name      {          get { return name; }          set          {              name = value;              parent.UpdateList(this);          }      }      private DateTime dueDate;      [Description("Due date of the ToDo item")]      [Category("ToDo Fields")]      public DateTime DueDate      {          get { return dueDate; }          set          {              dueDate = value;              parent.UpdateList(this);              parent.CheckForErrors();          }      }  }  

4. 添加到用户控件的专用引用。 添加的构造函数的用户控制和此 ToDo 项的名称。 若要查找 daysAhead 值，它获取选项页属性。

   C#

   private TodoWindowControl parent;  public TodoItem(TodoWindowControl control, string itemName)  {      parent = control;      name = itemName;      dueDate = DateTime.Now;      double daysAhead = 0;      IVsPackage package = parent.parent.Package as IVsPackage;      if (package != null)      {          object obj;          package.GetAutomationObject("ToDo.General", out obj);          ToolsOptions options = obj as ToolsOptions;          if (options != null)          {              daysAhead = options.DaysAhead;          }      }      dueDate = dueDate.AddDays(daysAhead);  }  

5. 因为实例TodoItem类将存储在列表框和列表框将调用ToString函数，还必须重载ToString函数。 在构造函数之后和类的末尾之前，请将以下代码添加到 TodoItem.cs。

   C#

   public override string ToString()  {      return name + " Due: " + dueDate.ToShortDateString();  }  

6. 在 TodoWindowControl.xaml.cs，添加存根 （stub） 方法的 TodoWindowControl 类CheckForError和UpdateList方法。 将它们放在 ProcessDialogChar 之后和之前的文件的末尾。

   C#

   public void CheckForErrors()  {  }  public void UpdateList(TodoItem item)  {  }  

   CheckForError方法将调用父对象中具有相同名称的方法，该方法将检查是否已发生的任何错误，并正确处理这些。 UpdateList方法将更新的列表框中的父控件; 当调用该方法Name和DueDate中此类更改的属性。 它们将更高版本实现。

将集成到属性窗口

现在，编写代码，用于管理将绑定到 ListBox属性窗口。

必须更改该按钮单击处理程序来读取文本框、 创建 TodoItem，并将其添加到列表框。

1. 替换现有button1_Click函数包含用于创建新的 TodoItem 并将其添加到列表框的代码。 它将调用 TrackSelection()，将在以后定义。

   C#

   private void button1_Click(object sender, RoutedEventArgs e)  {      if (textBox.Text.Length > 0)      {          var item = new TodoItem(this, textBox.Text);          listBox.Items.Add(item);          TrackSelection();          CheckForErrors();      }  }  

2. 在设计视图选择列表框控件。 在属性窗口中，单击事件处理程序按钮并找到 SelectionChanged 事件。 在文本框中填充listBox_SelectionChanged。 执行此操作将添加 SelectionChanged 处理程序存根，并将其分配给该事件。

3. 实现 TrackSelection() 方法。 由于您将需要获取SVsUIShellSTrackSelection服务，需要进行GetService TodoWindowControl 可访问。 将以下方法添加到 TodoWindow 类︰

   internal object GetVsService(Type service)  {      return GetService(service);  }  

4. 添加以下 using 语句 TodoWindowControl.xaml.cs:

   C#

   using System.Runtime.InteropServices;  using Microsoft.VisualStudio.Shell.Interop;  using Microsoft.VisualStudio;  using Microsoft.VisualStudio.Shell;  

5. 填充 SelectionChanged 处理程序中，如下所示︰

   private void listBox_SelectionChanged(object sender, SelectionChangedEventArgs e)  {      TrackSelection();  }  

6. 现在，填写 TrackSelection 函数，它将提供与集成属性窗口。 在用户将某项添加到列表框，或单击列表框中的项目时，调用此函数。 它将 ListBox 的内容添加到 SelectionContainer 并将传递到 SelectionContainer属性窗口的OnSelectChange事件处理程序。 TrackSelection 服务跟踪的用户界面 (UI) 中选定的对象，并显示其属性

   C#

   private SelectionContainer mySelContainer;  private System.Collections.ArrayList mySelItems;  private IVsWindowFrame frame = null;  private void TrackSelection()  {      if (frame == null)      {          var shell = parent.GetVsService(typeof(SVsUIShell)) as IVsUIShell;          if (shell != null)          {              var guidPropertyBrowser = new              Guid(ToolWindowGuids.PropertyBrowser);              shell.FindToolWindow((uint)__VSFINDTOOLWIN.FTW_fForceCreate,              ref guidPropertyBrowser, out frame);          }      }      if (frame != null)          {              frame.Show();          }      if (mySelContainer == null)      {          mySelContainer = new SelectionContainer();      }      mySelItems = new System.Collections.ArrayList();      var selected = listBox.SelectedItem as TodoItem;      if (selected != null)      {          mySelItems.Add(selected);      }      mySelContainer.SelectedObjects = mySelItems;      ITrackSelection track = parent.GetVsService(typeof(STrackSelection))                              as ITrackSelection;      if (track != null)      {          track.OnSelectChange(mySelContainer);      }  }  

   现在，您有一个类，属性窗口可以使用，您可以将集成属性与工具窗口的窗口。 当用户单击工具窗口中，在列表框中的项属性应相应地更新窗口。 同样，当用户更改中的 ToDo 项属性窗口中，应更新关联的项。

7. 现在，在 TodoWindowControl.xaml.cs 添加 UpdateList 函数代码的其余部分。 它应删除并重新从列表框中添加已修改的 TodoItem。

   C#

   public void UpdateList(TodoItem item)  {      var index = listBox.SelectedIndex;      listBox.Items.RemoveAt(index);      listBox.Items.Insert(index, item);      listBox.SelectedItem = index;  }  

8. 测试您的代码。 生成项目并启动调试。 应显示的实验实例。

9. 打开工具 / 选项页。 您应看到在左窗格中的 ToDo 类别。 按字母顺序列出了类别，因此在 Ts 下查找。

10. 在 Todo 选项页中，您应看到 DaysAhead 属性设置为0。 将其更改为2。

11. 在视图上 / 其他窗口菜单打开TodoWindow。 类型EndDate在文本框中单击添加。

12. 在列表框中，您应该看到两个天晚于今天的日期。

将文本添加到输出窗口和任务列表项

有关任务列表，您创建新的对象的类型为 Task，，然后添加到该任务对象任务列表通过调用其 Add 方法。 要写入到输出窗口中，调用其 GetPane 方法以获取窗格对象，，，然后调用窗格中对象的 OutputString 方法。

1. 在 TodoWindowControl.xaml.cs 中,button1_Click方法中，添加代码以获取常规窗格输出窗口中 （这是默认值），并向其中写入。 该方法应如下所示︰

   C#

   private void button1_Click(object sender, EventArgs e)  {      if (textBox.Text.Length > 0)      {          var item = new TodoItem(this, textBox.Text);          listBox.Items.Add(item);          var outputWindow = parent.GetVsService(              typeof(SVsOutputWindow)) as IVsOutputWindow;          IVsOutputWindowPane pane;          Guid guidGeneralPane = VSConstants.GUID_OutWindowGeneralPane;          outputWindow.GetPane(ref guidGeneralPane, out pane);          if (pane != null)          {               pane.OutputString(string.Format(                  "To Do item created: {0}\r\n",               item.ToString()));      }          TrackSelection();          CheckForErrors();      }  }  

2. 若要将项添加到任务列表中，你需要将嵌套的类添加到 TodoWindowControl 类。 嵌套的类需要派生自TaskProvider。 将以下代码添加到 TodoWindowControl 类的末尾。

   C#

   [Guid("72de1eAD-a00c-4f57-bff7-57edb162d0be")]  public class TodoWindowTaskProvider : TaskProvider  {      public TodoWindowTaskProvider(IServiceProvider sp)          : base(sp)      {      }  }  

3. 接下来将对 TodoTaskProvider 的私有引用和 CreateProvider() 方法添加到 TodoWindowControl 类。 该代码应如下所示︰

   C#

   private TodoWindowTaskProvider taskProvider;  private void CreateProvider()  {      if (taskProvider == null)      {          taskProvider = new TodoWindowTaskProvider(parent);          taskProvider.ProviderName = "To Do";      }  }  

4. 将 ClearError()，清除任务列表，并 ReportError()，将条目添加到任务列表中，添加到 TodoWindowControl 类。

   C#

   private void ClearError()  {      CreateProvider();      taskProvider.Tasks.Clear();  }  private void ReportError(string p)  {      CreateProvider();      var errorTask = new Task();      errorTask.CanDelete = false;      errorTask.Category = TaskCategory.Comments;      errorTask.Text = p;      taskProvider.Tasks.Add(errorTask);      taskProvider.Show();      var taskList = parent.GetVsService(typeof(SVsTaskList))          as IVsTaskList2;      if (taskList == null)      {          return;      }      var guidProvider = typeof(TodoWindowTaskProvider).GUID;       taskList.SetActiveProvider(ref guidProvider);  }  

5. 现在，如下所示实现 CheckForErrors 方法。

   C#

   public void CheckForErrors()  {      foreach (TodoItem item in listBox.Items)      {          if (item.DueDate < DateTime.Now)          {              ReportError("To Do Item is out of date: "                  + item.ToString());          }      }  }  

尝试一下

1. 生成项目并启动调试。 将显示的实验实例。

2. 打开 TodoWindow (视图 / 其他窗口 / TodoWindow)。

3. 在文本框中键入内容，然后单击添加。

   到期日期 2 天后今天添加到列表框中。 未出现任何错误，与任务列表(视图 / 任务列表) 应没有任何条目。

4. 现在将设置更改启用工具 / 选项 / ToDo来自页2回0。

5. 键入内容中的其他TodoWindow ，然后单击添加再次。 这会触发错误以及将项记入任务列表。

   添加项时，初始日期设置为现在再加上 2 天。

6. 在视图菜单上，单击输出若要打开输出窗口。

   请注意，每次添加项，一条消息将显示在任务列表窗格。

7. 单击其中一个列表框中的项。

   属性窗口将显示两个项的属性。

8. 更改其中一个属性，然后按 enter 键。

   在列表框中更新项。