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

The AppSettings type exposes the following members.

Constructors

  NameDescription
Public methodAppSettings

Methods

  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
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 methodStatic memberGetConnectionString
Provides the database connection string to the application.
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 methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodStatic memberUploadFolderLocation
Provides the upload folder location to normal files and demo files

Properties

  NameDescription
Public propertyStatic memberAccountingAvailable
Enables or Disables the Billing/Accounting for the users in the system. Do no modify this entry directly by editing this value if it is originally off. By default it is Off. If you wish to switch it on, use the Enable Accounting in OEM
Public propertyStatic memberAdminEmailAddress
Provides the email address for the site administrator
Public propertyStatic memberAlertDeleteDays
The number of days after which the alert is supposed to be automatically deleted
Public propertyStatic memberAllowBulkUpload
Determines if the bulk uploading is allowed
Public propertyStatic memberAuditLogging
Logs the login attempts in the windows NT/2000/XP event log, possible values are: OffAudit logging is offLevel1Only failed login attempts are loggedLevel2Failed and successful login attempts are loggedOnSame as level2
Public propertyStatic memberBoxVersion
Returns whether this is a beb based version or box version, there may be various things which will be included in the box version.
Public propertyStatic memberBusyIconActivate
Status to show if the busy icon is to be shown
Public propertyStatic memberCheckDemoGuard
Checks if the current account is the demo account, if it is a demo account, the return value is an error, if not, the return value is an empty string.
Public propertyStatic memberCheckForOldFormatPassword
Activates or deactivates the OCReminder Service
Public propertyStatic memberConnectionString
Provides the database connection string to the application.
Public propertyStatic memberCrystalReportsAvailable
Returns if the crystal reports is available as a part of the package.
Public propertyStatic memberCustomXml
This is where the custom pages are stored. It is advised that all custom files should be stored in the custom folder (and project) in a similar directory structure as that of officeclip. The value here is relative to the officeclip virtual directory folder.
Public propertyStatic memberDateStringFormat
Specify the date format used everywhere.
Public propertyStatic memberDiskSpaceQuota
If the disk space quota is enabled, this key determines how much amout of disk space (in MB) to be allocated for each account.
Public propertyStatic memberDocAccountDiskSpace
Returns the additional account disk space (MB) increment in document management
Public propertyStatic memberEmailServerName
The email server name that is used to send emails through OfficeClip. If this value is set to empty string in the web.config, no email will be sent
Public propertyStatic memberEmailServerName1
The Secondary Email Server Name, If the primary email server fails and this value in web.config is not empty, then OfficeClip will attempt to send emails through this server.
Public propertyStatic memberEmailServerName2
The Tertiary Email Server Name, If the primary and secondary email server fails and this value in web.config is not empty, then OfficeClip will attempt to send emails through this server.
Public propertyStatic memberHostStr
String for the host name where OfficeClip is installed
Public propertyStatic memberHostUrl
url representation of the HostStr
Public propertyStatic memberIsLdapAuthentication
Indicates whether all the necessary parameters for the LDAP authentication are available or not.
Public propertyStatic memberIsLoginPopup
Determines if the user is logged in on a popup window (no buttons, address bar etc.)
Public propertyStatic memberLdapAuthenticationString
The name of the LDAP Server with which OfficeClip is integrated. If there is value specified for this key, then the value for the next key i.e. LDAPAdminAccount must be specified for the whole integration to work properly.
Public propertyStatic memberLicenseServerLocation
The location of the license server
Public propertyStatic memberLoginAuthenticationMode
Gets the login authentication mode. This mainly depends on the web.config and the IIS settings
Public propertyStatic memberLoginPopupParameters
returns the popup parameter for the login screen (if the login popup is true)
Public propertyStatic memberMailFormat
The email format, it could be text or html. This is used to provide hints to the mail system if the OfficeClip send out html based emails.
Public propertyStatic memberMessageLogging
Logs the messages in the windows 2000 event log, possible values are
  • OffLogging is off
  • Level1Only errors and exceptions are logged
  • Level2errors, exceptions and warnings are logged
  • Level3errors, exceptions, warnings and information are logged
  • OnSame as level 3
Public propertyStatic memberOcDotComOnly
Use this for anything which is very very specific to OfficeClip.com only There are couple of instances which have to be specific to OfficeClip.com but should not be given to Non-BOXVERSIONS (e.g. people who will use OfficeClip as an Application Service Provider).
Public propertyStatic memberOcEmailAddress
Provides the email address for the OfficeClip administrator, this can also be the partner's email address for OfficeClip partners
Public propertyStatic memberOfficeClipWebSite
The OfficeClip website
Public propertyStatic memberPasswordStrength
Enter the password strength for creating the new password. The value is separated by semicolon. The first element is the minimum number of characters in the password, the second expression is the minimum number of non-alphanumeric characters in the password and the last element is the regular expression for the password. Note that you cannot put ; as a part of the regular expression. An empty value denotes that no password strength is enforced. All values are not required but the values should be put in the order specified. i.e. you cannot put the third value without putting the first and second value.
Public propertyStatic memberRegisteredCompany
Registered Company where the product is installed. This name shows up in the title bar.
Public propertyStatic memberRegistrationDetailsRequired
Tells if the registration detail is required. No registration detail information is asked if this is false.
Public propertyStatic memberReminderActivated
Activates or deactivates the OCReminder Service
Public propertyStatic memberReminderCallbackTimeSpan
Controls te timespan for the reminder callback
Public propertyStatic memberServerTimeZoneId
The timezone id of the server is the index to the timezone table in the OfficeClip database. This value in the web.config file should not be changed by the user manually.
Public propertyStatic memberServerUrl
Returns the complete server url to get to this OfficeClip web site
Public propertyStatic memberShowQuickHelp
Status to show if the quickhelp is to be shown
Public propertyStatic memberShowTracktime
Determines if the time tracking is on in various screens
Public propertyStatic memberShowVersionOnTitle
Returns whether to show the product version on the title bar
Public propertyStatic memberSpellCheckerAvailable
Flag indicating whether spell checker is available or not.
Public propertyStatic memberSuccessNotification
If set to on, the success notifcication screen is shown after every successful inserts and updates
Public propertyStatic memberSupportEmailAddress
Provides the email address for the support personnel
Public propertyStatic memberTimeStringFormat
Specifying the time format used everywhere
Public propertyStatic memberTutorialLocation
Location of the OfficeClip tutorials
Public propertyStatic memberUniqueId
The unique id used as a key to extranet forms. When the extranet foms are submitted, this will be checked for a match. If the key is compromised, the key will have to change and all the forms will need to be changed.
Public propertyStatic memberUploadFolderPath
The Upload folder path
Public propertyStatic memberVDirPath
The Virtual Directory Path from where officeclip is accessed
Public propertyStatic memberWebContentMenuStatus
Indictes if the Web Content menus are enabled. Web Content menu is enabled only when the file Upload/corp/{groupid}/corpmenu.xml file is present in the document folder, values are:
  • OffNo Web Content menu is shown, irrespective of the presence of corpmenu.xml file
  • AlwaysWeb Content menu is always shown if corpmenu.xml is present
  • OnRequestWeb Content menu is shown if the page request it and corpmenu.xml is present. By default officeclip will have this enabled for the homepage

See Also