TX Text Control .NET Server

ShowErrorMessageEventArgs Class

Class|Introduced in 21.0
Namespace
TXTextControl.ServerVisualisation
Package
TXTextControl.TextControl.Core.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXTextControl.Server.Core.dll
Install
dotnet add package TXTextControl.TextControl.Core.SDK .NET 8 and later. For .NET Framework, reference TXTextControl.Server.dll from the setup.
Also in
TXTextControl.TextControl.ASP.SDK as TXTextControl.Server.dll
Inherits
  1. EventArgs
  2. ShowErrorMessageEventArgs

Description

The ShowErrorMessageEventArgs class provides a string which should be shown as an error message for the end-user. It is used with the ServerVisualization.DialogViewGenerator.ShowErrorMessage event.

Syntax

public class ShowErrorMessageEventArgs : EventArgs

Examples

The following example includes the error message value from a Show Error Message Event Args object in application diagnostics. The created object is then available to the surrounding document workflow.

Console.WriteLine($"Error Message: {showErrorMessageEventArgs.ErrorMessage}");
Console.WriteLine("Show Error Message Event Args is ready for use.");

Members

Properties

PropertyDescription
CaptionGets a caption string. If there is no caption string, the property value is null.
ErrorMessageGets the error message.