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

Article
09/25/2012

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 ( _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As RadioButton

'Usage
Dim instance As ControlCollection 
Dim range As Range 
Dim width As Single 
Dim height As Single 
Dim name As String 
Dim returnValue As RadioButton 

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

public RadioButton AddRadioButton(
    Range range,
    float width,
    float height,
    string name
)

public:
RadioButton^ AddRadioButton(
    Range^ range, 
    float width, 
    float height, 
    String^ name
)

public function AddRadioButton(
    range : Range, 
    width : float, 
    height : float, 
    name : String
) : RadioButton

Parameters

range
Type: Range

A Range that provides the location for the control.

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.RadioButton
The RadioButton control that was added to the ControlCollection instance.

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 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 in the first and second paragraphs, and then assigns text to each control.

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

End Sub

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

}

.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