Class AdminMessageException

Custom components and some plugins can throw exceptions of this type to show a helpful error message to the user.

Inheritance

System.Object

AdminMessageException

Namespace: Softadmin.Api

Assembly: Softadmin.Api.dll

Syntax

public sealed class AdminMessageException : Exception

Remarks

If you throw an AdminMessageException whose property is not null then the inner exception will be written to the system's error log.

Constructors

AdminMessageException()

Initializes a new instance of the AdminMessageException class.

Declaration

public AdminMessageException()

AdminMessageException(Int32, Exception)

Initializes a new instance of the AdminMessageException class.

Declaration

public AdminMessageException(int phraseId, Exception innerException = null)

Parameters

Type	Name	Description
System.Int32	phraseId	The id of a language phrase.
Exception	innerException	The exception that is the cause of the current exception, or a null reference if no inner exception is specified. This exception will be written to the system's error log.

AdminMessageException(String)

Initializes a new instance of the AdminMessageException class.

Declaration

public AdminMessageException(string message)

Parameters

Type	Name	Description
System.String	message	The message that describes the error.

AdminMessageException(String, Exception)

Initializes a new instance of the AdminMessageException class.

Declaration

public AdminMessageException(string message, Exception innerException)

Parameters

Type	Name	Description
System.String	message	The error message that explains the reason for the exception.
Exception	innerException	The exception that is the cause of the current exception, or a null reference if no inner exception is specified. This exception will be written to the system's error log.

Properties

PhraseId

Gets the id of the language phrase to use instead of .

Declaration

public int? PhraseId { get; }

Property Value

Type	Description
System.Nullable<System.Int32>

Methods

GetObjectData(SerializationInfo, StreamingContext)

Declaration

public override void GetObjectData(SerializationInfo info, StreamingContext context)

Parameters

Type	Name	Description
SerializationInfo	info
StreamingContext	context