ASPxScheduler.CustomErrorText Event

Enables you to provide custom error descriptions.

Namespace: DevExpress.Web.ASPxScheduler

Assembly: DevExpress.Web.ASPxScheduler.v24.1.dll

NuGet Package: DevExpress.Web.Scheduler

Declaration

C#

public event ASPxSchedulerCustomErrorTextEventHandler CustomErrorText

VB.NET

Public Event CustomErrorText As ASPxSchedulerCustomErrorTextEventHandler

Event Data

The CustomErrorText event's data class is ASPxSchedulerCustomErrorTextEventArgs. The following properties provide information specific to this event:

Property	Description
ErrorText	Gets or sets the explanatory text for the error.
Exception	Gets the exception thrown.

Remarks

Use the CustomErrorText event to specify the default error text of the exception.

Use the ErrorText property to specify the error text for the exception object returned by the Exception property. Refer to the ErrorText property to get information on the error text’s pattern.

Example

The following example illustrates how to handle the ASPxScheduler.CustomErrorText event to display custom text when an unhandled exception occurs:

Default.aspx.cs

protected void ASPxScheduler1_CustomErrorText(object handler, ASPxSchedulerCustomErrorTextEventArgs e) {
    e.ErrorText = ErrorTextHelper.PrepareMessage("Please contact Technical Support", e.Exception.Message, true);       
}

Default.aspx.vb

Protected Sub ASPxScheduler1_CustomErrorText(ByVal handler As Object, ByVal e As ASPxSchedulerCustomErrorTextEventArgs)
    e.ErrorText = ErrorTextHelper.PrepareMessage("Please contact Technical Support", e.Exception.Message, True)
End Sub

Helpers.cs

public class ErrorTextHelper {
    static string NewLinesToBr(string text) {
        text = text.Replace("\r", string.Empty);
        return text.Replace("\n", "<br/>");
    }
    public static string PrepareMessage(string subjectText, string detailInfoText, bool showDetailedErrorInfo) {
        string subject = String.Format("{0}\n", subjectText);
        string detailInfo = String.Format("Detailed information is included below.\n\n- {0}", detailInfoText);
        if(!showDetailedErrorInfo)
            detailInfo = String.Empty;
        subject = NewLinesToBr(HttpUtility.HtmlEncode(subject));
        detailInfo = NewLinesToBr(HttpUtility.HtmlEncode(detailInfo));
        return String.Format("{0},{1}|{2}{3}", subject.Length, detailInfo.Length, subject, detailInfo);
    }
}

Helpers.vb

Public Class ErrorTextHelper
    Private Shared Function NewLinesToBr(ByVal text As String) As String
        text = text.Replace(ControlChars.Cr, String.Empty)
        Return text.Replace(ControlChars.Lf, "<br/>")
    End Function
    Public Shared Function PrepareMessage(ByVal subjectText As String, ByVal detailInfoText As String, ByVal showDetailedErrorInfo As Boolean) As String
        Dim subject As String = String.Format("{0}" & ControlChars.Lf, subjectText)
        Dim detailInfo As String = String.Format("Detailed information is included below." & ControlChars.Lf & ControlChars.Lf & "- {0}", detailInfoText)
        If Not showDetailedErrorInfo Then
            detailInfo = String.Empty
        End If
        subject = NewLinesToBr(HttpUtility.HtmlEncode(subject))
        detailInfo = NewLinesToBr(HttpUtility.HtmlEncode(detailInfo))
        Return String.Format("{0},{1}|{2}{3}", subject.Length, detailInfo.Length, subject, detailInfo)
    End Function
End Class