CreateUserWizardDesigner.GetErrorDesignTimeHtml(Exception) Method

Reference

Definition

Namespace:: System.Web.UI.Design.WebControls

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.

Gets the HTML that provides information about the specified exception. This method is typically called after an error has been encountered at design time.

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

protected override string GetErrorDesignTimeHtml (Exception e);

override this.GetErrorDesignTimeHtml : Exception -> string

Protected Overrides Function GetErrorDesignTimeHtml (e As Exception) As String

Parameters

e: Exception

The exception that occurred.

Returns

String

The HTML for the specified exception.

Examples

The following code example demonstrates how to override the GetErrorDesignTimeHtml method to display debugging information on the design surface in case of an error.

using System;
using System.IO;
using System.ComponentModel;
using System.Web.UI.WebControls;
using System.Web.UI;
using System.Web.UI.Design;
using System.Web.UI.Design.WebControls;
//using Examples.WebNet.Design;

namespace Examples.WebNet
{
    // Create a class that extends CreateUserWizardDesigner.
    public class MyCreateUserWizardDesigner : CreateUserWizardDesigner
    {
        // This variable contains debugging information.
        private string debugInfo = "Useful information.";
        
        // Override the GetErrorDesignTimeHtml method to add some more
        // information to the error message.
        protected override string GetErrorDesignTimeHtml(Exception e)
        {
            // Get the error message from the base class.
            string html = base.GetErrorDesignTimeHtml(e);
        
            // Append the debugging information to it.
            html += "<br>" + "DebugInfo: " + debugInfo;
        
            // Return the error message.
            return html;
        }
    }
}

Imports System.IO
Imports System.ComponentModel
Imports System.Web.UI
Imports System.Web.UI.Design
Imports System.Web.UI.Design.WebControls
Imports System.Web.UI.WebControls
Imports Examples.WebNet

Namespace Examples.WebNet
    ' Create a class that extends CreateUserWizardDesigner.
    Public Class MyCreateUserWizardDesigner
        Inherits CreateUserWizardDesigner

        ' This variable contains debugging information.
        Private debugInfo As String = "Useful information."

        ' Override the GetErrorDesignTimeHtml method to add some more
        ' information to the error message.
        Protected Overrides Function GetErrorDesignTimeHtml(ByVal e As Exception) As String
            ' Get the error message from the base class.
            Dim htmlStr As String
            htmlStr = MyBase.GetErrorDesignTimeHtml(e)

            ' Append the debugging information to it.
            htmlStr &= "<br>DebugInfo: " & debugInfo

            ' Return the error message.
            Return htmlStr
        End Function
    End Class

End Namespace

Applies to

Jaa