ControlDesigner.GetErrorDesignTimeHtml Method (Exception)
Retrieves the HTML markup that provides information about the specified exception.
Assembly: System.Design (in System.Design.dll)
Parameters
- e
-
Type:
System.Exception
The exception that occurred.
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.
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
Available since 1.1