CustomTaskPane – rozhraní

Článek
05/14/2013

Představuje vlastní podokno úloh v aplikaci Microsoft Office.

Obor názvů: Microsoft.Office.Tools
Sestavení:   Microsoft.Office.Tools.Common.v4.0.Utilities (v Microsoft.Office.Tools.Common.v4.0.Utilities.dll)
  Microsoft.Office.Tools.Outlook.v4.0.Utilities (v Microsoft.Office.Tools.Outlook.v4.0.Utilities.dll)
  Microsoft.Office.Tools.Excel.v4.0.Utilities (v Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)
  Microsoft.Office.Tools.Common (v Microsoft.Office.Tools.Common.dll)
  Microsoft.Office.Tools.Word.v4.0.Utilities (v Microsoft.Office.Tools.Word.v4.0.Utilities.dll)

Syntaxe

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

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

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

Vlastnosti

	Název	Popis
	Control	Získá UserControl , který poskytuje uživatelské rozhraní pro vlastní podokno úloh.
	DockPosition	Získá nebo nastaví hodnotu, která určuje, kde je umístěn vzhledem k oknu aplikace nastavena vlastní podokno úloh.
	DockPositionRestrict	Získá nebo nastaví hodnotu, která brání vlastní podokno úloh je ukotveno na určené pozici.
	Height	Získá nebo nastaví výšku vlastní podokno úloh v bodech.
	Title	Získá název vlastní podokno úloh.
	Visible	Získá nebo nastaví hodnotu, která určuje, zda se zobrazí vlastní podokno úloh.
	Width	Získá nebo nastaví šířku vlastní podokno úloh v bodech.
	Window	Získá-li okno dokumentu, který vlastní podokno úloh je přidružen.

Nahoru

Metody

	Název	Popis
	Dispose	Provádí úkoly definované aplikací spojených s uvolněním, uvolnění nebo obnovení nespravované prostředky. (Zděděno z IDisposable.)

Nahoru

Události

	Název	Popis
	DockPositionChanged	Nastane v případě, že uživatel změní pozici doku vlastní podokno úloh nebo kód změní hodnotu DockPosition vlastnost.
	VisibleChanged	Dochází, když uživatel zobrazí nebo zavře vlastní podokno úloh nebo kód změní hodnotu Visible vlastnost.

Nahoru

Poznámky

Použití CustomTaskPane objektu v úrovni aplikace doplněk upravovat vlastní podokno úloh nebo reagovat při změně umístění nebo viditelnost vlastní podokno úloh.Podokna úloh jsou panely uživatelské rozhraní, které jsou obvykle ukotven k okraji okna aplikace.Informace o tom, jak vytvořit vlastní podokna úloh naleznete v tématu Vlastní podokna úloh.

Chcete-li určit velikost nebo umístění vlastní podokno úloh, můžete použít vlastnosti, jako je například Height, Width, a Visible.

Reagovat při vlastní podokno úloh pohybuje nebo mění viditelnost, může zpracovávat DockPositionChanged a VisibleChanged události.

[!POZNÁMKA]

Toto rozhraní je implementováno modulem Visual Studio Tools for Office Runtime. Rozhraní není určeno k implementaci do vašeho kódu. Další informace naleznete v tématu Visual Studio Tools pro přehled Runtime sady Office.

Použití

Tato dokumentace popisuje verzi tohoto typu, který je používán v projektech systému Office cílených pro rozhraní .NET Framework 4 a .NET Framework 4.5. V projektech cílených pro rozhraní .NET Framework 3.5 může mít tento typ jiné členy a ukázky kódu, poskytnuté pro tento typ, nemusejí fungovat. Dokumentaci k tomuto typu v projektech cílených na rozhraní .NET Framework 3.5 naleznete v následující informační části dokumentace k aplikaci Visual Studio 2008: https://go.microsoft.com/fwlink/?LinkId=160658.

Příklady

Následující příklad kódu ukazuje, jak vytvořit vlastní podokno úloh pomocí Add(UserControl, String) metoda.V příkladu jsou použity vlastnosti CustomTaskPane objekt, chcete-li nastavit výchozí vzhled vlastní podokno úloh a definuje obslužnou rutinu události pro DockPositionChanged události.Pro zkompilování tohoto příkladu, zkopírujte kód do ThisAddIn třídy v projektu doplněk pro aplikaci, která podporuje vlastní podokna úloh.Nahraďte výchozí ThisAddIn_Startup metoda ThisAddIn třídy s ThisAddIn_Startup metoda v tomto příkladu.Tento příklad také předpokládá, že projekt obsahuje UserControl s názvem MyUserControla UserControl obsahuje FlowLayoutPanel s názvem 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;
        }
    }
}