ControlExtensions.AddPropertyGrid Method (ControlCollection, Range, Single, Single, String)

Article
07/25/2011

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

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function AddPropertyGrid ( _
    controls As ControlCollection, _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As PropertyGrid

public static PropertyGrid AddPropertyGrid(
    this ControlCollection controls,
    Range range,
    float width,
    float height,
    string name
)

Parameters

controls
Type: Microsoft.Office.Tools.Word.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 Document.Controls property (in an application-level project) or the DocumentBase.Controls property (in a document-level project), this parameter is supplied automatically.

range
Type: Microsoft.Office.Interop.Word.Range
The location of the control.

width
Type: System.Single
The width of the control in points.

height
Type: System.Single
The height of the control in points.

name
Type: System.String
The name that can be used to index the control in the ControlCollection instance.

Return Value

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

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ControlCollection. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

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

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

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.