ControlDesigner.GetErrorDesignTimeHtml(Exception) Method

Reference

Definition

Namespace:: System.Web.UI.Design

Assembly:: System.Design.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

protected:
 virtual System::String ^ GetErrorDesignTimeHtml(Exception ^ e);

protected virtual string GetErrorDesignTimeHtml (Exception e);

abstract member GetErrorDesignTimeHtml : Exception -> string
override this.GetErrorDesignTimeHtml : Exception -> string

Protected Overridable Function GetErrorDesignTimeHtml (e As Exception) As String

Parameters

e: Exception

The exception that occurred.

Returns

String

The design-time HTML markup for the specified exception.

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 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

' 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

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(Exception) 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.

Applies to

Jagamisviis: