Session Class

Initializes a new instance of the Session object.

Gets/sets whether or not auditing is suppressed. For security reasons there is no platform support for suppressing auditing in meta-data. This property must be set programmatically. Note that, even when auditing is suppressed, audit events such as AuditInsert, AuditUpdate, and AuditDelete will be fired and it is the responsibility of the audit-handling code (e.g. any audit extension) to honor this setting.

Gets/sets the culture of the default currency for the system. The culture is specified as a .Net culture such as en-GB (British Pounds Sterling) or en-US (United States Dollars).

The culture to use for dates in the application.

The default .Net numeric display format to use for fields mapped to currency data types, e.g. "c0" for currency with no subunits. If not specified, the currency format defaults to the "c" (standard currency) format.

The default .Net date/time display format to use for fields mapped to date/time data types, e.g. "d" for short dates. If not specified, the date/time format defaults to the "d" (short date) format.

The default .Net numeric display format to use for fields mapped to floating point data types, e.g. "n0". If not specified, the floating format defaults to the "f" (fixed-point) format.

The default .Net numeric display format to use for fields mapped to integer data types, e.g. "n0". If not specified, the integer format defaults to the "n0" (integer with thousands grouping) format.

Gets the value of LogPageActivity application property. This property determines whether or not page rquests should be logged to the xot_request_log table.

Gets the value of MasterSession.

Gets the value of NoViewStateCompression application property. This property determines whether or not the platform should compress the page ViewState.

The general culture to use numbers in the application.

Returns the preferences collection.

Gets/Sets the root path for the application. This property is set automatically in the context of the web server.

Gets/Sets the root URL to use for the application. This property is set automatically in the context of the web server.

Gets/Sets the root HTTP (vs. HTTPS) URL to use for the application. The HTTP root is currently only used to workaround IE6 limitations with downloading attachment documents under HTTPS. This property is set automatically in the context of the web server if HTTP is being used. If HTTPS is being used then the RootURLHttp application property must be set in order to populate this value.

Gets/Sets the application root relative path to the custom style sheet for the application.

Determines whether or not the ALT attribute should be suppressed. In general it should NOT be suppressed, but on a few older browsers (specifically IE6/7) we need to suppress ALT when no screen reader is being used and we want BubbleTips.

The ID of the current tenant. This will be null unless a custom session object overrides this method.

Gets/sets the user's current timezone. See TimeZones. The value will be null if the user's current timezone is now known.

The number of hours a persisted user token is valid. The default is 12 hours.

Returns true if the user Preferences have been loaded.

Identifies whether or not user is using a Screen Reader for the visually impaired.

The ID of the current vocab tenant. This will be equal to TenantID unless set.

Copies the current object and returns a clone.

Construct the object from the IAppContext properties.

Convert the specified date/time to the user's local TimeZone. If no source timezone is provided, UTC is assumed.

Generates the embedded functions from the values in the session variables. See EmbeddedParser.

Creates an instance of the Session object (loading from the cache when possible).

Creates a new Session object instance (loading from the cache when possible) with special handling when creating the master Session object instance.

Determines whether the specified Object is equal to the current Object.

Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.

Serves as a hash function for a particular type.

Returns a string from the application's TextItems collection

Returns a string from the application's TextItems collection.

Gets the Type of the current instance.

Returns the value of the property for the name.

Returns the value of the property for the name.

Load cached user preferences into this object.

Load cached user preferences into this object. When loading multiple levels of preferences, for example the traditional org hierarchy, country, company, user, say the initial call to this function used to set the preferences to loaded. However, the subsequent levels of hierarchy to be loaded by this function would then be marked as dirty because the collection was said to be loaded from the first call So now we add a parameter to tell the collection when it IS actually loaded This does put a little bit of onus on the end developer, writing session startup code, or preference handling to know when and not when to use this parameter However, I don't think a single end user developer would even touch this stuff during the time that the session start up/preferences is first written

Load user preferences into this object.

Load user preferences into this object. When loading multiple levels of preferences, for example the traditional org hierarchy, country, company, user, say the initial call to this function used to set the preferences to loaded. However, the subsequent levels of hierarchy to be loaded by this function would then be marked as dirty because the collection was said to be loaded from the first call So now we add a parameter to tell the collection when it IS actually loaded This does put a little bit of onus on the end developer, writing session startup code, or preference handling to know when and not when to use this parameter However, I don't think a single end user developer would even touch this stuff during the time that the session start up/preferences is first written

Creates a shallow copy of the current Object.

Persist the specified preference.

Persist the specified preference.

Save the persistant preferences.

Save the persistant preferences.

Set a value into this session's preference collection, but do not set the value on the session itself. Use the SetValue(String, Object, String, String) method to set both the preference and session member value.

Set a session value to the session itself and its preferences collection. Use the SetPrefOnly(String, Object, String, String) method to set only the preference and not the session member value.

Format a currency value per the FormatCurrency format in the CurrencyCulture culture.

Format a DateTime value per the FormatDateTime format in the DateCulture culture.

Format a floating point value per the FormatFloat format in the NumberCulture culture.

Format an integer value per the FormatInteger format in the NumberCulture culture.

Format a TimeSpan value per the current DateCulture and/or NumberCulture culture. Examples: "3h 12m 2s", "18.7 years", "17 days, 3h 21m". Note: At this time the generated string is not fully localized.

The following formatting characters are supported and may be combined:

• d - Include the date portion of the span (but only if days > 0).
• D - Include the date portion of the span (even when zero days).
• t - Include the time portion of the span.
• s - Include seconds if time is included in format.

Returns a String that represents the current Object.

The application context object associated with the Session.

The CustomProperties collection associated with the Session.

True if the user preferences have been loaded

Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.