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

The DocumentDB type exposes the following members.

Constructors

  NameDescription
Public methodDocumentDBOverloaded.

Methods

  NameDescription
Public methodAddOutputParameterOverloaded.
Public methodAddParameterOverloaded.
Protected methodAddParametersOverloaded.
Public methodCheckDocumentSets
Checks the document (or folder) set and make sure that the operation that is supposed to be done on this set is allowed. The output status is flagged on the datatable.--------------------------------------------------------
Public methodCheckGroupApplicationFolder
Checks whether the application area folder is created corresponding to a particular application for a particular group. If the folder does not already exist, it is created.
Public methodCheckPreInsertOverloaded.
Public methodCheckUserApplicationFolder
Checks whether the application area folder is created corresponding to a particular application for a particular user. If the folder does not already exist, it is created.
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 methodCopy
This function copies file from one folder to another.
Protected methodCopyFile
Copies the file into the file system.
Public methodCreateNewFolder
Creates a new folder for a particular group/user.
Public methodDeleteDocumentDB
Deletes the record corresponding to the document identified by documentId in the database and returns the file name of that document.
Public methodDeleteFolderDB
Deletes the record for a particular user corresponding to the folder identified by folderId in the database.
Public methodDispose
disposes the object for garbage collection
(Inherited from OfficeClipDB.)
Protected methodDocumentRenameFilesystem
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 methodGetAddressLinks
Public methodGetApplicationFolderId
Gets the folder id corresponding to the application folder for either a user or a group.
Public methodGetApplicationInfo
Gets all the information related to those documents in the document management system which are being attached with other OfficeClip applications for a particular group.
Public methodGetAttachedDocs
Gets all the documents attached to an item inside a particular folder.
Public methodGetDiskSpaceUsed
Gets the used disk space for the current account
Public methodGetDiskSpaceUsedForAccount
Gets the used disk space for an account
Public methodGetDocumentInfo
Gets the document related information for a particular document identified by documentId.
Public methodGetDocumentInfoFromDocList
Gets document information based on document comma separated id list
Public methodGetDocumentName
Gets a delimited name of all documents.
Public methodGetDocumentSendInfo
Shows the documents which are passed to the user via email using the id
Public methodgetFldDocs
Gets the document details for the folder
Public methodgetFolderDocs
Gets the contents of a folder, then returns True/False if the folder is empty or not.
Protected methodgetFolderDocuments
Gets the document details for the folder
Public methodGetFolderInfo
Gets the folder related information for a particular folder identified by folderId.
Public methodGetGroupSpace
Gets the space related to a group. If the group space information is not present, then it is created using default value specified in web.config.
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 methodGetHistory
Returns the history of all the operations performed on the document.
Public methodGetItemDocs
Gets all documents attached to a another OfficeClip object. For example, timesheet, expense or tracker case.
Public methodGetLatestRevision
Gets the latest revision of a particular document.
Public methodGetParameterCount
Gets the parameter count
(Inherited from OfficeClipDB.)
Public methodGetParameterValue
Gets the value of the parameter
(Inherited from OfficeClipDB.)
Public methodGetSharedDocuments
Gets the shared documents for a particular user and for a particular group.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUserSpace
Gets the space related to a particular user. If the user space information is not present, then it is created using default value specified in web.config.
Public methodGetVirtualFolder
Gets the virtual folder path
Public methodGetVirtualFolderForApplication
Public methodGetVirtualFolderOldOverloaded.
Public methodGetVirtualPathOverloaded.
Public methodHasEnoughDiskSpace
Checks if there is enough disk space
Protected methodInit
Initialize the connection parameters
(Inherited from OfficeClipDB.)
Public methodInitTransactionOverloaded.
Public methodInsertDocumentHistory
Inserts an entry in the document history table.
Public methodInsertFileAndDocument
Inserts a document in a folder
Public methodIsDocumentPresent
Checks if a particular document is present.
Public methodIsPostedFileValid
Check if the file represented by the posted (uploaded) file is sytactically valid.
Public methodMarkDocumentActive
Mark all the documents as Active for deletion whose comma delimited list of document ids is being passed as argument and also set the new folder name (instead of -negative random).
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemoveAllItemDocs
Deletes all documents attached to a another OfficeClip object. For example, timesheet, expense or tracker case.
Public methodRemoveAttachment
Removes the Attachment document attached to another OfficeClip object.
Public methodRemoveAttachmentIfTemp
Remove the Attachment if it is marked as temp.
Public methodRemoveAttachments
Remove the Attachments identified by the list of comma separated document ids
Public methodRemoveDocumentOverloaded.
Public methodRemoveFolder
Removes the folder and all the associated documents
Public methodRemoveShare
Removes the set of share from the system
Public methodRenameDocument
Renames the documents of the document set
Public methodRollback
Rolls back the transaction
(Inherited from OfficeClipDB.)
Public methodSearch
Gets the search result from the database using a particular group and a particular user.
Public methodSetLock
Sets a lock on a particular document by the currently logged in user.
Public methodSetLockDownload
Sets lock and Download status on a particular document for the currently logged in user.
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 methodSetUnlock
Unlocks a particular document by a particular user.
Public methodSetupGroupApplicationFolder
Intializes the folder information in the database with default space related information and also creates a folder for group's application related documents. Does nothing if intialization has already taken place.
Public methodSetupInitialFolders
Sets up the initial folders
Public methodSetupUserApplicationFolder
Intializes the folder information in the database with default space related information and also creates a folder for currently logged in users's application related documents. Does nothing if intialization has already taken place.
Public methodSetViewDownload
Sets view and download status on a particular document for the currently logged in user.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodUpdateDocumentStorage
Updates all the document storage information for the a user or the group. based on the information in the DocumentStorageInfo object.
Public methodUpdateKeywordDescription

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