Namespace: Consultingwerk.Windows.Framework.Authorization
Class 
SmartMenuSecurityMaintenanceControl Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.SmartComponents.Base.SmartUserControl
Implements: IHasDesignerVerbs

File:SmartMenuSecurityMaintenanceControl
Purpose:User Control for the assignment of SMF Smart Menu Function
authurization to multiple users or groups
Author(s):Marko Rüterbories / Consultingwerk Ltd.
Created:Thu May 22 13:20:21 CEST 2014



Top Method Summary
Options Name Purpose
+ Cancel () Cancels pending changes
# CreateDummyChildNode (UltraTreeNode) Add a dummy ChildNode to the given ParentNode
# CreateRootNode () Adds a RootNode to the MenuTree
- CreateValueLists () Prepares all needed ValueLists for displaying the security settings
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# FetchUsers () Fetches the SmartUser's from the Backend
+ System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents () Returns a List of all Components in the Form
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
- GetAuthorizationData () Get Authorization data for the selected Users and Groups
- Consultingwerk.Windows.Framework.Authorization.SecurityItemData GetSecurityItemData (character, integer, character) Get the data of a SecurityItem
- InitializeComponent () Initializes the Visual Design
- MenuAdapter_AfterRetrieveData (Object, EventArgs) Invokes the population of the tree after retrieving data.
- MenuTree_BeforeCellActivate (Object, BeforeCellActivateEventArgs) Set the type of editor before activating the cell
- MenuTree_BeforeExpand (Object, CancelableNodeEventArgs) Invokes the population of the tree after a node has been selected and removes the DummyNode if nessesary.
- MenuTree_CellValueChanged (Object, CellValueChangedEventArgs) Write back changed Data to the Dataset
# OnHasPendingChangesChanged (EventArgs) Raises the HasPendingChangesChanged
# OnLoad (EventArgs) Raises the Load event
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ OpenUserAndGroupAuthorization (CharacterDictionary) Opens the User and Group Authorization for the given users and group identified by the entries in the provided CharacterList instance
# ParentFormDestroyedHandler (Object, EventArgs) Event handler for the FormDestroyed event of the owning Form
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
- PopulateNodeCells (UltraTreeColumnSet, UltraTreeNode) Populates the details of a Node by iterating thru all columns.
# PopulateTree (UltraTreeNode) Populates all child records of the given GUID to the tree.
+ Reload () Reloads authorization for the current owners
# SelectFirstMenuEntry () Selects the first real Menu Entry if possible
- SetupNodeLevelLayout () Setup the complete layout of the columns for all levelso
# SetValueListAppearance (AppearanceBase, logical, AuthorizationDefinedForEnum) Sets the appearance for the Value List
# SetValueListAppearance (ValueListItem, logical, AuthorizationDefinedForEnum) Sets the appearance for the Value List
+ StoreAuthorizationData () Stores changed Authorization data to the database
+ SubscribeParentFormDestroyed () Subscribes the ParentFormDestroyed event
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# SubscribeUserControlEvents () Allows for custom event subscriptions during OnLoad()
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
- SynchronizeItems (TreeNodesCollection, character, CellValueChangedEventArgs) Synchronization of all TreeEntries applying to the same FunctionGuid. If one is changed all others have to reflect the same value.

Top Constructor Summary
Options Name Purpose
+ SmartMenuSecurityMaintenanceControl () Initializes a new instance of the SmartMenuSecurityMaintenanceControl

Top Event Summary
Options Name Purpose
+ HasPendingChangesChanged (Object, EventArgs) Raised when the HasPendingChanges property has changed

Top Property Summary
Options Name Purpose
+ CHARACTER AlternativeLoginCompanyKey
# CHARACTER DesignerVerbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ LOGICAL DesignTime
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ LOGICAL HasPendingChanges
# CHARACTER HiddenProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ CHARACTER MenuBusinessEntityName
# CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# LOGICAL ParentFormDestroyedSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# LOGICAL UserControlEventsSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl


Method Detail
Top

PUBLIC Cancel ()

Purpose: Cancels pending changes
Notes: Reloads current security settinsg

Top

PROTECTED CreateDummyChildNode (UltraTreeNode)

