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

  • Article

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

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

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

public PropertyGrid AddPropertyGrid(
    Range range,
    float width,
    float height,
    string name
)

public:
PropertyGrid^ AddPropertyGrid(
    Range^ range, 
    float width, 
    float height, 
    String^ name
)

public function AddPropertyGrid(
    range : Range, 
    width : float, 
    height : float, 
    name : String
) : PropertyGrid

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

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

Examples

The following code example adds a PropertyGrid control to the first paragraph and a Button control to the third paragraph. It then displays the properties of the button in the property grid.

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

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

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

    PropertyGrid1.SelectedObject = Button1

End Sub

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

    Microsoft.Office.Tools.Word.Controls.PropertyGrid
         propertyGrid1 = this.Controls.AddPropertyGrid(
         this.Paragraphs[1].Range, 150, 150, "propertyGrid1");

    Microsoft.Office.Tools.Word.Controls.Button button1 =
        this.Controls.AddButton(this.Paragraphs[3].Range,
        56.25F, 17.25F, "button1");
    button1.Text = "OK";

    propertyGrid1.SelectedObject = button1;
}

.NET Framework Security

See Also

Reference

ControlCollection Class

ControlCollection Members

AddPropertyGrid Overload

Microsoft.Office.Tools.Word Namespace