C# Class Habanero.Faces.Win.HabaneroAppWin

Provides a template for a standard Habanero application, including standard fields and initialisations. Specific details covered are:
  • The class definitions that define how the data is represented and limited
  • The database configuration, connection and settings
  • A logger to record debugging and error messages
  • An exception notifier to communicate exceptions to the user
  • Automatic version upgrades when an application is out-of-date
  • A synchronisation controller
  • A control factory to create controls
  • A data accessor that specifies what type of data source is used (DB by default)
To set up and launch an application:
  1. Instantiate the application with the constructor
  2. Specify any individual settings as required
  3. Call the Startup() method to launch the application
Inheritance: Habanero.Faces.Base.HabaneroAppUI
Show file Open project: Chillisoft/habanero.faces

Public Methods

Method Description
HabaneroAppWin ( string appName, string appVersion ) : System

Constructor to initialise a new application with basic application information. Use the Startup() method to launch the application.

Protected Methods

Method Description
SetupControlFactory ( ) : void

Sets the control factory used to create controls

SetupDatabaseConnection ( ) : void

Sets up the database connection. If not provided, then reads the connection from the config file.

SetupExceptionNotifier ( ) : void

Sets up the exception notifier used to display exceptions to the final user. If not specified, assumes the FormExceptionNotifier.

SetupLogging ( ) : void
SetupSettings ( ) : void

Initialises the settings. If not provided, DatabaseSettings is assumed.

Method Details

HabaneroAppWin() public method

Constructor to initialise a new application with basic application information. Use the Startup() method to launch the application.
public HabaneroAppWin ( string appName, string appVersion ) : System
appName string The application name
appVersion string The application version
return System

SetupControlFactory() protected method

Sets the control factory used to create controls
protected SetupControlFactory ( ) : void
return void

SetupDatabaseConnection() protected method

Sets up the database connection. If not provided, then reads the connection from the config file.
protected SetupDatabaseConnection ( ) : void
return void

SetupExceptionNotifier() protected method

Sets up the exception notifier used to display exceptions to the final user. If not specified, assumes the FormExceptionNotifier.
protected SetupExceptionNotifier ( ) : void
return void

SetupLogging() protected method

protected SetupLogging ( ) : void
return void

SetupSettings() protected method

Initialises the settings. If not provided, DatabaseSettings is assumed.
protected SetupSettings ( ) : void
return void