Share via


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

Adds a new TreeView 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 AddTreeView ( _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As TreeView
'Usage
Dim instance As ControlCollection 
Dim range As Range 
Dim width As Single 
Dim height As Single 
Dim name As String 
Dim returnValue As TreeView 

returnValue = instance.AddTreeView(range, _
    width, height, name)
public TreeView AddTreeView(
    Range range,
    float width,
    float height,
    string name
)
public:
TreeView^ AddTreeView(
    Range^ range, 
    float width, 
    float height, 
    String^ name
)
public function AddTreeView(
    range : Range, 
    width : float, 
    height : float, 
    name : String
) : TreeView

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.TreeView
The TreeView 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 TreeView objects to the end of the ControlCollection.

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

Examples

The following code example adds a TreeView control to the first paragraph in the document, and then adds a parent node and two child nodes to the control.

Private Sub WordRangeAddTreeView()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim TreeView1 As Microsoft.Office.Tools.Word.Controls. _
        TreeView = Me.Controls.AddTreeView(Me.Paragraphs(1). _
        Range, 90.75F, 72.75F, "TreeView1")

    TreeView1.Nodes.Add("Customer Name")
    TreeView1.Nodes(0).Nodes.Add("First Name")
    TreeView1.Nodes(0).Nodes.Add("Last Name")

End Sub
private void WordRangeAddTreeView()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.TreeView
         treeView1 = this.Controls.AddTreeView(
         this.Paragraphs[1].Range, 90.75F, 72.75F, "treeView1");

    treeView1.Nodes.Add("Customer Name");
    treeView1.Nodes[0].Nodes.Add("First Name");
    treeView1.Nodes[0].Nodes.Add("Last Name");
}

.NET Framework Security

See Also

Reference

ControlCollection Class

ControlCollection Members

AddTreeView Overload

Microsoft.Office.Tools.Word Namespace