ControlCollection.AddCheckBox Method (, Single, Single, String) (2007 System)
Adds a new CheckBox 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 AddCheckBox ( _
range As Range, _
width As Single, _
height As Single, _
name As String _
) As CheckBox
'Usage
Dim instance As ControlCollection
Dim range As Range
Dim width As Single
Dim height As Single
Dim name As String
Dim returnValue As CheckBox
returnValue = instance.AddCheckBox(range, _
width, height, name)
public CheckBox AddCheckBox(
Range range,
float width,
float height,
string name
)
public:
CheckBox^ AddCheckBox(
Range^ range,
float width,
float height,
String^ name
)
public function AddCheckBox(
range : Range,
width : float,
height : float,
name : String
) : CheckBox
Parameters
range
Type: RangeA Range that provides the location for the control.
width
Type: System.SingleThe width of the control in points.
height
Type: System.SingleThe height of the control in points.
name
Type: System.StringThe name that can be used to index the control in the ControlCollection instance.
Return Value
Type: Microsoft.Office.Tools.Word.Controls.CheckBox
The CheckBox 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 CheckBox objects to the end of the ControlCollection.
To remove a CheckBox that was added programmatically, use the Remove method.
Examples
The following code example adds a CheckBox control to the first paragraph in the document, and then adds text to the check box.
Private Sub WordRangeAddCheckBox()
Me.Paragraphs(1).Range.InsertParagraphBefore()
Dim CheckBox1 As Microsoft.Office.Tools.Word.Controls. _
CheckBox = Me.Controls.AddCheckBox(Me.Paragraphs(1). _
Range, 78, 18, "CheckBox1")
CheckBox1.Text = "Underline"
End Sub
private void WordRangeAddCheckBox()
{
this.Paragraphs[1].Range.InsertParagraphBefore();
Microsoft.Office.Tools.Word.Controls.CheckBox checkBox1 =
this.Controls.AddCheckBox(this.Paragraphs[1].Range,
78, 18, "checkBox1");
checkBox1.Text = "Underline";
}
.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.