Namespaces
namespace	Conversion

namespace	Data

namespace	DB

namespace	Exceptions

namespace	IO

namespace	Printing

namespace	Remoting

namespace	Session

namespace	Testing

namespace	Verification

Classes
class	Attributes
	this class contains some attribute classes (at the moment only one) More...

class	Catalog
	a helper class for Gnu gettext More...

class	CommonErrorCodes

class	CommonJoinString
	A class of pre-defined strings that may be used to join two other strings together More...

class	CommonTagString
	This small class has several string constants relating to strings that can be part of a control's Tag property More...

class	CommonTypes
	some functions that are useful for operating with the enums defined in Ict.Common More...

class	EDuplicateErrorCodeException
	Thrown if an attempt is made to add a Error Code with a value that already exists in Dictionary ErrorCodeInventory.ErrorCodeCatalogue. More...

class	EErrorCodeNotRegisteredException
	Thrown if an attempt is made to inquire an Error Code that doesn't exist in Dictionary ErrorCodeInventory.ErrorCodeCatalogue. More...

class	ENoLoggingToFile_WrongConstructorUsedException
	This Exception is thrown if the TLogging class was created using the Create() constructor (without the FileName parameter) and a logging request is made that would write to a Logfile. More...

class	EProblemLaunchingHyperlinkException
	Thrown when OpenPetra encounters a problem when trying to launch a Hyperlink. More...

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

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

class	ErrorCodeInventory
	Inventory functions for the OpenPetra Error Codes. More...

class	ErrorCodes
	Contains Helper Methods for working with information that is associated with Error Codes. More...

interface	IOPWebServerManagerActions
	Interface used by Open Petra Web Server More...

interface	IPasswordHashingScheme
	Interface which all Password Hashing Scheme implementations need to implement. More...

class	Networking
	Contains general networking procedures and functions for ICT Applications. More...

class	NoRemotingAttribute
	simple attribute for marking methods that should not be remoted. the code generator for generateGlue will take note of this attribute. More...

class	NumberToWords
	This is to write a currency value in words, eg. 123 becomes onehundred twenty-three; this has to be implemented for each language. see also Java GPL code: NumericalChameleon: http://www.jonelo.de/java/nc/ More...

class	StringHelper
	General String utility functions for ICT applications. More...

class	TAppSettingsManager
	The TAppSettingsManager class allows reading of AppSettings section values in any .NET Configuration File (not just the one that has the same name as the Application itself). It also supports parameters on the command line which override the values in the config file. More...

class	TCmdOpts
	This class contains all the commandline parameters. It takes a very easy approach for the formatting of commandline parameters that takes values. Basically it uses the format <flag>:<value>, eg -F:c:\path\to\file.txt where -F is the parameter name, and c:\path\to\file.txt is the value. More...

class	TFileVersionInfo
	our own type for version information for a file More...

class	THelperNumeric
	Helper class for all things numeric More...

class	ThreadingHelper
	Helper Class for things that have to do with Multithreading. More...

class	THyperLinkHandling
	Class for HyperLink handling. Used by the 'TtxtLinkTextBox' and 'TRtbHyperlinks' Controls. More...

class	TLogging
	The TLogging class provides general logging functionality. Logging output can currently go to the Console, to a file or to both at the same time. More...

class	TLogWriter
	The TLogWriter class writes arbitrary strings to a specified log file, prefixing them with date and time and optionally also with a prefix. Part of the logging framework for ICT Applications. More...

class	TPasswordHashingScheme_V1
	Password Hashing Scheme V1: Generates 'salted' Password Hashes with the Scrypt Key Stretching Algorithm. More...

class	TPasswordHashingScheme_V2
	Password Hashing Scheme V2: Generates 'salted' Password Hashes with the Scrypt Key Stretching Algorithm.

class	TPasswordHashingScheme_V3
	Password Hashing Scheme V3: Generates 'salted' Password Hashes with the Scrypt Key Stretching Algorithm.

class	TPasswordHashingScheme_V4
	Password Hashing Scheme V4: Generates 'salted' Password Hashes with the Scrypt Key Stretching Algorithm.

class	TPasswordHelper
	Helper Class for dealing with the secure hashing of passwords in OpenPetra. More...

class	TProgressState
	current state of the long-running procedure More...

class	TSaveConvert
	some static methods for the save conversion of dates to objects and objects to dates More...

class	TSearchCriteria
	search criteria for SQL queries More...

class	TSelfExpandingArrayList
	A wrapper around System.Collections.ArrayList, that allows to use the index property even beyond the existing count of objects More...

class	TSrvSetting
	Class for storing Server settings. Once instantiated, Server settings can only be read! Server Settings are gathered from the Command line, .NET Configuration files and other ways (eg. determining the OS on which the server is running on-the-fly) at Server start-up. More...

class	TVariant
	a class for the storage of values in different representations; Conversion functions are provided. More...

class	TWindowHandling
	Contains Windows API (WinAPI) calls that are necessary for getting window positions right More...

class	Utilities
	General utility functions for ICT applications that don't fall into other Units of the Ict.Common namespace. More...

Enumerations
enum	ErrCodeCategory { Validation , NonCriticalError , Error }
	Error Code Category. More...

enum	TLoggingType { ToConsole = 1 , ToLogfile = 2 , ToStatusBar = 4 }
	Logging Type describes the destination of the logging messages More...

enum	TExecutingCLREnum { eclrUnknown , eclrMicrosoftDotNetFramework , eclrMono , eclrDotGNUPortableNet }
	enum for several runtime environments More...

enum	TNullHandlingEnum { nhReturnLowestDate , nhReturnHighestDate }
	enum for handling date values that are null More...

