CustomTaskPane.DockPosition-Eigenschaft (2007 System)

Aktualisiert: November 2007

Ruft einen Wert ab, der die Position des benutzerdefinierten Aufgabenbereichs relativ zum Anwendungsfenster angibt, oder legt diesen fest.

Namespace:  Microsoft.Office.Tools
Assembly:  Microsoft.Office.Tools.Common.v9.0 (in Microsoft.Office.Tools.Common.v9.0.dll)

Syntax

Public Property DockPosition As MsoCTPDockPosition

Dim instance As CustomTaskPane
Dim value As MsoCTPDockPosition

value = instance.DockPosition

instance.DockPosition = value
public MsoCTPDockPosition DockPosition { get; set; }

Eigenschaftenwert

Typ: Microsoft.Office.Core.MsoCTPDockPosition

Einer der Microsoft.Office.Core.MsoCTPDockPosition-Werte. Der Standardwert ist Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRight.

Ausnahmen

Ausnahme Bedingung
ObjectDisposedException

Die Dispose-Methode des CustomTaskPane wurde bereits aufgerufen.

COMException

Der Wert der DockPositionRestrict-Eigenschaft ist Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRestrictNoChange, wenn Sie den Wert der DockPosition-Eigenschaft zu ändern versuchen.

- oder -

wenn Sie versuchen, diese Eigenschaft im Ereignishandler für das DockPositionChanged-Ereignis oder das VisibleChanged-Ereignis festzulegen.

Hinweise

In der folgenden Tabelle werden die Werte der Microsoft.Office.Core.MsoCTPDockPosition-Enumeration aufgeführt.

Wert

Beschreibung

msoCTPDockPositionLeft

Dockt den benutzerdefinierten Aufgabenbereich an die linke Seite des Fensters an.

msoCTPDockPositionTop

Dockt den benutzerdefinierten Aufgabenbereich an den oberen Rand des Fensters an.

msoCTPDockPositionRight

Dockt den benutzerdefinierten Aufgabenbereich an die rechte Seite des Fensters an.

msoCTPDockPositionBottom

Dockt den benutzerdefinierten Aufgabenbereich an den unteren Rand des Fensters an.

msoCTPDockPositionFloating

Dockt den benutzerdefinierten Aufgabenbereich vor dem Fenster an. Der Benutzer kann den benutzerdefinierten Aufgabenbereich an eine beliebige Position im Fenster ziehen.

Beispiele

Mit dem folgenden Codebeispiel werden ein benutzerdefinierter Aufgabenbereich erstellt und verschiedene Standardgrößen für Situationen konfiguriert, in denen der Bereich vor der aktiven Anwendung angezeigt wird oder angedockt ist. Dieses Codebeispiel ist Teil eines umfangreicheren Beispiels, das für die CustomTaskPane-Klasse bereitgestellt wird.

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 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);
}

Berechtigungen

Siehe auch

Referenz

CustomTaskPane-Klasse

CustomTaskPane-Member

Microsoft.Office.Tools-Namespace