Propriedade CustomTaskPane.Height

Obtém ou define a altura do painel de tarefas personalizado, em pontos.

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

Sintaxe

'Declaração
Property Height As Integer
    Get
    Set
int Height { get; set; }

Valor de propriedade

Tipo: System.Int32
A altura do painel de tarefas personalizado, em pontos.

Exceções

Exceção Condição
COMException

O valor da DockPosition é a propriedade Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRight ou Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionLeft ao tentar definir o Height propriedade.

- ou -

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

ObjectDisposedException

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

Comentários

Não use o Height propriedade se o painel de tarefas personalizado é encaixado para a esquerda ou direita da janela do documento. Se o DockPosition é a propriedade Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRight ou Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionLeft, o Height propriedade retornará 0 e lança um COMException se você tentar definir o proprietário.

A altura máxima depende da posição de encaixe. Quando o painel de tarefas personalizado é encaixado na parte superior ou inferior da janela do documento, a altura máxima é aproximadamente a metade da altura da tela. Quando o painel de tarefas personalizado é flutuante, não há nenhuma altura máxima.

A altura mínima depende de vários fatores e pode mudar em futuras versões do Microsoft Office. Se você tentar definir o Height um valor menor que a altura mínima de propriedade, o aplicativo automaticamente irá reatribuir a Height propriedade para a altura mínima.

Exemplos

O exemplo de código a seguir cria um painel de tarefas personalizado que tem uma altura especificada quando ele for exibido na frente da janela do aplicativo ativo. 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

Consulte também

Referência

CustomTaskPane Interface

Namespace Microsoft.Office.Tools