ControlExtensions.AddLabel - метод (ControlCollection, Range, Single, Single, String)

Статья
01/10/2014

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

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

Синтаксис

'Декларация
<ExtensionAttribute> _
Public Shared Function AddLabel ( _
    controls As ControlCollection, _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As Label

public static Label AddLabel(
    this ControlCollection controls,
    Range range,
    float width,
    float height,
    string name
)

Параметры

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

range
Тип: Microsoft.Office.Interop.Word.Range
Расположение элемента управления.

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

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

name
Тип: System.String
Имя, которое можно использовать для индексации элемента управления в экземпляре класса ControlCollection.

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

Тип: Microsoft.Office.Tools.Word.Controls.Label
Элемент управления, добавленный в документ.

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

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

Исключения

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

Заметки

Этот метод используется для добавления объектов Label в конец коллекции ControlCollection.

Чтобы удалить добавленный программно объект Label, воспользуйтесь методом Remove.

Примеры

В приведенном ниже примере кода в первый абзац документа добавляется элемент управления Label, после чего текст элемента управления заменяется на Имя. Чтобы использовать этот пример, запустите его из класса ThisDocument в проекте уровня документа.

Private Sub WordRangeAddLabel()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim Label1 As Microsoft.Office.Tools.Word.Controls.Label _
        = Me.Controls.AddLabel(Me.Paragraphs(1).Range, 75, _
            17.25F, "Label1")
    Label1.Text = "First Name"
End Sub

private void WordRangeAddLabel()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.Label
        label1 = this.Controls.AddLabel(
        this.Paragraphs[1].Range, 75, 17.25F, "label1");
    label1.Text = "First Name";
}

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

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

См. также

Ссылки

ControlExtensions Класс

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

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

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