Purpose: Add a dummy ChildNode to the given ParentNode
Notes:

Parameters:
poParentNode Infragistics.Win.UltraWinTree.UltraTreeNode
Object reference to the parent UltraTreeNode
Top

PROTECTED CreateRootNode ()

Purpose: Adds a RootNode to the MenuTree
Notes:

Top

PRIVATE CreateValueLists ()

Purpose: Prepares all needed ValueLists for displaying the security settings
Notes:

Top

PROTECTED CreateVerbs ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Creates Designer Verbs based on the DesignerVerbs property
Notes:

Top

PROTECTED FetchUsers ()

Purpose: Fetches the SmartUser's from the Backend
Notes:

Top

PUBLIC System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Returns a List of all Components in the Form
Notes: Supported on OpenEdge 11 only, due to dependency to the ComponentsCollection
list not available on 10.2B

Returns System.Collections.Generic.List <System.ComponentModel.Component>
The List of Components in the Form
Top

PRIVATE GetAuthorizationData ()

Purpose: Get Authorization data for the selected Users and Groups
Notes:

Top

PRIVATE Consultingwerk.Windows.Framework.Authorization.SecurityItemData GetSecurityItemData (character, integer, character)

Purpose: Get the data of a SecurityItem
Notes:

Parameters:
pcMenuGuid CHARACTER
Id of the requested menu item
piEntryIndex INTEGER
Index within the extent fields of the Temp-Table
pcTagValue CHARACTER
The default level of a SecurityItem
Returns Consultingwerk.Windows.Framework.Authorization.SecurityItemData
The cell data of the currently populated cell
Top

PRIVATE InitializeComponent ()

Purpose: Initializes the Visual Design
Notes:

Top

PRIVATE MenuAdapter_AfterRetrieveData (Object, EventArgs)

Purpose: Invokes the population of the tree after retrieving data.
Notes:

Parameters:
sender System.Object
The source of the event
e System.EventArgs
An EventArgs that contains no event data
Top

PRIVATE MenuTree_BeforeCellActivate (Object, BeforeCellActivateEventArgs)

Purpose: Set the type of editor before activating the cell
Notes:

Parameters:
sender System.Object
The source of the event
e Infragistics.Win.UltraWinTree.BeforeCellActivateEventArgs
An EventArgs that contains no event data
Top

PRIVATE MenuTree_BeforeExpand (Object, CancelableNodeEventArgs)

Purpose: Invokes the population of the tree after a node has been selected
and removes the DummyNode if nessesary.
Notes:

Parameters:
sender System.Object
The source of the event
e Infragistics.Win.UltraWinTree.CancelableNodeEventArgs
A CancelableEventArgs that contains the data for the event
Top

PRIVATE MenuTree_CellValueChanged (Object, CellValueChangedEventArgs)

Purpose: Write back changed Data to the Dataset
Notes:

Parameters:
sender System.Object
The source of the event
e Infragistics.Win.UltraWinTree.CellValueChangedEventArgs
An EventArgs that contains no event data
Top

PROTECTED OnHasPendingChangesChanged (EventArgs)

Purpose: Raises the HasPendingChangesChanged
Notes:

Parameters:
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for the event
Top

