Namespace: Consultingwerk.Framework
Class 
ConfigurationSettingsManager Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Framework.ConfigurationSettingsManager

Inherits: Progress.Lang.Object

File:ConfigurationSettingsManager
Purpose:Manages a set of serializable Configuration Setting objects
in an LRU List
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Aug 04 22:23:47 CEST 2012
Notes:The configuration objects shoudl implement the ISerializable
interface to allow storing them in the Registry

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ Progress.Lang.Object CreateInstance (Class) Creates an instance of a settings object
+ Progress.Lang.Object GetSettingByGUID (character) Get's a Setting object using a key
+ Consultingwerk.Framework.Collections.CharacterDictionary GetSettings () Returns the settings as a Dictionary with the GUID as the key and the ToString() value of the setting object as the value
+ MoveToBeginningOfLru (character) Moves the given object to the beginning of the LRU list
+ MoveToBeginningOfLru (Object) Moves the given object to the beginning of the LRU list
+ PopulateLruMenu (ToolsCollection, integer, character, logical) Populates a LRU Menu in an UltraToolbarsManager instance
+ RemoveInstance (character) Removes the given instance from the LRU list
+ RemoveInstance (Object) Removes the given instance from the LRU list
# RenumberSettings () Renumbers the settings from 1 on
+ RestoreFromSettingsService () Loads the LRU from the settings service
+ StoreToSettingsService () Stores the current LRU to the settings service


Method Detail
Top

PUBLIC Progress.Lang.Object CreateInstance (Class)
Purpose: Creates an instance of a settings object
Notes:

Parameters:
poClass Progress.Lang.Class
The Progress.Lang.Class to create an instance for
Returns Progress.Lang.Object
Top

PUBLIC Progress.Lang.Object GetSettingByGUID (character)
Purpose: Get's a Setting object using a key
Notes:

Parameters:
pcGUID CHARACTER
The GUID representing a Settings Instance
Returns Progress.Lang.Object
The Settings object represented by the GUID
Top

PUBLIC Consultingwerk.Framework.Collections.CharacterDictionary GetSettings ()
Purpose: Returns the settings as a Dictionary with the GUID as the key and the
ToString() value of the setting object as the value
Notes:

Returns Consultingwerk.Framework.Collections.CharacterDictionary
A CharacterDictionary containing the settings
Top

PUBLIC MoveToBeginningOfLru (character)
Purpose: Moves the given object to the beginning of the LRU list
Notes:

Parameters:
pcGUID CHARACTER
The GUID of the settings instance to move to the front
Top

PUBLIC MoveToBeginningOfLru (Object)
Purpose: Moves the given object to the beginning of the LRU list
Notes:

Parameters:
poSettings Progress.Lang.Object
The settings object to move to the beginning
Top

PUBLIC PopulateLruMenu (ToolsCollection, integer, character, logical)
Purpose: Populates a LRU Menu in an UltraToolbarsManager instance
Notes:

Parameters:
poToolsCollection Infragistics.Win.UltraWinToolbars.ToolsCollection
The ToolsCollection to populate
piItemCount INTEGER
The number of LRU menu items to create
pcPrefix CHARACTER
A prefix to be used for creating the Key
plDeleteExistingFromRootTools LOGICAL
Remove existing tools fomr the Root Tools collection first
Top

PUBLIC RemoveInstance (character)
Purpose: Removes the given instance from the LRU list
Notes:

Parameters:
pcGUID CHARACTER
The GUID of the settings object to remove from the LRU list
Top

PUBLIC RemoveInstance (Object)
Purpose: Removes the given instance from the LRU list
Notes:

Parameters:
poSettings Progress.Lang.Object
The settings object to remove from the LRU list
Top

PROTECTED RenumberSettings ()
Purpose: Renumbers the settings from 1 on
Notes:

Top

PUBLIC RestoreFromSettingsService ()
Purpose: Loads the LRU from the settings service
Notes:

Top

PUBLIC StoreToSettingsService ()
Purpose: Stores the current LRU to the settings service
Notes:



©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:28:46