ControlExtensions.AddPropertyGrid Method (ControlCollection, Double, Double, Double, Double, String)

  • Article

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

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function AddPropertyGrid ( _
    controls As ControlCollection, _
    left As Double, _
    top As Double, _
    width As Double, _
    height As Double, _
    name As String _
) As PropertyGrid

public static PropertyGrid AddPropertyGrid(
    this ControlCollection controls,
    double left,
    double top,
    double width,
    double height,
    string name
)

Parameters

  • left
    Type: System.Double
    The distance in points between the left edge of the control and the left edge of the worksheet.
  • top
    Type: System.Double
    The distance in points between the top edge of the control and the top edge of the worksheet.
  • height
    Type: System.Double
    The height of the control in points.

Return Value

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

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 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

The AddPropertyGrid method enables you to add PropertyGrid objects to the end of the ControlCollection. To remove a PropertyGrid control that was previously added programmatically, use the Remove method.

Examples

The following code example adds a PropertyGrid control and a Button control to the worksheet. The code then displays the properties of the button in the PropertyGrid. To use this example, run it from the Sheet1 class in a document-level project.

    Private Sub ExcelAddPropertyGrid()
        Dim PropertyGrid1 As Microsoft.Office.Tools. _
            Excel.Controls.PropertyGrid = Me.Controls. _
            AddPropertyGrid(0, 0, 150, 150, "PropertyGrid1")

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

        Button1.Text = "OK"
        PropertyGrid1.SelectedObject = Button1

    End Sub


private void ExcelAddPropertyGrid()
{
    Microsoft.Office.Tools.Excel.Controls.PropertyGrid
         propertyGrid1 = this.Controls.AddPropertyGrid(
         0, 0, 150, 150, "propertyGrid1");

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

    propertyGrid1.SelectedObject = button1;
}

.NET Framework Security

See Also

Reference

ControlExtensions Class

AddPropertyGrid Overload

Microsoft.Office.Tools.Excel Namespace