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

The GeneralDB type exposes the following members.

Constructors

  NameDescription
Public methodGeneralDB

Methods

  NameDescription
Public methodAddOutputParameterOverloaded.
Public methodAddParameterOverloaded.
Protected methodAddParametersOverloaded.
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 methodDeleteClassification
Deletes a classification
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 methodFindNames
Find Names
Public methodGetClassification
Gets the details of a classification
Public methodGetClassifications
Gets the list of classifications
Public methodGetCorpMenuFiles
Gets all the files uploaded by the user to be used in a particular group's or organization's Menus.
Public methodGetCorpMenuPath
Checks if the Web Content menu xml file is present, and if the Web Content menu can be shown to the user, if so, returns the full path name of the xml file, if not returns the empty string. This menu file path is returned for a particular group..
Public methodGetCountries
Gets a list of all the countries names and the corresponding ids.
Public methodGetEmailActivationCode
Gets a randomly generated string which is used as an email activation code, which the users can Update after getting in their email in order to confirm that their email Address is valid as they could receive it.
Public methodGetFrameInformation
Is the top frame shown
Public methodGetGeneralCurrencyList
Gets the list of currencies
Public methodGetGroupListGridLayout
Returns the order in which the columns in the group list or address book are to be displayed. For more information refer to the OfficeClip customization document, level 1 customization using the groupList.xml.
Public methodGetGroupListGridNumberOfRows
Gets the number of rows per page as specified in the xml configuration file groupList.xml. Please refer to the OfficeClip level 1 customization help.
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 methodGetObjectDescription
Gets a short object description from the object type and object id
Public methodGetOfficeClipDbVersion
Retrives the OfficeClip Database Version
Public methodGetParameterCount
Gets the parameter count
(Inherited from OfficeClipDB.)
Public methodGetParameterValue
Gets the value of the parameter
(Inherited from OfficeClipDB.)
Public methodGetProxiedFromUsers
Gets the information related to the proxied users
Public methodGetProxyUsersList
Gets the proxy user list
Public methodGetRandomPassword
Gets a random password by matching a list of adjectives and nouns from the passwordCombination.xml file. Please refer to the OfficeClip level 1 customization help in order to customize the values of the randomly generated passwords.
Public methodGetSavedCorpMenu
Gets the menu definition chosen by the user which was stored in an xml file corresponding to a particular group.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInit
Initialize the connection parameters
(Inherited from OfficeClipDB.)
Public methodInitTransactionOverloaded.
Public methodInsertClassification
Inserts a new classification
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRollback
Rolls back the transaction
(Inherited from OfficeClipDB.)
Public methodSaveCorpMenuFile
Saves a menu definition created by the user in the form of an xml document for a particular group.
Public methodSaveQuickHelpProfile
Saves the quick help profile
Public methodSetCodeProtectorValue
Sets the code protector value
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 methodUpdateClassification
Updates a classification
Public methodUpdateProxyUsers
Updates the list of users who can be proxied an application or a particular operation within an application for the currently logged in user.
Public methodUploadCorpMenuFile
Uploads a file which can be used as a link to one of a particular group or organization Menus.
Public methodValidVersion
Validate the Version between the database and the code. It is assumed that if the major Version number and the minor Version number does not match, then the versions are mismatched and the application cannot run properly.

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