enum	TExecutingOSEnum { eosLinux , eosWin98ToWinME , eosWinNTOrLater , eosWinXP , eosWinVista , eosWin7 , eosWin8Plus , eosWin81 , eosWin10 , oesUnsupportedPlatform }
	enum for the Operating System that this program is running on More...

enum	TDBType { PostgreSQL , MySQL }
	Type of RDBMS (Relational Database Management System) More...

enum	TDataModeEnum { dmBrowse , dmEdit , dmAdd }
	several modes a data edit screen can be in More...

enum	TClientServerConnectionType { csctLAN , csctRemote , csctLocal }
	enum for the connection between client and server More...

enum	TSubmitChangesResult { scrOK , scrError , scrNothingToBeSaved , scrInfoNeeded }
	different states when submitting some data to the server More...

enum	eLoginEnum { eLoginSucceeded , eLoginAuthenticationFailed , eLoginUserIsRetired , eLoginUserRecordLocked , eLoginServerTooBusy , eLoginExceedingConcurrentUsers , eLoginSystemDisabled , eLoginLicenseExpired , eLoginVersionMismatch , eLoginServerNotReachable , eLoginFailedForUnspecifiedError }
	return values when the user logs in More...

enum	eVariantTypes { eEmpty , eDateTime , eDecimal , eCurrency , eInteger , eInt64 , eString , eBoolean , eComposite , eJson }
	enum for the supported data types in the TVariant class More...

Enumeration Type Documentation

◆ eLoginEnum

enum Ict.Common.eLoginEnum

return values when the user logs in

Enumerator
eLoginSucceeded	everything is fine
eLoginAuthenticationFailed	wrong username or password
eLoginUserIsRetired	user is retired and therefore not allowed to login
eLoginUserRecordLocked	user record is locked for some reason
eLoginServerTooBusy	server cannot accept more users, too busy
eLoginExceedingConcurrentUsers	for hosted OpenPetra: too many users logged in at the same time. sign up for a better plan!
eLoginSystemDisabled	System is disabled for the moment
eLoginLicenseExpired	System is currently not paid for (in a hosting offer)
eLoginVersionMismatch	version of dlls (or version.txt) of the client does not match the version of the program on the server
eLoginServerNotReachable	cannot reach the server
eLoginFailedForUnspecifiedError	catch all for any other exception

◆ ErrCodeCategory

enum Ict.Common.ErrCodeCategory

Error Code Category.

Enumerator
Validation	Error Code for validation errors.
NonCriticalError	Error Code for non-critical general errors.
Error	Error Code for general errors.

◆ eVariantTypes

enum Ict.Common.eVariantTypes

enum for the supported data types in the TVariant class

Enumerator
eEmpty	no value at all
eDateTime	date/time
eDecimal	decimal
eCurrency	currency (decimal, but with 2 fixed decimals)
eInteger	integer
eInt64	long integer
eString	string
eBoolean	boolean
eComposite	composite: several TVariants concatenated
eJson	JSON: json string

◆ TClientServerConnectionType

enum Ict.Common.TClientServerConnectionType

enum for the connection between client and server

Enumerator
csctLAN	inside a LAN network (quite fast)
csctRemote	remote through VPN, can be slow
csctLocal	standalones run the client and the server on one machine

◆ TDataModeEnum

enum Ict.Common.TDataModeEnum

several modes a data edit screen can be in

Enumerator
dmBrowse	just browsing the data, viewing, read only
dmEdit	edit the data
dmAdd	add new data

◆ TDBType

enum Ict.Common.TDBType

Type of RDBMS (Relational Database Management System)

Enumerator
PostgreSQL	The PostgreSQL RDBMS
MySQL	The MySQL RDBMS

◆ TExecutingCLREnum

enum Ict.Common.TExecutingCLREnum

enum for several runtime environments

Enumerator
eclrUnknown	unknown
eclrMicrosoftDotNetFramework	Microsoft .Net
eclrMono	Mono
eclrDotGNUPortableNet	DotGnu (not really supported)

◆ TExecutingOSEnum

enum Ict.Common.TExecutingOSEnum

enum for the Operating System that this program is running on

Enumerator
eosLinux	Linux
eosWin98ToWinME	Win98 up to Windows Millenium (not really supported)
eosWinNTOrLater	Windows NT and later
eosWinXP	WinXP.
eosWinVista	WinVista.
eosWin7	Win7.
eosWin8Plus	Covers Windows 8.0 and above (ONLY if the application is manifested for versions below Windows 8.1)
eosWin81	Windows 8.1 (only if manifested for it)
eosWin10	Windows 10 (only if manifested for it)
oesUnsupportedPlatform	unknown and unsupported

◆ TLoggingType

enum Ict.Common.TLoggingType

Logging Type describes the destination of the logging messages

Enumerator
ToConsole	to the console so that you can follow while program is running
ToLogfile	to log file for later analysis
ToStatusBar	Statusbar is the alternative for Forms where the user does not have a console

◆ TNullHandlingEnum

enum Ict.Common.TNullHandlingEnum

enum for handling date values that are null

Enumerator
nhReturnLowestDate	lowest possible date
nhReturnHighestDate	highest possible date

◆ TSubmitChangesResult

enum Ict.Common.TSubmitChangesResult

different states when submitting some data to the server

Enumerator
scrOK	submission was ok, data has been saved to database
scrError	there has been an error during submission
scrNothingToBeSaved	there is no new data, therefore nothing needs to be written to the database
scrInfoNeeded	more info (user interaction) needed, before saving of data is possible

Namespaces

Classes

Enumerations