ControlExtensions.AddRadioButton Method (ControlCollection, Single, Single, Single, Single, String)

Article
07/25/2011

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

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function AddRadioButton ( _
    controls As ControlCollection, _
    left As Single, _
    top As Single, _
    width As Single, _
    height As Single, _
    name As String _
) As RadioButton

public static RadioButton AddRadioButton(
    this ControlCollection controls,
    float left,
    float top,
    float width,
    float height,
    string name
)

Parameters

controls
Type: Microsoft.Office.Tools.Word.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 Document.Controls property (in an application-level project) or the DocumentBase.Controls property (in a document-level project), this parameter is supplied automatically.

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

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 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. To use this example, run it from the ThisDocument class in a document-level project.

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

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