ASPxScheduler.CustomErrorText Event

Enables you to provide custom error descriptions.

Namespace: DevExpress.Web.ASPxScheduler

Assembly: DevExpress.Web.ASPxScheduler.v19.2.dll

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

The CustomErrorText event occurs when an exception is raised within the ASPxScheduler, and allows you to change the default error text. You can localize error messages via this event.

Use the ASPxSchedulerCustomErrorTextEventArgs.ErrorText property of the event’s arguments object to specify the error text for the exception returned by the ASPxSchedulerCustomErrorTextEventArgs.Exception property.

The following code snippets illustrate a way of handling the ASPxScheduler.CustomErrorText event to display custom text when an unhandled exception occurs.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-use-the-customerrortext-event-e1827

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);
    }
}

Default.aspx.cs

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

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

Default.aspx.vb

Imports DevExpress.Web.ASPxScheduler
Imports DevExpress.XtraScheduler
    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