ControlExtensions.AddTreeView Method

  • Reference

Definition

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

Overloads

AddTreeView(ControlCollection, Range, Single, Single, String)

Adds a new TreeView control to the document in the specified size and location.
AddTreeView(ControlCollection, Single, Single, Single, Single, String)

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

AddTreeView(ControlCollection, Range, Single, Single, String)

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

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Office::Tools::Word::Controls::TreeView ^ AddTreeView(Microsoft::Office::Tools::Word::ControlCollection ^ controls, Microsoft::Office::Interop::Word::Range ^ range, float width, float height, System::String ^ name);
public static Microsoft.Office.Tools.Word.Controls.TreeView AddTreeView (this Microsoft.Office.Tools.Word.ControlCollection controls, Microsoft.Office.Interop.Word.Range range, float width, float height, string name);
static member AddTreeView : Microsoft.Office.Tools.Word.ControlCollection * Microsoft.Office.Interop.Word.Range * single * single * string -> Microsoft.Office.Tools.Word.Controls.TreeView
<Extension()>
Public Function AddTreeView (controls As ControlCollection, range As Range, width As Single, height As Single, name As String) As TreeView

Parameters

controls
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 Controls property (in an application-level project) or the Controls property (in a document-level project), this parameter is supplied automatically.

range
Range

The location of the control.

width
Single

The width of the control in points.

height
Single

The height of the control in points.

name
String

The name that can be used to index the control in the ControlCollection instance.

Returns

TreeView

The control that was added to the document.

Exceptions

ArgumentNullException

The name or range argument is null, 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.

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

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");
}

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

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.

Applies to

AddTreeView(ControlCollection, Single, Single, Single, Single, String)

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

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Office::Tools::Word::Controls::TreeView ^ AddTreeView(Microsoft::Office::Tools::Word::ControlCollection ^ controls, float left, float top, float width, float height, System::String ^ name);
public static Microsoft.Office.Tools.Word.Controls.TreeView AddTreeView (this Microsoft.Office.Tools.Word.ControlCollection controls, float left, float top, float width, float height, string name);
static member AddTreeView : Microsoft.Office.Tools.Word.ControlCollection * single * single * single * single * string -> Microsoft.Office.Tools.Word.Controls.TreeView
<Extension()>
Public Function AddTreeView (controls As ControlCollection, left As Single, top As Single, width As Single, height As Single, name As String) As TreeView

Parameters

controls
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 Controls property (in an application-level project) or the Controls property (in a document-level project), this parameter is supplied automatically.

left
Single

The distance in points between the left edge of the control and the left edge of the document.

top
Single

The distance in points between the top edge of the control and the top edge of the document.

width
Single

The width of the control in points.

height
Single

The height of the control in points.

name
String

The name that can be used to index the control in the ControlCollection instance.

Returns

TreeView

The control that was added to the document.

Exceptions

ArgumentNullException

The name argument is null or has zero length.

ControlNameAlreadyExistsException

A control with the same name is already in the ControlCollection instance.

Examples

The following code example adds a TreeView control to the document, and then adds a parent node and two child nodes to the control. To use this example, run it from the ThisDocument class in a document-level project.

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

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

Private Sub WordAddTreeView()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim TreeView1 As Microsoft.Office.Tools.Word.Controls. _
        TreeView = Me.Controls.AddTreeView(0, 0, 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

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.

Applies to