This documentation is archived and is not being maintained.

DataGridDesigner::GetDesignTimeHtml Method

Gets the HTML markup used to represent the DataGrid control at design time.

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

public:
virtual String^ GetDesignTimeHtml() override

Return Value

Type: System::String
The HTML markup that is used to represent the DataGrid control at design time.

The following code example shows how to override the GetDesignTimeHtml method to alter the appearance of the DataGrid control on the design surface.

The code uses Try...Catch...Finally syntax to do the following:

  • The Try section changes the values of the properties of the data grid control.

  • The Catch section catches any exceptions and sends them to the GetErrorDesignTimeHtml method.

  • The Finally section sets the properties to their original values.

This example is part of a larger example provided for the DataGridDesigner class.


' Override the GetDesignTimeHtml method to add style to the control
' on the design surface.
Public Overrides Function GetDesignTimeHtml() As String
    ' Cast the control to the Component property of the designer.
    simpleList = CType(Component, SimpleDataList)

    Dim designTimeHtml As String = Nothing

    ' Create variables to hold current property values.
    Dim oldBorderWidth As Unit = simpleList.BorderWidth
    Dim oldBorderColor As Color = simpleList.BorderColor

    ' Set the properties and generate the design-time HTML.
    If (simpleList.Enabled) Then
        Try
            simpleList.BorderWidth = Unit.Point(5)
            simpleList.BorderColor = Color.Purple
            designTimeHtml = MyBase.GetDesignTimeHtml()

            ' Call the GetErrorDesignTimeHtml method if an
            ' exception occurs.
        Catch ex As Exception
            designTimeHtml = GetErrorDesignTimeHtml(ex)

            ' Return the properties to their original settings.
        Finally
            simpleList.BorderWidth = oldBorderWidth
            simpleList.BorderColor = oldBorderColor
        End Try
        ' If the list is not enabled, call the GetEmptyDesignTimeHtml
        ' method.
    Else
        designTimeHtml = GetEmptyDesignTimeHtml()
    End If

    Return designTimeHtml

End Function


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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