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

  • Article

Adds a new CheckedListBox 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 AddCheckedListBox ( _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As CheckedListBox

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

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

public CheckedListBox AddCheckedListBox(
    Range range,
    float width,
    float height,
    string name
)

public:
CheckedListBox^ AddCheckedListBox(
    Range^ range, 
    float width, 
    float height, 
    String^ name
)

public function AddCheckedListBox(
    range : Range, 
    width : float, 
    height : float, 
    name : String
) : CheckedListBox

Parameters

  • range
    Type: Range

    A Range that provides the location for the control.

  • height
    Type: System.Single

    The height of the control in points.

Return Value

Type: Microsoft.Office.Tools.Word.Controls.CheckedListBox
The CheckedListBox 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 CheckedListBox objects to the end of the ControlCollection.

To remove a CheckedListBox that was added programmatically, use the Remove method.

Examples

The following code example adds a CheckedListBox control to the first paragraph in the document, adds two items to the checked list box, and then selects the First Item check box.

Private Sub WordRangeAddCheckedListBox()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim CheckedListBox1 As Microsoft.Office.Tools.Word. _
        Controls.CheckedListBox = Me.Controls.AddCheckedListBox( _
        Me.Paragraphs(1).Range, 90, 66.75F, "CheckedListBox1")
    CheckedListBox1.Items.Add("First Item")
    CheckedListBox1.Items.Add("Second Item")
    CheckedListBox1.SetItemChecked(0, True)

End Sub

private void WordRangeAddCheckedListBox()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.CheckedListBox 
        checkedListBox1 = this.Controls.AddCheckedListBox(
        this.Paragraphs[1].Range, 90, 66.75F, "checkedListBox1");
    checkedListBox1.Items.Add("First Item");
    checkedListBox1.Items.Add("Second Item");
    checkedListBox1.SetItemChecked(0, true);
}

.NET Framework Security

See Also

Reference

ControlCollection Class

ControlCollection Members

AddCheckedListBox Overload

Microsoft.Office.Tools.Word Namespace