[This is preliminary documentation and is subject to change.]

The MainDB type exposes the following members.

Constructors

  NameDescription
Public methodMainDB
The default constructor

Methods

  NameDescription
Public methodActivateEmail
Activates the user's email indentified by the activationCode provided by the user.
Public methodAddOutputParameterOverloaded.
Public methodAddParameterOverloaded.
Protected methodAddParametersOverloaded.
Public methodApplyForgotPassword
Sends a new randomly created password for the user in the email in case the user has forgotten the password.
Public methodChangeCurrentlySelectedGroup
Sets the currently selected group in the session to a particular group for the currently logged in user.
Public methodClearParameters
Clear all the sql stored procedure parameters
(Inherited from OfficeClipDB.)
Public methodClose
Close the connection, data adapter and the command
(Inherited from OfficeClipDB.)
Public methodCommit
Commits the transaction
(Inherited from OfficeClipDB.)
Public methodDispose
disposes the object for garbage collection
(Inherited from OfficeClipDB.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodExecuteNonQueryOverloaded.
Protected methodExecuteReader
Executes the sql datareader
(Inherited from OfficeClipDB.)
Protected methodExecuteScalar
Executes the query that returns a single valur
(Inherited from OfficeClipDB.)
Protected methodFill
Fills the dataset
(Inherited from OfficeClipDB.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
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.)
Public methodGetParameterCount
Gets the parameter count
(Inherited from OfficeClipDB.)
Public methodGetParameterValue
Gets the value of the parameter
(Inherited from OfficeClipDB.)
Public methodGetRegistrationEula
Gets the end user's license agreement to be shown and accepted by the user at the time of registration.
Public methodGetRegistrationQuestions
Gets a set of questions to be asked at the time of registration.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInit
Initialize the connection parameters
(Inherited from OfficeClipDB.)
Public methodInitTransactionOverloaded.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPasswordInOldFormat
Checks whether the password is in the old format i.e. prior to Version 6.1.1.
Public methodRegisterUser
Registers a user in the OfficeClip system.
Public methodResetCustomerPortalPassword
Resets the Extranet password
Public methodResetPassword
Resets the password for a particular user.
Public methodRollback
Rolls back the transaction
(Inherited from OfficeClipDB.)
Public methodSetDemoUserLogin
Public methodSetParameterValue
Sets the parameter value of the sql parameter to a known value
(Inherited from OfficeClipDB.)
Protected methodSetSPCommandOverloaded.
Protected methodSetSPDataAdapter
Sets the stored procedure data adapter
(Inherited from OfficeClipDB.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodUpdateDemoData
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...
Public methodUpdateRegistrationDetails
Updates the registration details for a user.
Public methodValidateUserLogin
Validates a user based on a given email Address and password.
Public methodValidateUserRegistration
Validates whether the user can be registered based on the values filled up by the user on the registration form.

Properties

  NameDescription
Public propertyConnectionString
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.)
Protected propertyDBConnString
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.)

See Also