ControlExtensions.AddButton Method (ControlCollection, Range, String)

Article
01/07/2014

Adds a new Button control to the worksheet at the range specified.

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function AddButton ( _
    controls As ControlCollection, _
    range As Range, _
    name As String _
) As Button

public static Button AddButton(
    this ControlCollection controls,
    Range range,
    string name
)

Parameters

controls
Type: Microsoft.Office.Tools.Excel.ControlCollection

The collection to add the control to. Do not supply this parameter yourself. When you call this method on the collection returned by the Worksheet.Controls property (in an application-level project) or the WorksheetBase.Controls property (in a document-level project), this parameter is supplied automatically.

range
Type: Microsoft.Office.Interop.Excel.Range

A Range that provides the bounds for the control.

name
Type: System.String

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

Return Value

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

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. Multi-area ranges cannot be used. The range should be on the same worksheet as the ControlCollection instance.

Remarks

The AddButton method enables you to add Button objects to the end of the ControlCollection. To remove a Button that was previously added programmatically, use the Remove method.

The control automatically resizes when the range is resized.

Examples

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

Private Sub ExcelRangeAddButton()

        Dim Button1 As Microsoft.Office.Tools.Excel. _
          Controls.Button = Me.Controls.AddButton( _
          Me.Range("A1"), "Button1")
        Button1.Text = "OK" 

    End Sub

private void ExcelRangeAddButton()
{

    Microsoft.Office.Tools.Excel.Controls.Button button1 =
        this.Controls.AddButton(this.Range["A1"], "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