ControlCollection.AddButton Method (Single, Single, Single, Single, String) (2007 System)

Article
09/25/2012

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

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

Syntax

'Declaration
Public Function AddButton ( _
    left As Single, _
    top As Single, _
    width As Single, _
    height As Single, _
    name As String _
) As Button

'Usage
Dim instance As ControlCollection 
Dim left As Single 
Dim top As Single 
Dim width As Single 
Dim height As Single 
Dim name As String 
Dim returnValue As Button 

returnValue = instance.AddButton(left, _
    top, width, height, name)

public Button AddButton(
    float left,
    float top,
    float width,
    float height,
    string name
)

public:
Button^ AddButton(
    float left, 
    float top, 
    float width, 
    float height, 
    String^ name
)

public function AddButton(
    left : float, 
    top : float, 
    width : float, 
    height : float, 
    name : String
) : Button

Parameters

left
Type: System.Single

The distance in points between the left edge of the control and the left edge of the document.

top
Type: System.Single

The distance in points between the top edge of the control and the top edge of the document.

width
Type: System.Single

The width of the control in points.

height
Type: System.Single

The height of the control in points.

name
Type: System.String

The name that can be used to index the control in the ControlCollection instance.

Return Value

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

Exceptions

Exception	Condition
ArgumentNullException	The name argument is nulla null reference (Nothing in Visual Basic) or has zero length.
ControlNameAlreadyExistsException	A control with the same name is already in the ControlCollection instance.

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 start of the document, and then adds text to the button.

Private Sub WordAddButton()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim button1 As Microsoft.Office.Tools.Word.Controls.Button _
        = Me.Controls.AddButton(0, 0, 56.25F, 17.25F, "Button1")
    button1.Text = "OK" 

End Sub

private void WordAddButton()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.Button button1 =
        this.Controls.AddButton(0, 0, 56.25F, 17.25F,
        "button1");
    button1.Text = "OK";
}

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via