This documentation is archived and is not being maintained.

MenuDesigner.GetErrorDesignTimeHtml Method

Provides the markup that renders the associated control at design time when an error has occurred.

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

protected override string GetErrorDesignTimeHtml(
	Exception e
)

Parameters

e
Type: System.Exception

The Exception object that was thrown.

Return Value

Type: System.String
A string that contains the markup used to render the associated Menu at design time after an error has occurred.

The GetErrorDesignTimeHtml method generates markup that renders the error design-time Menu control as a placeholder that contains the type name, the control name, and messages describing the error.

The following code example shows how to override the GetErrorDesignTimeHtml method in a class that is inherited from the MenuDesigner class. The overridden method changes the appearance of a control that is derived from the Menu class at design time. The example generates the markup for a placeholder that includes the error message, which is rendered in red, bold text.

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

    return CreatePlaceHolderDesignTimeHtml(errorRendering);
} // GetErrorDesignTimeHtml

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: