InstallerBase Class

Defines a common installer class for the applications based on the time-series framework.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Configuration.InstallInstaller
        GSF.TimeSeriesInstallerBase

Namespace: GSF.TimeSeries
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.230-beta

Syntax

C++

JavaScript

Copy

public class InstallerBase : Installer

Public Class InstallerBase
	Inherits Installer

public ref class InstallerBase : public Installer

type InstallerBase = 
    class
        inherit Installer
    end

GSF.TimeSeries.InstallerBase = function();

Type.createClass(
	'GSF.TimeSeries.InstallerBase',
	Installer);

View Source

The InstallerBase type exposes the following members.

Constructors

	Name	Description
	InstallerBase	Initializes a new instance of the InstallerBase class

Top

Properties

	Name	Description
	CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component)
	ConfigurationName	Gets associated application configuration file name.
	Container	Gets the IContainer that contains the Component. (Inherited from Component)
	Context	Gets or sets information about the current installation. (Inherited from Installer)
	DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component)
	Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component)
	HelpText	Gets the help text for all the installers in the installer collection. (Inherited from Installer)
	Installers	Gets the collection of installers that this installer contains. (Inherited from Installer)
	Parent	Gets or sets the installer containing the collection that this installer belongs to. (Inherited from Installer)
	Site	Gets or sets the ISite of the Component. (Inherited from Component)

Top

Methods

	Name	Description
	Commit	When overridden in a derived class, completes the install transaction. (Inherited from Installer)
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject)
	Dispose	Releases all resources used by the Component. (Inherited from Component)
	Dispose(Boolean)	Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject)
	GetService	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject)
	Install	Installs the class. (Overrides InstallerInstall(IDictionary))
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject)
	OnAfterInstall	Raises the AfterInstall event. (Inherited from Installer)
	OnAfterRollback	Raises the AfterRollback event. (Inherited from Installer)
	OnAfterUninstall	Raises the AfterUninstall event. (Inherited from Installer)
	OnBeforeInstall	Raises the BeforeInstall event. (Inherited from Installer)
	OnBeforeRollback	Raises the BeforeRollback event. (Inherited from Installer)
	OnBeforeUninstall	Raises the BeforeUninstall event. (Inherited from Installer)
	OnCommitted	Raises the Committed event. (Inherited from Installer)
	OnCommitting	Raises the Committing event. (Inherited from Installer)
	OnSystemSettingsLoaded	Called when system settings are loaded.
	Rollback	When overridden in a derived class, restores the pre-installation state of the computer. (Inherited from Installer)
	ToString	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component)
	Uninstall	When overridden in a derived class, removes an installation. (Inherited from Installer)

Top

Events

	Name	Description
	AfterInstall	Occurs after the Install(IDictionary) methods of all the installers in the Installers property have run. (Inherited from Installer)
	AfterRollback	Occurs after the installations of all the installers in the Installers property are rolled back. (Inherited from Installer)
	AfterUninstall	Occurs after all the installers in the Installers property perform their uninstallation operations. (Inherited from Installer)
	BeforeInstall	Occurs before the Install(IDictionary) method of each installer in the installer collection has run. (Inherited from Installer)
	BeforeRollback	Occurs before the installers in the Installers property are rolled back. (Inherited from Installer)
	BeforeUninstall	Occurs before the installers in the Installers property perform their uninstall operations. (Inherited from Installer)
	Committed	Occurs after all the installers in the Installers property have committed their installations. (Inherited from Installer)
	Committing	Occurs before the installers in the Installers property committ their installations. (Inherited from Installer)
	Disposed	Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component)

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Remarks

Users may choose to only install service application or its management tools, in either case common installation steps need to occur, so these steps are managed in this one common base class.

Reference

GSF.TimeSeries Namespace