DataGridDesigner.GetDesignTimeHtml Method

public:
 override System::String ^ GetDesignTimeHtml();

public override string GetDesignTimeHtml ();

override this.GetDesignTimeHtml : unit -> string

Public Overrides Function GetDesignTimeHtml () As String

Returns

The HTML markup that is used to represent the DataGrid control at design time.

Examples

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

Applies to

See also

• GridView Web Server Control Overview
• Extending Design-Time Support
• How to: Extend the Appearance and Behavior of Controls in Design Mode