CreateErrorDesignTimeHtml Method (String, Exception)

ControlDesigner.CreateErrorDesignTimeHtml Method (String, Exception)

 

Creates the HTML markup to display a specified exception error message at design time.

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

protected string CreateErrorDesignTimeHtml(
	string errorMessage,
	Exception e
)

Parameters

errorMessage
Type: System.String

The error message to include in the generated HTML string.

e
Type: System.Exception

The exception to include in the generated HTML string.

Return Value

Type: System.String

HTML markup that contains the specified errorMessage and e.

Use the CreateErrorDesignTimeHtml method to provide simple HTML markup that can be used to display error and exception details for a control at design time. The value for errorMessage specifies a localized string that is displayed to the user of the control at design time.

The ControlDesigner class implementation of the CreateErrorDesignTimeHtml method returns a table with two rows, as follows:

  • The first row contains the type name and site name for the Component property of the ControlDesignerobject.

  • The second row contains the input error message and the Message string of the exception.

To generate HTML markup for an error message without specifying an exception, use the CreateErrorDesignTimeHtml(String) overload. To generate HTML markup for an exception without specifying a localized error message, use the GetErrorDesignTimeHtml method.

Notes to Inheritors:

The CreateErrorDesignTimeHtml method should be called from the GetViewRendering or GetErrorDesignTimeHtml method when exceptions occur.

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft