ControlCollection.AddRadioButton Method (Double, Double, Double, Double, String) (2007 System)

  • Article

Adds a new RadioButton control to the worksheet in the specified size and location.

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

Syntax

'Declaration
Public Function AddRadioButton ( _
    left As Double, _
    top As Double, _
    width As Double, _
    height As Double, _
    name As String _
) As RadioButton

'Usage
Dim instance As ControlCollection 
Dim left As Double 
Dim top As Double 
Dim width As Double 
Dim height As Double 
Dim name As String 
Dim returnValue As RadioButton 

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

public RadioButton AddRadioButton(
    double left,
    double top,
    double width,
    double height,
    string name
)

public:
RadioButton^ AddRadioButton(
    double left, 
    double top, 
    double width, 
    double height, 
    String^ name
)

public function AddRadioButton(
    left : double, 
    top : double, 
    width : double, 
    height : double, 
    name : String
) : RadioButton

Parameters

  • left
    Type: System.Double

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

  • top
    Type: System.Double

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

  • height
    Type: System.Double

    The height of the control in points.

Return Value

Type: Microsoft.Office.Tools.Excel.Controls.RadioButton
The RadioButton 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

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

When you add multiple radio buttons directly to the document, the radio buttons are not mutually exclusive. You can write code to make the radio buttons mutually exclusive; however, the preferred approach is to add the radio buttons to a user control and then add the user control to the document.

Examples

The following code example adds two RadioButton controls to the top of the worksheet, and then assigns text to each control.

Private Sub ExcelAddRadioButton()

    Dim RadioButton1 As Microsoft.Office.Tools. _
        Excel.Controls.RadioButton = Me.Controls. _
        AddRadioButton(0, 0, 78, 18, "RadioButton1")
    Dim RadioButton2 As Microsoft.Office.Tools. _
        Excel.Controls.RadioButton = Me.Controls. _
        AddRadioButton(0, 18, 78, 18, "RadioButton2")

    RadioButton1.Text = "Bold"
    RadioButton2.Text = "Italic"
    RadioButton2.Checked = False 

End Sub

private void ExcelAddRadioButton()
{

    Microsoft.Office.Tools.Excel.Controls.RadioButton
         radioButton1 = this.Controls.AddRadioButton(
         0, 0, 78, 18, "radioButton1");
    Microsoft.Office.Tools.Excel.Controls.RadioButton
         radioButton2 = this.Controls.AddRadioButton(
         0, 18, 78, 18, "radioButton2");
    radioButton1.Text = "Bold";
    radioButton2.Text = "Italic";
    radioButton2.Checked = false;
}

.NET Framework Security

See Also

Reference

ControlCollection Class

ControlCollection Members

AddRadioButton Overload

Microsoft.Office.Tools.Excel Namespace