[This is preliminary documentation and is subject to change.]
The MainDB type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| MainDB |
The default constructor
|
Methods
| Name | Description | |
|---|---|---|
| ActivateEmail |
Activates the user's email indentified by the activationCode provided by the user.
| |
| AddOutputParameter | Overloaded. | |
| AddParameter | Overloaded. | |
| AddParameters | Overloaded. | |
| ApplyForgotPassword |
Sends a new randomly created password for the user in the email in case the user has forgotten the password.
| |
| ChangeCurrentlySelectedGroup |
Sets the currently selected group in the session to a particular group for the currently logged in user.
| |
| ClearParameters |
Clear all the sql stored procedure parameters
(Inherited from OfficeClipDB.) | |
| Close |
Close the connection, data adapter and the command
(Inherited from OfficeClipDB.) | |
| Commit |
Commits the transaction
(Inherited from OfficeClipDB.) | |
| Dispose |
disposes the object for garbage collection
(Inherited from OfficeClipDB.) | |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
| ExecuteNonQuery | Overloaded. | |
| ExecuteReader |
Executes the sql datareader
(Inherited from OfficeClipDB.) | |
| ExecuteScalar |
Executes the query that returns a single valur
(Inherited from OfficeClipDB.) | |
| Fill |
Fills the dataset
(Inherited from OfficeClipDB.) | |
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) | |
| GetHashCode | Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) | |
| GetParameterCount |
Gets the parameter count
(Inherited from OfficeClipDB.) | |
| GetParameterValue |
Gets the value of the parameter
(Inherited from OfficeClipDB.) | |
| GetRegistrationEula |
Gets the end user's license agreement to be shown and accepted by the user at the time of registration.
| |
| GetRegistrationQuestions |
Gets a set of questions to be asked at the time of registration.
| |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| Init |
Initialize the connection parameters
(Inherited from OfficeClipDB.) | |
| InitTransaction | Overloaded. | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
| PasswordInOldFormat |
Checks whether the password is in the old format i.e. prior to Version 6.1.1.
| |
| RegisterUser |
Registers a user in the OfficeClip system.
| |
| ResetCustomerPortalPassword |
Resets the Extranet password
| |
| ResetPassword |
Resets the password for a particular user.
| |
| Rollback |
Rolls back the transaction
(Inherited from OfficeClipDB.) | |
| SetDemoUserLogin | ||
| SetParameterValue |
Sets the parameter value of the sql parameter to a known value
(Inherited from OfficeClipDB.) | |
| SetSPCommand | Overloaded. | |
| SetSPDataAdapter |
Sets the stored procedure data adapter
(Inherited from OfficeClipDB.) | |
| ToString | Returns a String that represents the current Object. (Inherited from Object.) | |
| UpdateDemoData |
Updates the demo data... NOTE: This functions hould only be used with demo data otherwise it will mess up the dates of
all officeclip data...
| |
| UpdateRegistrationDetails |
Updates the registration details for a user.
| |
| ValidateUserLogin |
Validates a user based on a given email Address and password.
| |
| ValidateUserRegistration |
Validates whether the user can be registered based on the values filled up by the user on the registration form.
|
Properties
| Name | Description | |
|---|---|---|
| ConnectionString |
Gets the OfficeClip.DBLayer.ConnectionString property encapsulates
a callout to the ASP+ Config System to obtain the
database connection string for the application.
(Inherited from OfficeClipDB.) | |
| DBConnString |
The database connection string that is only available within the framework of the DBLayer.
This should only be set through a constructor so this is not available outside
the DBLayer. A default conection string is assumed if not set.
(Inherited from OfficeClipDB.) |
