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

  • Article

Adds a new RadioButton 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 AddRadioButton ( _
    left As Single, _
    top As Single, _
    width As Single, _
    height As Single, _
    name As String _
) As RadioButton

'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 RadioButton 

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

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

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

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

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.

  • height
    Type: System.Single

    The height of the control in points.

Return Value

Type: Microsoft.Office.Tools.Word.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

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

To remove a RadioButton that was 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 document, and then assigns text to each control.

Private Sub WordAddRadioButton()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim RadioButton1 As Microsoft.Office.Tools.Word.Controls. _
        RadioButton = Me.Controls.AddRadioButton(0, 0, 78, 18, _
        "RadioButton1")
    Dim RadioButton2 As Microsoft.Office.Tools.Word.Controls. _
        RadioButton = Me.Controls.AddRadioButton(0, 18, 78, 18, _
        "RadioButton2")
    RadioButton1.Text = "Bold"
    RadioButton2.Text = "Italic" 

End Sub

private void WordAddRadioButton()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.RadioButton
         radioButton1 = this.Controls.AddRadioButton(
         0, 0, 78, 18, "radioButton1");
    Microsoft.Office.Tools.Word.Controls.RadioButton
         radioButton2 = this.Controls.AddRadioButton(
         0, 18, 78, 18, "radioButton2");
    radioButton1.Text = "Bold";
    radioButton2.Text = "Italic";
}

.NET Framework Security

See Also

Reference

ControlCollection Class

ControlCollection Members

AddRadioButton Overload

Microsoft.Office.Tools.Word Namespace