ControlExtensions.AddRichTextBox, méthode (ControlCollection, Range, String)

  • Article

Ajoute un nouveau contrôle RichTextBox à la feuille de calcul à la plage spécifiée.

Espace de noms :  Microsoft.Office.Tools.Excel
Assembly :  Microsoft.Office.Tools.Excel.v4.0.Utilities (dans Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)

Syntaxe

'Déclaration
<ExtensionAttribute> _
Public Shared Function AddRichTextBox ( _
    controls As ControlCollection, _
    range As Range, _
    name As String _
) As RichTextBox

public static RichTextBox AddRichTextBox(
    this ControlCollection controls,
    Range range,
    string name
)

Paramètres

  • controls
    Type : Microsoft.Office.Tools.Excel.ControlCollection
    Collection à laquelle le contrôle doit être ajouté.Ne fournissez pas ce paramètre vous-même.Lorsque vous appelez cette méthode sur la collection retournée par la propriété Worksheet.Controls (dans un projet au niveau de l'application) ou la propriété WorksheetBase.Controls (dans un projet au niveau du document), ce paramètre est fourni automatiquement.

Valeur de retour

Type : Microsoft.Office.Tools.Excel.Controls.RichTextBox
Contrôle RichTextBox qui a été ajouté à l'instance de ControlCollection.

Remarque sur l'utilisation

En Visual Basic et C#, vous pouvez appeler cette méthode comme une méthode d'instance sur n'importe quel objet de type ControlCollection. Lorsque vous utilisez la syntaxe des méthodes d'instance pour appeler cette méthode, omettez le premier paramètre. Pour plus d'informations, consultez Méthodes d'extension (Visual Basic) ou Méthodes d'extension (Guide de programmation C#).

Exceptions

Exception Condition
ArgumentNullException

L'argument de nom ou de plage a la valeur nullune référence null (Nothing en Visual Basic) ou l'argument de nom a une longueur nulle.
ControlNameAlreadyExistsException

Un contrôle du même nom se trouve déjà dans l'instance de ControlCollection.
InvalidRangeException

La plage spécifiée n'est pas valide.Les plages sur plusieurs zones ne peuvent pas être utilisées.La plage doit se trouver dans la même feuille de calcul que l'instance de ControlCollection.

Notes

La méthode AddRichTextBox vous permet d'ajouter des objets RichTextBox à la fin de ControlCollection.Pour supprimer un RichTextBox précédemment ajouté par programme, utilisez la méthode Remove.

Le contrôle est redimensionné automatiquement lorsque la plage est redimensionnée.

Exemples

L'exemple de code suivant ajoute un contrôle RichTextBox aux cellules A1 à B2, assigne du texte au contrôle, puis met en forme le texte.Pour utiliser cet exemple, exécutez-le à partir de la classe Sheet1 dans un projet au niveau du document.

Private Sub ExcelRangeAddRichTextBox()

    Dim RichTextBox1 As Microsoft.Office.Tools. _
        Excel.Controls.RichTextBox = Me.Controls. _
        AddRichTextBox(Me.Range("A1", "B2"), _
        "RichTextBox1")

    RichTextBox1.Text = "Sample text"
    RichTextBox1.Select(0, 6)
    RichTextBox1.SelectionFont = New Font( _
        "Times New Roman", 10, FontStyle.Bold)

End Sub

private void ExcelRangeAddRichTextBox()
{

    Microsoft.Office.Tools.Excel.Controls.RichTextBox
         richTextBox1 = this.Controls.AddRichTextBox(
         this.Range["A1", "B2"], "richTextBox1");
    richTextBox1.Text = "Sample text";
    richTextBox1.Select(0, 6);
    richTextBox1.SelectionFont = new Font("Times New Roman",
        10, FontStyle.Bold);
}

Sécurité .NET Framework

Voir aussi

Référence

ControlExtensions Classe

AddRichTextBox, surcharge

Microsoft.Office.Tools.Excel, espace de noms