ControlDesigner.GetErrorDesignTimeHtml Method (System.Web.UI.Design)

Welcome | Sign in

Developer Centers

MSDN Home

Microsoft Developer Network

.NET Framework Class Library

ControlDesigner..::.GetErrorDesignTimeHtml Method

Updated: November 2007

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

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

Syntax

Visual Basic (Declaration)

Protected Overridable Function GetErrorDesignTimeHtml ( _
    e As Exception _
) As String

Visual Basic (Usage)

Dim e As Exception
Dim returnValue As String

returnValue = Me.GetErrorDesignTimeHtml(e)

protected virtual string GetErrorDesignTimeHtml(
    Exception e
)

Visual C++

protected:
virtual String^ GetErrorDesignTimeHtml(
    Exception^ e
)

protected String GetErrorDesignTimeHtml(
    Exception e
)

JScript

protected function GetErrorDesignTimeHtml(
    e : Exception
) : String

Parameters

e: Type: System..::.Exception
The exception that occurred.

Return Value

Type: System..::.String

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.

Visual Basic

' 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

Permissions

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Platforms

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, 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.

Version Information