Interfejs CustomTaskPane

Artykuł
01/08/2014

Reprezentuje niestandardowe okienko zadań w aplikacji pakietu Microsoft Office.

Przestrzeń nazw: Microsoft.Office.Tools
Zestawy:   Microsoft.Office.Tools.Common.v4.0.Utilities (w Microsoft.Office.Tools.Common.v4.0.Utilities.dll)
  Microsoft.Office.Tools.Outlook.v4.0.Utilities (w Microsoft.Office.Tools.Outlook.v4.0.Utilities.dll)
  Microsoft.Office.Tools.Excel.v4.0.Utilities (w Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)
  Microsoft.Office.Tools.Common (w Microsoft.Office.Tools.Common.dll)
  Microsoft.Office.Tools.Word.v4.0.Utilities (w Microsoft.Office.Tools.Word.v4.0.Utilities.dll)

Składnia

'Deklaracja
<GuidAttribute("881b42fd-484d-4494-8500-779de4e4aac1")> _
Public Interface CustomTaskPane _
    Inherits IDisposable

[GuidAttribute("881b42fd-484d-4494-8500-779de4e4aac1")]
public interface CustomTaskPane : IDisposable

Typ CustomTaskPane uwidacznia następujące elementy członkowskie.

Właściwości

	Nazwa	Opis
	Control	Pobiera UserControl , udostępniająca interfejs użytkownika niestandardowe okienko zadań.
	DockPosition	Pobiera lub ustawia wartość, która określa lokalizację niestandardowe okienko zadań względem okna aplikacji.
	DockPositionRestrict	Pobiera lub ustawia wartość, która zapobiega niestandardowe okienko zadań jest zadokowana w określonej pozycji.
	Height	Pobiera lub Ustawia wysokość niestandardowe okienko zadań, w punktach.
	Title	Pobiera tytuł niestandardowe okienko zadań.
	Visible	Pobiera lub ustawia wartość określająca, czy niestandardowe okienko zadań jest widoczny.
	Width	Pobiera lub ustawia szerokość niestandardowe okienko zadań, w punktach.
	Window	Pobiera okna dokumentu, niestandardowe okienko zadań z którym jest skojarzona.

Początek

Metody

	Nazwa	Opis
	Dispose	Wykonuje zadania zdefiniowane przez aplikację skojarzone z uwalnianiem, zwalnianiem lub resetowaniem niezarządzanych zasobów. (Odziedziczone z IDisposable).

Początek

Zdarzenia

	Nazwa	Opis
	DockPositionChanged	Występuje, gdy użytkownik zmieni położenie dokowania niestandardowe okienko zadań lub kod zmienia wartość DockPosition właściwość.
	VisibleChanged	Występuje, gdy użytkownik wyświetla lub zamyka niestandardowe okienko zadań lub po zmianie wartości z pola Kod Visible właściwość.

Początek

Uwagi

Użycie CustomTaskPane obiektu w poziomie aplikacji dodatek do modyfikowania niestandardowe okienko zadań lub odpowiadać po zmianie lokalizacji lub widoczność niestandardowe okienko zadań.Panele interfejsu użytkownika, które zazwyczaj są zadokowane z jednej strony okna aplikacji są okienka zadań.Aby uzyskać informacje o tworzeniu niestandardowych okienek zadań, zobacz Niestandardowe okienka zadań.

Aby kontrolować rozmiar lub położenie niestandardowe okienko zadań, można użyć właściwości takich jak Height, Width, i Visible.

Aby reagować, gdy niestandardowe okienko zadań przemieszcza się lub zmienia widoczność, można obsługiwać DockPositionChanged i VisibleChanged zdarzenia.

[!UWAGA]

Ten interfejs jest implementowany przez Visual Studio Tools for Office Runtime. Nie jest on przeznaczony do implementacji w kodzie. Aby uzyskać więcej informacji, zobacz Visual Studio Tools for Office Runtime ― Przegląd.

Użycie

W dokumentacji opisano wersję typu używanego w projektach dla pakietu Office przeznaczonych do pracy z programem .NET Framework 4 i .NET Framework 4.5. W projektach przeznaczonych do pracy z programem .NET Framework 3.5 ten typ może mieć inne elementy członkowskie, a przykładowy kod podany dla tego typu może nie działać. Aby uzyskać dokumentację tego typu używanego w projektach przeznaczonych do działania z programem .NET Framework 3.5, zobacz następującą sekcję informacyjną w dokumentacji programu Visual Studio 2008: https://go.microsoft.com/fwlink/?LinkId=160658.

Przykłady

