CustomTaskPane.Width Propriété

Définition

Espace de noms:

Microsoft.Office.Tools

Assemblys:

Microsoft.Office.Tools.Common.dll, Microsoft.Office.Tools.Common.v4.0.Utilities.dll, Microsoft.Office.Tools.Excel.v4.0.Utilities.dll, Microsoft.Office.Tools.Outlook.v4.0.Utilities.dll, Microsoft.Office.Tools.Word.v4.0.Utilities.dll

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

public:
 property int Width { int get(); void set(int value); };

public int Width { get; set; }

member this.Width : int with get, set

Public Property Width As Integer

Valeur de propriété

Int32

Largeur, en points, du volet Office personnalisé.

Exceptions

COMException

La valeur de la DockPosition propriété est Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionTop ou Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionBottom lorsque vous essayez de définir la Width propriété.-ou-Vous essayez de définir la propriété dans le Width gestionnaire d’événements pour l’événement DockPositionChanged ou VisibleChanged .

ObjectDisposedException

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

Exemples

L’exemple de code suivant crée un volet Office personnalisé qui a une largeur par défaut différente lorsqu’il s’affiche devant la fenêtre d’application active et lorsqu’il est ancré sur le côté gauche ou droit de la fenêtre. Cet exemple de code fait partie d’un exemple plus grand fourni pour CustomTaskPane.

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

Remarques

N’utilisez pas la Width propriété si le volet Office personnalisé est ancré en haut ou en bas de la fenêtre de document. Si la DockPosition propriété est Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionTop ou Microsoft.Office.Core.MsoCTPDockPosition.msoCTPDockPositionBottom, la Width propriété retourne 0 et lève un COMException si vous essayez de la définir.

La largeur maximale dépend de la position de l’ancrage. Lorsque le volet Office personnalisé est ancré à gauche ou à droite de la fenêtre de document, la largeur maximale est environ la moitié de la largeur de l’écran. Lorsque le volet Office personnalisé est flottant, il n’y a pas de largeur maximale.

La largeur minimale dépend de plusieurs facteurs et peut changer dans les versions ultérieures de Microsoft Office. Si vous essayez de définir la Width propriété sur une valeur inférieure à la largeur minimale, l’application réaffecte automatiquement la Width propriété à la largeur minimale.