ControlExtensions.AddRichTextBox - метод (ControlCollection, Double, Double, Double, Double, String)

Статья
01/10/2014

Добавляет в заданное расположение на листе новый элемент управления RichTextBox указанного размера.

Пространство имен: Microsoft.Office.Tools.Excel
Сборка: Microsoft.Office.Tools.Excel.v4.0.Utilities (в Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)

Синтаксис

'Декларация
<ExtensionAttribute> _
Public Shared Function AddRichTextBox ( _
    controls As ControlCollection, _
    left As Double, _
    top As Double, _
    width As Double, _
    height As Double, _
    name As String _
) As RichTextBox

public static RichTextBox AddRichTextBox(
    this ControlCollection controls,
    double left,
    double top,
    double width,
    double height,
    string name
)

Параметры

controls
Тип: Microsoft.Office.Tools.Excel.ControlCollection
Коллекция, в которую добавляется элемент управления.Не формируйте значение этого параметра самостоятельно.При вызове этого метода для коллекции, возвращаемой свойством Worksheet.Controls (в проекте уровня приложения) или свойством WorksheetBase.Controls (в проекте уровня документа), данный параметр предоставляется автоматически.

left
Тип: System.Double
Расстояние в пунктах между левым краем элемента управления и левым краем листа.

top
Тип: System.Double
Расстояние в пунктах между верхним краем элемента управления и верхним краем листа.

width
Тип: System.Double
Ширина элемента управления в пунктах.

height
Тип: System.Double
Высота элемента управления в пунктах.

name
Тип: System.String
Имя элемента управления.

Возвращаемое значение

Тип: Microsoft.Office.Tools.Excel.Controls.RichTextBox
Элемент управления RichTextBox, добавленный в экземпляр ControlCollection.

Примечание об использовании

В Visual Basic и C# этот метод можно вызывать как метод экземпляра для любого объекта типа ControlCollection. При вызове метода для экземпляра следует опускать первый параметр. Дополнительные сведения см. в разделе Методы расширения (Visual Basic) или Методы расширения (Руководство по программированию в C#).

Исключения

Исключение	Условие
ArgumentNullException	Аргумент имени равен nullссылка NULL (Nothing в Visual Basic) или имеет нулевую длину.
ControlNameAlreadyExistsException	Элемент управления с таким именем уже имеется в данном экземпляре ControlCollection.

Заметки

Метод AddRichTextBox используется для добавления объектов RichTextBox в конец ControlCollection. Чтобы удалить добавленный программно элемент управления RichTextBox, воспользуйтесь методом Remove.

Примеры

В приведенном ниже примере в верхнюю часть листа добавляется элемент управления RichTextBox, после чего в этот элемент управления заносится текст, который затем форматируется. Чтобы использовать этот пример, запустите его из класса Sheet1 в проекте уровня документа.

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

Безопасность платформы .NET Framework

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.

См. также

Ссылки

ControlExtensions Класс

AddRichTextBox - перегрузка

Microsoft.Office.Tools.Excel - пространство имен

Поделиться через