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

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

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 object that was thrown.

Returns

String

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

Examples

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

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

Applies to

Jaa