Session Methods |
The Session type exposes the following members.
Name | Description | |
---|---|---|
Clone |
Copies the current object and returns a clone.
| |
Construct |
Construct the object from the IAppContext properties.
| |
ConvertToUserTime |
Convert the specified date/time to the user's local TimeZone. If no source timezone is provided, UTC is assumed.
| |
CreateEmbeddedFunctions |
Generates the embedded functions from the values in the session variables.
See EmbeddedParser.
| |
CreateInstanceT(IAppContext) |
Creates an instance of the Session object (loading from the cache when possible).
| |
CreateInstanceT(IAppContext, Boolean) |
Creates a new Session object instance (loading from the cache when possible)
with special handling when creating the master Session object instance.
| |
Equals | (Inherited from Object.) | |
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.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetText(String) |
Returns a string from the application's TextItems collection
| |
GetText(String, String) |
Returns a string from the application's TextItems collection.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetValue(String) |
Returns the value of the property for the name.
| |
GetValue(String, String) |
Returns the value of the property for the name.
| |
LoadCachedPreferences(String, String, String, String) |
Load cached user preferences into this object.
| |
LoadCachedPreferences(String, String, String, String, Boolean) |
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
| |
LoadPreferences(String, String) |
Load user preferences into this object.
| |
LoadPreferences(String, String, Boolean) |
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
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
PersistUserPreference(String, Object, Boolean) |
Persist the specified preference.
| |
PersistUserPreference(String, Object, Boolean, Boolean) |
Persist the specified preference.
| |
SavePreferences |
Save the persistant preferences.
| |
SavePreferences(String, String) |
Save the persistant preferences.
| |
SetPrefOnly |
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.
| |
SetValue |
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.
| |
ToFormattedCurrency |
Format a currency value per the FormatCurrency format in the
CurrencyCulture culture.
| |
ToFormattedDateTime |
Format a DateTime value per the FormatDateTime format in the
DateCulture culture.
| |
ToFormattedFloat |
Format a floating point value per the FormatFloat format in the
NumberCulture culture.
| |
ToFormattedInteger |
Format an integer value per the FormatInteger format in the
NumberCulture culture.
| |
ToFormattedTimeSpan |
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:
| |
ToString | (Inherited from Object.) |
Name | Description | |
---|---|---|
EqualValue |
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.
(Defined by EAPUtil.) |