.NET Framework Class Library
ControlDesignerGetErrorDesignTimeHtml Method

Retrieves the HTML markup that provides information about the specified exception.

Namespace:   System.Web.UI.Design
Assembly:  System.Design (in System.Design.dll)
Syntax
Protected Overridable Function GetErrorDesignTimeHtml ( _
	e As [%$TOPIC/st42dfz9_en-us_VS_110_1_0_0_0_0%] _
) As [%$TOPIC/st42dfz9_en-us_VS_110_1_0_0_0_1%]
protected virtual [%$TOPIC/st42dfz9_en-us_VS_110_1_0_1_0_0%] GetErrorDesignTimeHtml(
	[%$TOPIC/st42dfz9_en-us_VS_110_1_0_1_0_1%] e
)
protected:
virtual [%$TOPIC/st42dfz9_en-us_VS_110_1_0_2_0_0%]^ GetErrorDesignTimeHtml(
	[%$TOPIC/st42dfz9_en-us_VS_110_1_0_2_0_1%]^ e
)
abstract GetErrorDesignTimeHtml : 
        e:[%$TOPIC/st42dfz9_en-us_VS_110_1_0_3_0_0%] -> [%$TOPIC/st42dfz9_en-us_VS_110_1_0_3_0_1%]  
override GetErrorDesignTimeHtml : 
        e:[%$TOPIC/st42dfz9_en-us_VS_110_1_0_3_0_2%] -> [%$TOPIC/st42dfz9_en-us_VS_110_1_0_3_0_3%]

Parameters

e
Type: SystemException

The exception that occurred.

Return Value

Type: SystemString
The design-time HTML markup for the specified exception.
Remarks

The GetErrorDesignTimeHtml method is typically called, if an exception is thrown in the GetDesignTimeHtml method.

Notes to Inheritors

The typical design pattern is to try to get HTML markup through the associated control, and then if an error is encountered, call the GetErrorDesignTimeHtml method. If no markup is returned by the control, call the GetEmptyDesignTimeHtml method, which if it is not overridden to provide specific markup, calls the CreatePlaceHolderDesignTimeHtml method, which should contain information about the type and ID of the control.

Examples

The following code example demonstrates how to generate design-time HTML markup for the control when an error occurs and call the CreatePlaceHolderDesignTimeHtml method.

' Generate the design-time markup for the control when an error occurs. 
Protected Overrides Function GetErrorDesignTimeHtml( _
    ByVal ex As Exception) As String 

    ' Write the error message text in red, bold. 
    Dim errorRendering As String = _
        "<span style=""font-weight:bold; color:Red; "">" & _
        ex.Message & "</span>" 

    Return CreatePlaceHolderDesignTimeHtml(errorRendering)

End Function ' GetErrorDesignTimeHtml
// Generate the design-time markup for the control when an error occurs. 
protected override string GetErrorDesignTimeHtml(Exception e) 
{
    // Write the error message text in red, bold. 
    string errorRendering =
        "<span style=\"font-weight:bold; color:Red; \">" +
        e.Message + "</span>";

    return CreatePlaceHolderDesignTimeHtml(errorRendering);
} // GetErrorDesignTimeHtml
Version Information

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0
.NET Framework Security
Platforms

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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