Holds information about a specific error code. More...

Public Member Functions
	ErrCodeInfo (string AErrorCode, string AErrorCodeConstantClass, string AErrorCodeConstantName, string AShortDescription, string AFullDescription, string AErrorMessageText, string AErrorMessageTitle, ErrCodeCategory ACategory, string AHelpID, bool AControlValueUndoRequested=false)
	Constructor. More...

Properties
string	ErrorCode `[get]`
	Error code. More...

string	ErrorCodeConstantClass `[get]`
	Name of the Class which holds the Constant that defines the error code. More...

string	ErrorCodeConstantName `[get]`
	Name of the Constant that defines the error code. More...

string	ShortDescription `[get]`
	Short description of the error code. More...

string	FullDescription `[get]`
	Full description of the error code. More...

virtual string	ErrorMessageText `[get, set]`
	Error message which should be displayed in a MessageBox, etc. for the error code. Can contain {0}, etc. More...

virtual string	ErrorMessageTitle `[get, set]`
	Title of an error message which should be displayed in a MessageBox, etc. for the error code. More...

ErrCodeCategory	Category `[get]`
	Category of the error code. More...

string	HelpID `[get]`
	Help ID of the error code. More...

bool	ControlValueUndoRequested `[get]`
	Is true (or set to true) if the Error Code requests that the validated Control's value is undone. More...

Detailed Description

Holds information about a specific error code.

Constructor & Destructor Documentation

◆ ErrCodeInfo()

Ict.Common.ErrCodeInfo.ErrCodeInfo	(	string	AErrorCode,
		string	AErrorCodeConstantClass,
		string	AErrorCodeConstantName,
		string	AShortDescription,
		string	AFullDescription,
		string	AErrorMessageText,
		string	AErrorMessageTitle,
		ErrCodeCategory	ACategory,
		string	AHelpID,
		bool	AControlValueUndoRequested = `false`
	)

inline

Constructor.

Parameters

AErrorCode	Error code.
AErrorCodeConstantClass	Class that holds the definition of the constant for the error code.
AErrorCodeConstantName	Name of the constant for the error code.
AShortDescription	Short description of the error code.
AFullDescription	Full description of the error code.
AErrorMessageText	String that will be displayed in MessageBoxes, etc. instead of the value of AShortDescription .
AErrorMessageTitle	String that will be displayed as Title of MessageBoxes, etc..
ACategory	Category of the error code.
AHelpID	Help ID of the error code.
AControlValueUndoRequested	Set this to true if the Error Code requests that the validated Control's value is undone.

Property Documentation

◆ Category

ErrCodeCategory Ict.Common.ErrCodeInfo.Category

get

Category of the error code.

◆ ControlValueUndoRequested

bool Ict.Common.ErrCodeInfo.ControlValueUndoRequested

get

Is true (or set to true) if the Error Code requests that the validated Control's value is undone.

◆ ErrorCode

string Ict.Common.ErrCodeInfo.ErrorCode

get

Error code.

◆ ErrorCodeConstantClass

string Ict.Common.ErrCodeInfo.ErrorCodeConstantClass

get

Name of the Class which holds the Constant that defines the error code.

◆ ErrorCodeConstantName

string Ict.Common.ErrCodeInfo.ErrorCodeConstantName

get

Name of the Constant that defines the error code.

◆ ErrorMessageText

virtual string Ict.Common.ErrCodeInfo.ErrorMessageText

getset

Error message which should be displayed in a MessageBox, etc. for the error code. Can contain {0}, etc.

This string will override ShortDescription when a Ict.Common.Verification.TVerificationResult" is created with an <see cref="ErrCodeInfo" /> Argument. (<see cref="ShortDescription" /> would otherwise be used in MessageBoxes, etc.)

◆ ErrorMessageTitle

virtual string Ict.Common.ErrCodeInfo.ErrorMessageTitle

getset

Title of an error message which should be displayed in a MessageBox, etc. for the error code.

◆ FullDescription

string Ict.Common.ErrCodeInfo.FullDescription

get

Full description of the error code.

◆ HelpID

string Ict.Common.ErrCodeInfo.HelpID

get

Help ID of the error code.

◆ ShortDescription

string Ict.Common.ErrCodeInfo.ShortDescription

get

Short description of the error code.

This string will be used when a Ict.Common.Verification.TVerificationResult is created with an ErrCodeInfo Argument.

The documentation for this class was generated from the following file:

csharp/ICT/Common/ErrorCodesHelper.cs

Public Member Functions

Properties