OpenPetra
Free Administration Software for Non-Profits
Ict.Common.ErrCodeAttribute Class Reference

Allows to add information to a constant for a specific error code. More...

Inheritance diagram for Ict.Common.ErrCodeAttribute:

Public Member Functions

 ErrCodeAttribute (string AShortDescription)
 Constructor. More...
 

Properties

virtual ErrCodeCategory Category [get, set]
 Category of the error code. More...
 
virtual string ShortDescription [get]
 Short description of the error code. More...
 
virtual string FullDescription [get, set]
 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...
 
virtual string HelpID [get, set]
 Help ID of the error code. More...
 
virtual bool ControlValueUndoRequested [get, set]
 Is true (or set to true) if the Error Code requests that the validated Control's value is undone. More...
 

Detailed Description

Allows to add information to a constant for a specific error code.

Constructor & Destructor Documentation

◆ ErrCodeAttribute()

Ict.Common.ErrCodeAttribute.ErrCodeAttribute ( string  AShortDescription)
inline

Constructor.

Parameters
AShortDescriptionShort description of the error code.

Property Documentation

◆ Category

virtual ErrCodeCategory Ict.Common.ErrCodeAttribute.Category
getset

Category of the error code.

◆ ControlValueUndoRequested

virtual bool Ict.Common.ErrCodeAttribute.ControlValueUndoRequested
getset

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

◆ ErrorMessageText

virtual string Ict.Common.ErrCodeAttribute.ErrorMessageText
getset

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

This will override ShortDescription, which would otherwise be used in MessageBoxes, etc.

◆ ErrorMessageTitle

virtual string Ict.Common.ErrCodeAttribute.ErrorMessageTitle
getset

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

◆ FullDescription

virtual string Ict.Common.ErrCodeAttribute.FullDescription
getset

Full description of the error code.

◆ HelpID

virtual string Ict.Common.ErrCodeAttribute.HelpID
getset

Help ID of the error code.

◆ ShortDescription

virtual string Ict.Common.ErrCodeAttribute.ShortDescription
get

Short description of the error code.


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