Partager via


CustomTaskPane.Height, propriété

Obtient ou définit la hauteur, en points, du volet Office personnalisé.

Espace de noms :  Microsoft.Office.Tools
Assembly :  Microsoft.Office.Tools.Common (dans Microsoft.Office.Tools.Common.dll)

Syntaxe

'Déclaration
Property Height As Integer
int Height { get; set; }

Valeur de propriété

Type : System.Int32
Hauteur, en points, du volet Office personnalisé.

Exceptions

Exception Condition
COMException

La valeur de la propriété DockPosition est Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRight ou Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionLeft lorsque vous essayez de définir la propriété Height.

ou

Vous essayez de définir la propriété Height dans le gestionnaire d'événements pour l'événement DockPositionChanged ou VisibleChanged.

ObjectDisposedException

La méthode Dispose du CustomTaskPane a déjà été appelée.

Notes

N'utilisez pas la propriété Height si le volet de tâches personnalisé est ancré à gauche ou à droite de la fenêtre de document.Si la propriété DockPosition est Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionRight ou Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionLeft, la propriété Height retourne 0 et lève une COMException si vous essayez de la définir.

La hauteur maximale dépend de la position d'ancrage.Lorsque le volet de tâches personnalisé est ancré en haut ou en bas de la fenêtre du document, la hauteur maximale est approximativement la moitié de la hauteur de l'écran.Lorsque le volet de tâches personnalisé est flottant, il n'y a aucune hauteur maximale.

La hauteur minimale dépend de plusieurs facteurs et peut changer dans les versions ultérieures de Microsoft Office.Si vous tentez d'affecter à la propriété Height une valeur inférieure à la hauteur minimale, l'application redéfinira automatiquement la propriété Height à la hauteur minimale.

Exemples

L'exemple de code suivant crée un volet de tâches personnalisé qui présente une hauteur spécifique lorsqu'il apparaît devant la fenêtre d'application active.Cet exemple de code fait partie d'un exemple plus complet, fourni pour 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);
}

Sécurité .NET Framework

Voir aussi

Référence

CustomTaskPane Interface

Microsoft.Office.Tools, espace de noms