PROTECTED OnLoad (EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Raises the Load event
Notes: Subscribes the FormDestroyed event from the ParentForm

Parameters:
e System.EventArgs
The System.EventArgs with the data for this event
Top

PUBLIC OnVerbClicked (character)

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Event Handler method for Designer Verbs
Notes: This method is intended to be overridden

Parameters:
pcDesignerVerb CHARACTER
The name (Label) of the Designer Verb that was invoked
Top

PUBLIC OpenUserAndGroupAuthorization (CharacterDictionary)

Purpose: Opens the User and Group Authorization for the given users and
group identified by the entries in the provided CharacterList instance
Notes:

Parameters:
poOwnerList Consultingwerk.Framework.Collections.CharacterDictionary
The CharacterList providing the GUID's of the Users and Groups to load
Top

PROTECTED ParentFormDestroyedHandler (Object, EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Event handler for the FormDestroyed event of the owning Form
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

PRIVATE PopulateNodeCells (UltraTreeColumnSet, UltraTreeNode)

Purpose: Populates the details of a Node by iterating thru all columns.
Notes:

Parameters:
poColumnSet Infragistics.Win.UltraWinTree.UltraTreeColumnSet
The columnset associated with the current node
poNode Infragistics.Win.UltraWinTree.UltraTreeNode
The node to be populated
Top

PROTECTED PopulateTree (UltraTreeNode)

Purpose: Populates all child records of the given GUID to the tree.
Notes:

Parameters:
poParentNode Infragistics.Win.UltraWinTree.UltraTreeNode
Object reference to the parent UltraTreeNode
Top

PUBLIC Reload ()

Purpose: Reloads authorization for the current owners
Notes:

Top

PROTECTED SelectFirstMenuEntry ()

Purpose: Selects the first real Menu Entry if possible
Notes:

Top

PRIVATE SetupNodeLevelLayout ()

Purpose: Setup the complete layout of the columns for all levelso
Notes:

Top

PROTECTED SetValueListAppearance (AppearanceBase, logical, AuthorizationDefinedForEnum)

Purpose: Sets the appearance for the Value List
Notes:

Parameters:
poAppearance Infragistics.Win.AppearanceBase
The Appearance to format
plRestricted LOGICAL
Logical value describing if the entry is restricted (true) or unrestricted. Used to determine the entry color
poDefinedFor Consultingwerk.Windows.Framework.Authorization.AuthorizationDefinedForEnum
Enum value describing if the setting is defined for the Realm, everybody, a group or a user
Top

PROTECTED SetValueListAppearance (ValueListItem, logical, AuthorizationDefinedForEnum)

Purpose: Sets the appearance for the Value List
Notes:

Parameters:
poItem Infragistics.Win.ValueListItem
The ValueListItem to format
plRestricted LOGICAL
Logical value describing if the entry is restricted (true) or unrestricted. Used to determine the entry color
poDefinedFor Consultingwerk.Windows.Framework.Authorization.AuthorizationDefinedForEnum
Enum value describing if the setting is defined for the Realm, everybody, a group or a user
Top

PUBLIC StoreAuthorizationData ()

Purpose: Stores changed Authorization data to the database
Notes:

Top

PUBLIC SubscribeParentFormDestroyed ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Subscribes the ParentFormDestroyed event
Notes:

Top

PROTECTED SubscribeUserControlEvents ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Allows for custom event subscriptions during OnLoad()
Notes: Intended to be overridden in the inheriting user control

Top

PRIVATE SynchronizeItems (TreeNodesCollection, character, CellValueChangedEventArgs)

Purpose: Synchronization of all TreeEntries applying to the same FunctionGuid.
If one is changed all others have to reflect the same value.
Notes:

Parameters:
poTreeNodesCollection Infragistics.Win.UltraWinTree.TreeNodesCollection
TreeNodesCollection to be processed
pcFunctionGuid CHARACTER
The Guid of the Function that was changed
e Infragistics.Win.UltraWinTree.CellValueChangedEventArgs
An EventArgs instance that contains the data for the CellValueChanged event of the tree.


Constructor Detail
Top

PUBLIC SmartMenuSecurityMaintenanceControl ()

Purpose: Initializes a new instance of the SmartMenuSecurityMaintenanceControl
Notes:



Event Detail
Top

PUBLIC HasPendingChangesChanged (Object, EventArgs)

Purpose: Raised when the HasPendingChanges property has changed
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the HasPendingChangesChanged event
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for the event


Property Detail
Top

PUBLIC CHARACTER AlternativeLoginCompanyKey


Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVerbs

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns CHARACTER
Top

PUBLIC LOGICAL DesignTime

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL
Top

PUBLIC LOGICAL HasPendingChanges


Returns LOGICAL
Top

PROTECTED CHARACTER HiddenProperties

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns CHARACTER
Top

PUBLIC CHARACTER MenuBusinessEntityName


Returns CHARACTER
Top

PROTECTED CHARACTER NonBrowsableProperties

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns CHARACTER
Top

PROTECTED LOGICAL ParentFormDestroyedSubscribed

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL
Top

PROTECTED LOGICAL UserControlEventsSubscribed

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL


Temp-Table Detail


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       14.08.2022 21:52:12