Share via


ControlExtensions.AddButton Method (ControlCollection, Range, Single, Single, String)

Adds a new Button control to the document in the specified size and location.

Namespace:  Microsoft.Office.Tools.Word
Assembly:  Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function AddButton ( _
    controls As ControlCollection, _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As Button
public static Button AddButton(
    this ControlCollection controls,
    Range range,
    float width,
    float height,
    string name
)

Parameters

  • range
    Type: Range

    The location of the control.

  • height
    Type: System.Single

    The height of the control in points.

Return Value

Type: Microsoft.Office.Tools.Word.Controls.Button
The control that was added to the document.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ControlCollection. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception Condition
ArgumentNullException

The name or range argument is nulla null reference (Nothing in Visual Basic), or the name argument has zero length.

ControlNameAlreadyExistsException

A control with the same name is already in the ControlCollection instance.

InvalidRangeException

The range that was specified is not valid.

Remarks

This method enables you to add Button objects to the end of the ControlCollection.

To remove a Button that was added programmatically, use the Remove method.

Examples

The following code example adds a Button control to the first paragraph in the document, and then adds text to the button. To use this example, run it from the ThisDocument class in a document-level project.

Private Sub WordRangeAddButton()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim Button1 As Microsoft.Office.Tools.Word.Controls.Button _
        = Me.Controls.AddButton(Me.Paragraphs(1).Range, 56.25F, _
        17.25F, "Button1")
    Button1.Text = "OK" 
End Sub
private void WordRangeAddButton()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.Button button1 =
        this.Controls.AddButton(this.Paragraphs[1].Range,
        56.25F, 17.25F, "button1");
    button1.Text = "OK";
}

.NET Framework Security

See Also

Reference

ControlExtensions Class

AddButton Overload

Microsoft.Office.Tools.Word Namespace