Poniższy przykład kodu pokazuje, jak utworzyć niestandardowe okienko zadań za pomocą Add(UserControl, String) metody.W przykładzie użyto właściwości CustomTaskPane obiekt, aby ustawić domyślny wygląd niestandardowe okienko zadań i definiuje moduł obsługi zdarzeń DockPositionChanged zdarzenia.Aby skompilować ten przykład, należy skopiować ten kod do ThisAddIn klasy w projekcie add-in dla aplikacji, która obsługuje niestandardowe okienka zadań.Zastąpić domyślne ThisAddIn_Startup metoda w ThisAddIn z klasy ThisAddIn_Startup metoda w tym przykładzie.W tym przykładzie założono, że projekt nie zawiera UserControl o nazwie MyUserControli UserControl zawiera FlowLayoutPanel o nazwie FlowPanel.

Private myUserControl1 As MyUserControl
Private WithEvents myCustomTaskPane As Microsoft.Office.Tools.CustomTaskPane

Private Sub ThisAddIn_Startup(ByVal sender As Object, ByVal e As System.EventArgs) _
    Handles Me.Startup

    myUserControl1 = New MyUserControl()
    myCustomTaskPane = Me.CustomTaskPanes.Add(myUserControl1, "New Task Pane")

    With myCustomTaskPane
        .DockPosition = Office.MsoCTPDockPosition.msoCTPDockPositionFloating
        .Height = 500
        .Width = 500
        .DockPosition = Office.MsoCTPDockPosition.msoCTPDockPositionRight
        .Width = 300
        .Visible = True
    End With
End Sub

Private Sub myCustomTaskPane_DockPositionChanged(ByVal sender As Object, _
    ByVal e As EventArgs) Handles myCustomTaskPane.DockPositionChanged

    Dim taskPane As Microsoft.Office.Tools.CustomTaskPane = _
        TryCast(sender, Microsoft.Office.Tools.CustomTaskPane)

    If taskPane IsNot Nothing Then

        ' Adjust sizes of user control and flow panel to fit current task pane size.
        Dim userControl As MyUserControl = TryCast(taskPane.Control, MyUserControl)
        Dim paneSize As System.Drawing.Size = _
            New System.Drawing.Size(taskPane.Width, taskPane.Height)
        userControl.Size = paneSize
        userControl.FlowPanel.Size = paneSize

        ' Adjust flow direction of controls on the task pane.
        If taskPane.DockPosition = _
            Office.MsoCTPDockPosition.msoCTPDockPositionTop Or _
            taskPane.DockPosition = _
            Office.MsoCTPDockPosition.msoCTPDockPositionBottom Then

            userControl.FlowPanel.FlowDirection = _
                System.Windows.Forms.FlowDirection.LeftToRight
        Else
            userControl.FlowPanel.FlowDirection = _
                System.Windows.Forms.FlowDirection.TopDown
        End If
    End If
End Sub

private MyUserControl myUserControl1;
private Microsoft.Office.Tools.CustomTaskPane myCustomTaskPane;

private void ThisAddIn_Startup(object sender, System.EventArgs e)
{
    myUserControl1 = new MyUserControl();
    myCustomTaskPane = this.CustomTaskPanes.Add(myUserControl1,
        "New Task Pane");

    myCustomTaskPane.DockPosition =
        Office.MsoCTPDockPosition.msoCTPDockPositionFloating;
    myCustomTaskPane.Height = 500;
    myCustomTaskPane.Width = 500;

    myCustomTaskPane.DockPosition =
        Office.MsoCTPDockPosition.msoCTPDockPositionRight;
    myCustomTaskPane.Width = 300;

    myCustomTaskPane.Visible = true;
    myCustomTaskPane.DockPositionChanged +=
        new EventHandler(myCustomTaskPane_DockPositionChanged);
}

private void myCustomTaskPane_DockPositionChanged(object sender, EventArgs e)
{
    Microsoft.Office.Tools.CustomTaskPane taskPane =
        sender as Microsoft.Office.Tools.CustomTaskPane;

    if (taskPane != null)
    {
        // Adjust sizes of user control and flow panel to fit current task pane size.
        MyUserControl userControl = taskPane.Control as MyUserControl;
        System.Drawing.Size paneSize = new System.Drawing.Size(taskPane.Width, taskPane.Height);
        userControl.Size = paneSize;
        userControl.FlowPanel.Size = paneSize;

        // Adjust flow direction of controls on the task pane.
        if (taskPane.DockPosition == 
            Office.MsoCTPDockPosition.msoCTPDockPositionTop ||
            taskPane.DockPosition ==
            Office.MsoCTPDockPosition.msoCTPDockPositionBottom)
        {
            userControl.FlowPanel.FlowDirection =
                System.Windows.Forms.FlowDirection.LeftToRight;
        }
        else
        {
            userControl.FlowPanel.FlowDirection =
                System.Windows.Forms.FlowDirection.TopDown;
        }
    }
}