GridViewDesigner.GetDesignTimeHtml Method (DesignerRegionCollection)

Note: This method is new in the .NET Framework version 2.0.

Gets the markup that is used to render the associated control at design time and populates a collection of designer regions.

Namespace: System.Web.UI.Design.WebControls
Assembly: System.Design (in system.design.dll)

public:
virtual String^ GetDesignTimeHtml (
	DesignerRegionCollection^ regions
) override
public String GetDesignTimeHtml (
	DesignerRegionCollection regions
)
public override function GetDesignTimeHtml (
	regions : DesignerRegionCollection
) : String

Parameters

regions

A DesignerRegionCollection to which definitions of the selectable and clickable regions in the design-time view of the control are added.

Return Value

A String containing the markup used to render the GridView at design time.

The GetDesignTimeHtml(DesignerRegionCollection) method calls the GetDesignTimeHtml method to generate the markup for the design-time rendering of the GridView control. The GetDesignTimeHtml(DesignerRegionCollection) also populates regions with a DesignerRegion object for each clickable or selectable region of the design-time rendering.

For the GridView, the first cell in each row is selectable; all the cells in the rows are clickable.

Notes to Inheritors If you override the GetDesignTimeHtml(DesignerRegionCollection) method, be sure to call the base method or the GetDesignTimeHtml overload, because they eventually, through several override levels, call on the GridView control or a copy of the control to generate the markup.

The following code example shows how to override the GetDesignTimeHtml method in a class that is inherited from the GridViewDesigner class to change the appearance of the GridView control at design time. The example adds a new first row to the grid to contain the Caption property, if the Caption is defined. If the BorderStyle property of the control that is derived from the GridView class has the NotSet or None value, the GetDesignTimeHtml draws a blue dashed border around the control to make its extent more visible. It does not change the run-time appearance of the control.

No code example is currently available or this language may not be supported.

  • Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see .

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0
Show: