CustomTaskPane – rozhraní

Článek
08/11/2011

Představuje vlastní úlohapodokno vaplikacesady systém Microsoft Office.

Obor názvů: Microsoft.Office.Tools
Sestavení: Microsoft.Office.Tools.Common (v Microsoft.Office.Tools.Common.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ává UserControl , který poskytuje uživatel rozhraní úloha podokno.
	DockPosition	Získá nebo nastaví hodnotu, která určuje, kde je umístěn vzhledem kokno aplikace úlohapodokno .
	DockPositionRestrict	Získá nebo nastaví hodnotu, která zabrání úloha podokno právě ukotvený v zadaném umístění.
	Height	Získá nebo nastaví výšku úloha podoknov bodech.
	Title	Získá název vlastní úloha podokno.
	Visible	Získá nebo nastaví hodnotu, která určuje, zda je zobrazenpodokno úloha.
	Width	Získá nebo nastaví šířku úloha podoknov bodech.
	Window	Získá spojenou s vlastní úlohapodokno okno dokumentu .

Na začátek

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.)

Na začátek

Události

	Název	Popis
	DockPositionChanged	Dojde, když uživatel změní polohu úlohavlastnípodokno ukotvit nebo kód změní hodnotu DockPositionvlastnost.
	VisibleChanged	Dojde, když uživatel zobrazí nebo zavře vlastní úloha podoknonebo kód změní hodnotu Visible vlastnost.

Na začátek

Poznámky

Použít CustomTaskPane objekt v aplikace-úroveň doplněk upravit vlastní úloha podoknonebo reagovat při změně umístění nebo viditelnost úloha podokno . Podokna úloh jsou panely uživatelrozhraní , které obvykle ukotven k okrajiokno aplikace. Informace o tom, jak vytvořit vlastní úloha podokna Custom Task Panes Overview.

Řídit velikost nebo umístění vlastní úloha podokno, můžete pomocí vlastnosti jako Height, Width, a Visible.

Chcete-li reagovat po přesunutí nebo změny viditelnosti úloha podokno , zpracovat DockPositionChanged a VisibleChanged události.

Poznámka

Toto rozhraní je implementováno modulem runtime nástrojů Visual Studio Tools for Office. Rozhraní není určeno k implementaci do vašeho kódu. Další informace naleznete v tématu Visual Studio Tools for Office Runtime Overview.

Použití

Tato dokumentace popisuje verzi tohoto typu, který je používán v projektech systému Office cílených na rozhraní .NET Framework 4. V projektech cílených na rozhraní .NET Framework 3.5 může mít tento typ rozdílné členy a příklady kódů pro tento typ nemusí 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í úloha podokno pomocí Add(UserControl, String) metoda. V příkladu vlastnosti CustomTaskPanedefinuje obslužnou rutinu událost proobjekt nastavení výchozí vzhled úlohapodoknoa DockPositionChangedudálost. V tomto příkladu kompilace, zkopírujte kód do ThisAddIntřída v doplněkaplikaceprojekt pro aplikace , která podporuje podoken úloha . Nahradit výchozí ThisAddIn_Startup metoda ThisAddIn třída se ThisAddIn_Startup metoda v 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;
        }
    }
}