[This is preliminary documentation and is subject to change.]
The DocumentDB type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | DocumentDB | Overloaded. |
Methods
Name | Description | |
---|---|---|
![]() | AddOutputParameter | Overloaded. |
![]() | AddParameter | Overloaded. |
![]() | AddParameters | Overloaded. |
![]() | CheckDocumentSets |
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.--------------------------------------------------------
|
![]() | CheckGroupApplicationFolder |
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.
|
![]() | CheckPreInsert | Overloaded. |
![]() | CheckUserApplicationFolder |
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.
|
![]() | 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.) |
![]() | Copy |
This function copies file from one folder to another.
|
![]() | CopyFile |
Copies the file into the file system.
|
![]() | CreateNewFolder |
Creates a new folder for a particular group/user.
|
![]() | DeleteDocumentDB |
Deletes the record corresponding to the document identified by documentId in the database
and returns the file name of that document.
|
![]() | DeleteFolderDB |
Deletes the record for a particular user corresponding to the folder identified by folderId in the database.
|
![]() | Dispose |
disposes the object for garbage collection
(Inherited from OfficeClipDB.) |
![]() | DocumentRenameFilesystem | |
![]() | 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.) |
![]() | GetAddressLinks | |
![]() | GetApplicationFolderId |
Gets the folder id corresponding to the application folder for either a user or a group.
|
![]() | GetApplicationInfo |
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.
|
![]() | GetAttachedDocs |
Gets all the documents attached to an item
inside a particular folder.
|
![]() | GetDiskSpaceUsed |
Gets the used disk space for the current account
|
![]() | GetDiskSpaceUsedForAccount |
Gets the used disk space for an account
|
![]() | GetDocumentInfo |
Gets the document related information for a particular document identified by documentId.
|
![]() | GetDocumentInfoFromDocList |
Gets document information based on document comma separated id list
|
![]() | GetDocumentName |
Gets a delimited name of all documents.
|
![]() | GetDocumentSendInfo |
Shows the documents which are passed to the user via email using the id
|
![]() | getFldDocs |
Gets the document details for the folder
|
![]() | getFolderDocs |
Gets the contents of a folder, then returns True/False if the folder is empty or not.
|
![]() | getFolderDocuments |
Gets the document details for the folder
|
![]() | GetFolderInfo |
Gets the folder related information for a particular folder identified by folderId.
|
![]() | GetGroupSpace |
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.
|
![]() | 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.) |
![]() | GetHistory |
Returns the history of all the operations performed on the document.
|
![]() | GetItemDocs |
Gets all documents attached to a another OfficeClip object. For example, timesheet, expense or tracker case.
|
![]() | GetLatestRevision |
Gets the latest revision of a particular document.
|
![]() | GetParameterCount |
Gets the parameter count
(Inherited from OfficeClipDB.) |
![]() | GetParameterValue |
Gets the value of the parameter
(Inherited from OfficeClipDB.) |
![]() | GetSharedDocuments |
Gets the shared documents for a particular user and for a particular group.
|
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GetUserSpace |
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.
|
![]() | GetVirtualFolder |
Gets the virtual folder path
|
![]() | GetVirtualFolderForApplication | |
![]() | GetVirtualFolderOld | Overloaded. |
![]() | GetVirtualPath | Overloaded. |
![]() | HasEnoughDiskSpace |
Checks if there is enough disk space
|
![]() | Init |
Initialize the connection parameters
(Inherited from OfficeClipDB.) |
![]() | InitTransaction | Overloaded. |
![]() | InsertDocumentHistory |
Inserts an entry in the document history table.
|
![]() | InsertFileAndDocument |
Inserts a document in a folder
|
![]() | IsDocumentPresent |
Checks if a particular document is present.
|
![]() | IsPostedFileValid |
Check if the file represented by the posted (uploaded) file is sytactically valid.
|
![]() | MarkDocumentActive |
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).
|
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | RemoveAllItemDocs |
Deletes all documents attached to a another OfficeClip object. For example, timesheet, expense or tracker case.
|
![]() | RemoveAttachment |
Removes the Attachment document attached to another OfficeClip object.
|
![]() | RemoveAttachmentIfTemp |
Remove the Attachment if it is marked as temp.
|
![]() | RemoveAttachments |
Remove the Attachments identified by the list of comma
separated document ids
|
![]() | RemoveDocument | Overloaded. |
![]() | RemoveFolder |
Removes the folder and all the associated documents
|
![]() | RemoveShare |
Removes the set of share from the system
|
![]() | RenameDocument |
Renames the documents of the document set
|
![]() | Rollback |
Rolls back the transaction
(Inherited from OfficeClipDB.) |
![]() | Search |
Gets the search result from the database using a particular group and a particular user.
|
![]() | SetLock |
Sets a lock on a particular document by the currently logged in user.
|
![]() | SetLockDownload |
Sets lock and Download status on a particular document for the currently logged in user.
|
![]() | 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.) |
![]() | SetUnlock |
Unlocks a particular document by a particular user.
|
![]() | SetupGroupApplicationFolder |
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.
|
![]() | SetupInitialFolders |
Sets up the initial folders
|
![]() | SetupUserApplicationFolder |
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.
|
![]() | SetViewDownload |
Sets view and download status on a particular document for the currently logged in user.
|
![]() | ToString | Returns a String that represents the current Object. (Inherited from Object.) |
![]() | UpdateDocumentStorage |
Updates all the document storage information for the a user or the group.
based on the information in the DocumentStorageInfo object.
|
![]() | UpdateKeywordDescription |
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.) |