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

OfficeClip Utilities library

Classes

  ClassDescription
Public classAlphabetConstants
Maps the real alphabets with the AlphabetFilter enumerated type
Public classAppSettings
Retrives the appsettings from the configuration file. This file provides a wrapper over the web.config file.
Public classConfigureInfo
Stores the configuration information. This information is fetched from the database when the user logs into the system.
Public classConstants
Stores all constants used throughout the OfficeClip application
Public classDateTimeConst
This class provides functions to return meaningful names for various components of date according to the current locale.
Public classOCConvert
Provides some common data conversion functions used throughout OfficeClip
Public classOCCsvData
This class provides functions which aid in exchanging comma separated format data with OfficeClip.
Public classOCDateTime
This class provides methods to manipulate the date and time variables in OfficeClip.
Public classOCDebug
This class provides functions which aid in exchanging comma separated format data with OfficeClip.
Public classOCException
This class is a wrapper over the existing Exception class. It provides a meaningful way to send user defined messages and Priority along with the exception.
Public classOCFile
Class that supports file manipulation in OfficeCLip.
Public classOCHighlighter
Provides methods to aid highlighting information in OfficeClip
Public classOCHtmlControls
Provides dynamic html controls
Public classOCHtmlProperties
Provides a wrapper for changing properties of the html elements on the screen.
Public classOCImage
Provides methods for the manipulation of images in OfficeClip.
Public classOCLogger
This class provides functionality to log events in the event log feature of windows 2000 operating system.
Public classOCProfileData
This class is used to convert dataformat to and from the profile
Public classOCResources
Provides a wrapper for resources and resource manager. Resource Managers are used for various purposes, e.g. converting data from different locale.
Public classOCSecurity
This class will provide all the methods required to ensure that OfficeClip can be accessed in a secured fashion.
Public classOCSerialize
Provides serilization for classes only contaning primitive types of type Int32, DateTime, String, Double. This uses a more storage efficient collection mechanism and does not support any other data types.
Public classOCSms
Provides functions to Send SMS using Thirdparty API.
Public classOCString
Provides methods for additional string manipulation in OfficeClip programs.
Public classOCUri
Provides methods for the manipulation of the uri.
Public classOCUserControl
Class for manipulation of user controls
Public classPopulateDateItems
Populates the date components in a dropdown box. Examples of dropdown boxes are Month Dropdown, Week drop down etc.
Public classProvider
Helper class for the personalization provider
Public classRegionalSettings
The regional settings object
Public classService
Class to support the OfficeClip service layer interface
Public classSessionSettings
Provides methods to access OfficeClip session information.
Public classTimeZoneInfo
The Time Zone structure.
Public classUpDownLoad
Provides methods for Upload and Download of files in OfficeClip.
Public classXmlValidation
Validates the Xml document against a schema

Enumerations

  EnumerationDescription
Public enumerationAccessFunction
Creates the enumeration of Access permissions for all the functions in the system.This file will need to be modified when a new function is introduced in the system.
Public enumerationAccessPerm
Defines the access matrix for the user, this matrix decides, which function the user has access to in OfficeClip. Each access element can have one of the four values 0 = No Access 1 = Full Access 2 = Read Access only 3 = Read and update Access only (no insert or delete)
Public enumerationAlphabetFilter
Enumerated type for the alphabetic filter in the User Manager
Public enumerationApplicationReminderUpdateType
Enumerated type for updating the reminder when the event gets updated
Public enumerationCalendarView
Enumerated type for providing different calendar view to the calendar application
Public enumerationDeleteGroupAppType
Enumerated type for deleting various group applications in OfficeClip
Public enumerationDocHistoryStatus
The status enumerated type of document in the document history.
Public enumerationDocNodeType
Provides enumerated types for the document nodes.
Public enumerationDocSelectControl
Provides enumerated types for the document selection control.
Public enumerationDocTreeLeafSortType
Shows how the document tree leaves are sorted
Public enumerationDocTreeType
The Document tree type can be private or public
Public enumerationDocumentStorageType
Provides enumerated type for the Document storage types.
Public enumerationEmailAttachmentStatus
Enumerated type for email attachment status.
Public enumerationEmailFolders
Provides enumerated types for the various types of email folders.
Public enumerationEmailPriority
Enumerated types for email Priority.
Public enumerationEmailSearchBySize
Enumerated types of email search by its size logical operator.
Public enumerationEmailSearchByTime
Enumerated type for email search by time.
Public enumerationEmailSearchIn
Enumerated type of email search field
Public enumerationEmailStatus
The enumerated type for email status.
Public enumerationEmailTimestamps
Enumerated types for the email timestamps
Public enumerationEventShowAs
Various user status in response to an event
Public enumerationEventType
Enumerated type for various kinds of calendar events
Public enumerationExceptionType
Enumerated type for all the OfficeClip Exception types
Public enumerationGroupSelection
Enumerated type for the group selection in various applications including the calendar and the bulletin board
Public enumerationGroupType
Enumearted types for various types of groups in the User MAnager
Public enumerationLastVisited
Provides enumerated types for the last visited application. The last visited application is enterd into the profile as OFF=6/2/2001 8:1:00;CAL=;RMD=;BBD=;BMK=;RSV=;TMS=;TRK=;.
Public enumerationLoginAuthenticationMode
The login authentication type that is used to login to OfficeClip
Public enumerationOCServiceImportPolicy
The import policy used when importing an xml to OfficeClip. These import policies are used when the OfficeClip service id is present and it matches the OfficeClip current installation and other parameters.
Public enumerationOCServiceReturnStatus
Provides the return status of all the Service Calls
Public enumerationOCServiceType
Types of various objects that are converted to Xml. Especially used for creating the service id of each object.
Public enumerationOCSortDirection
Provides enumerated types for the direction of sort.
Public enumerationPeriodicity
Determins the enumerated type to define various periods in OfficeClip.
Public enumerationPurchaseMethod
Provides the purchase method, this can either be credit card or purchase order.
Public enumerationReportExportFormat
The export format for reports
Public enumerationReturnStatus
The generic return status in OfficeClip. Can either be Failure or Success.
Public enumerationSortByName
Enumerated type for sorting by name in various OfficeClip applications, especially in the User Manager
Public enumerationTESortType
Provides enumerated types for the sort type of Time and Expense Reporting application.
Public enumerationTimeAndExpenseAlias
Provides enumerated types for customers, projects and tasks for time and expense reporting.
Public enumerationTraceDebugSwitch
The switch for the tracing and debugging in OfficeClip code
Public enumerationTrackerFieldsNameId
Enumerated types for the tracker field names. In tracker, the field names can be chaged via the administrator utility
Public enumerationTrackerFilterChoiceId
The enumerated type for the tracker filter choices
Public enumerationUpDownLoad..::.UploadStatus
Returns the upload status of the file uploaded.
Public enumerationUserType
The type of the OfficeClip user
Public enumerationWorkflowAction
Provides enumerated types for the workflow actions.
Public enumerationWorkflowType
Provides enumerated types of the workflow types.