Propriedade CustomTaskPane.DockPosition

Artigo
08/01/2011

Obtém ou define um valor que especifica onde o painel de tarefas personalizado está localizado em relação à janela do aplicativo.

Namespace: Microsoft.Office.Tools
Assembly: Microsoft.Office.Tools.Common (em Microsoft.Office.Tools.Common.dll)

Sintaxe

'Declaração
Property DockPosition As MsoCTPDockPosition
    Get
    Set

MsoCTPDockPosition DockPosition { get; set; }

Valor de propriedade

Tipo: Microsoft.Office.Core.MsoCTPDockPosition
Dentre as Microsoft.Office.Core.MsoCTPDockPosition valores.The default is Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRight.

Exceções

Exceção	Condição
ObjectDisposedException	O Dispose() método de CustomTaskPane já foi chamado.
COMException	O valor da DockPositionRestrict é a propriedade Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRestrictNoChange ao tentar alterar o valor da DockPosition propriedade. - ou - Tentar definir essa propriedade no manipulador de eventos para o DockPositionChanged ou VisibleChanged de evento.

ObjectDisposedException

O Dispose() método de CustomTaskPane já foi chamado.

COMException

O valor da DockPositionRestrict é a propriedade Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRestrictNoChange ao tentar alterar o valor da DockPosition propriedade.

- ou -

Tentar definir essa propriedade no manipulador de eventos para o DockPositionChanged ou VisibleChanged de evento.

Comentários

A tabela a seguir lista os valores de Microsoft.Office.Core.MsoCTPDockPosition enumeração.

Value	Description
msoCTPDockPositionLeft	Encaixa o painel de tarefas personalizado para o lado esquerdo da janela.
msoCTPDockPositionTop	Encaixa o painel de tarefas personalizado na parte superior da janela.
msoCTPDockPositionRight	Encaixa o painel de tarefas personalizado para o lado direito da janela.
msoCTPDockPositionBottom	Encaixa o painel de tarefas personalizado para a parte inferior da janela.
msoCTPDockPositionFloating	Exibe o painel de tarefas personalizado na frente da janela. O usuário pode arrastar o painel de tarefas para qualquer local na janela.

Exemplos

O exemplo de código a seguir cria um painel de tarefas personalizado e configura os tamanhos padrão diferente quando o painel exibe na frente da janela do aplicativo ativo, e quando ela estiver encaixada. Este exemplo de código é parte de um exemplo maior fornecido para CustomTaskPane.

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

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiáveis.

Consulte também

Referência

CustomTaskPane Interface

Namespace Microsoft.Office.Tools

Compartilhar via