ControlCollection.AddPropertyGrid Method (Single, Single, Single, Single, String) (2003 System)

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

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

Syntax

'Declaration
Public Function AddPropertyGrid ( _
    left As Single, _
    top As Single, _
    width As Single, _
    height As Single, _
    name As String _
) As PropertyGrid
'Usage
Dim instance As ControlCollection
Dim left As Single
Dim top As Single
Dim width As Single
Dim height As Single
Dim name As String
Dim returnValue As PropertyGrid

returnValue = instance.AddPropertyGrid(left, _
    top, width, height, name)
public PropertyGrid AddPropertyGrid(
    float left,
    float top,
    float width,
    float height,
    string name
)

Parameters

  • left
    Type: System.Single
    The distance in pixels between the left edge of the control and the left edge of the document.
  • top
    Type: System.Single
    The distance in pixels between the top edge of the control and the top edge of the document.
  • height
    Type: System.Single
    The height of the control in pixels.

Return Value

Type: Microsoft.Office.Tools.Word.Controls.PropertyGrid
The PropertyGrid control that was added to the ControlCollection instance.

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 PropertyGrid objects to the end of the ControlCollection. To remove a PropertyGrid that was previously added programmatically, use the Remove method.

Examples

The following code example adds a PropertyGrid control to the start of the document and a Button control beneath the PropertyGrid control. It then displays the properties of the button in the property grid.

Private Sub WordAddPropertyGrid()
    Me.Paragraphs(1).Range.InsertParagraphBefore()

    Dim PropertyGrid1 As Microsoft.Office.Tools.Word.Controls. _
        PropertyGrid = Me.Controls.AddPropertyGrid(0, 0, 150, _
        150, "PropertyGrid1")

    Dim Button1 As Microsoft.Office.Tools.Word.Controls. _
        Button = Me.Controls.AddButton(0, 160, 56.25F, 17.25F, _
        "Button1")
    Button1.Text = "OK"

    PropertyGrid1.SelectedObject = Button1

End Sub 

private void WordAddPropertyGrid()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();

    Microsoft.Office.Tools.Word.Controls.PropertyGrid
         propertyGrid1 = this.Controls.AddPropertyGrid(
         0, 0, 150, 150, "propertyGrid1");

    Microsoft.Office.Tools.Word.Controls.Button button1 =
        this.Controls.AddButton(0, 160, 56.25F, 17.25F, "button1");
    button1.Text = "OK";

    propertyGrid1.SelectedObject = button1;
}

Permissions

See Also

Reference

ControlCollection Class

ControlCollection Members

AddPropertyGrid Overload

Microsoft.Office.Tools.Word Namespace