GridViewDesigner.GetDesignTimeHtml Method ()

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.

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

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

Return Value

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

The GetDesignTimeHtml method does the following:

  1. Sets the AutoGenerateColumns property of the control to true, if the Columns property is empty.

  2. Sets the DataKeyNames property of the control to a null reference (Nothing in Visual Basic), if the schema of the data source cannot be obtained.

  3. Refreshes the TypeDescriptor object to force the PreFilterProperties method to be called.

  4. Calls the base method to generate the markup.

Notes to Inheritors If you override the GetDesignTimeHtml method, be sure to call the base method, because it eventually, through several override levels, calls 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: