Consultingwerk.Windows.Framework.Authorization.FormAuthorizationSecurityTokensControl

Namespace:

Consultingwerk.Windows.Framework.Authorization

Class

FormAuthorizationSecurityTokensControl

Parent classes:

Progress.Windows.UserControl

Consultingwerk.SmartComponents.Base.SmartUserControl

Consultingwerk.Windows.Framework.Authorization.FormAuthorizationSecurityTokensControl

Inherits:

Consultingwerk.SmartComponents.Base.SmartUserControl

Implements:

Consultingwerk.Windows.Framework.Authorization.IFormAuthorizationAreaControl, IHasDesignerVerbs

Top Method Summary

	Options	Name	Purpose
		EnsureTokenValueList ()	Prepares the value list for selecting the security token of a tab page in the item value column of the grid
		System.Drawing.Image GetElementTypeImage (character)	Returns the repository type icon image for the given type icon key
		CHARACTER GetSelectedFolderGuid ()	Returns the ElementGuid of the tab folder selected in the combo-box
		InitializeComponent ()
		LoadArea (character, dataset, CharacterDictionary)	Populates the area from the structural data of the repository based form and retrieves the authorization for the given owners
		PopulateFolderList ()	Populates the tab folder combo-box from the TABFOLDER elements of the structural data
		PopulateFolderPages ()	Populates the grid with the tab pages of the tab folder selected in the combo-box and retrieves the authorization of their security tokens
		StoreArea ()	Stores the pending changes of the area
		StoreSecurityTokenChanges ()	Stores the changed security tokens of the tab pages of the loaded tab folder
		ultraComboEditor1_ValueChanged (Object, EventArgs)	Event handler for the ValueChanged event of the tab folder combo-box

Top Constructor Summary

	Options	Name	Purpose
		FormAuthorizationSecurityTokensControl ()	Initializes a new instance of the FormAuthorizationSecurityTokensControl

Top Property Summary

	Options	Name	Purpose
		CHARACTER AreaKey
		Consultingwerk.Windows.Framework.Authorization.SecurityAssignmentGridControl SecurityAssignmentGrid

Method Detail

Top

EnsureTokenValueList ()

Purpose:	Prepares the value list for selecting the security token of a tab page
	in the item value column of the grid
Notes:	The data value of the value list entries is the SecurityTokenCode, as
	eSmartPage.SecurityToken stores the code of the token. Built once per
	instance - assigned to the grid on the first LoadArea call rather than
	in the constructor, so that no backend request is made at design time

Top

System.Drawing.Image GetElementTypeImage (character)

Purpose:	Returns the repository type icon image for the given type icon key
Notes:	The images come from the RyComponentType16 value list of the
	IValueListProvider - the same icons the instances grid of the Object
	Master form displays. The value list is resolved once per instance

Parameters:
pcTypeIcon	CHARACTER
	The type icon key of the element (ElementTypeIcon)
Returns	System.Drawing.Image
	The image of the type icon or the unknown value

Top

CHARACTER GetSelectedFolderGuid ()

Purpose:	Returns the ElementGuid of the tab folder selected in the combo-box
Notes:

Returns	CHARACTER
	The ElementGuid of the selected tab folder or the empty value

Top

InitializeComponent ()

Top

LoadArea (character, dataset, CharacterDictionary)

Purpose:	Populates the area from the structural data of the repository based
	form and retrieves the authorization for the given owners
Notes:	Fills the tab folder combo-box from the TABFOLDER elements of the
	dataset and the grid with the tab pages of the selected tab folder

Parameters:
pcObjectMasterName	CHARACTER
	The name of the Object Master of the repository based form
dsFormAuthorizationStructure	DATASET dsFormAuthorizationStructure
	The ProDataset with the structural data of the form
poOwnerList	Consultingwerk.Framework.Collections.CharacterDictionary
	The CharacterDictionary with the GUID's of the users and groups and the Default (Everybody) pseudo owner key

Top

PopulateFolderList ()

Purpose:	Populates the tab folder combo-box from the TABFOLDER elements of the
	structural data
Notes:	Keeps the current selection when the tab folder still exists and
	selects the first tab folder otherwise

Top

PopulateFolderPages ()

Purpose:	Populates the grid with the tab pages of the tab folder selected in
	the combo-box and retrieves the authorization of their security tokens
Notes:	The row key of a page row is the PageGuid. Pages without a security
	token are registered without a security item, so their owner cells
	stay inactive until a token has been assigned and stored

Top

StoreArea ()

Purpose:	Stores the pending changes of the area
Notes:	Stores the changes to the security assignment first and the changes to
	the security tokens of the tab pages afterwards - a newly assigned
	token creates its security item on the server, so the refreshed
	structural data is required before its assignment can be maintained

Top

StoreSecurityTokenChanges ()

Purpose:	Stores the changed security tokens of the tab pages of the loaded tab
	folder
Notes:	Applies the token values of the grid rows to the ttFormAuthorizationPage
	records and invokes the StorePageSecurityTokens method of the
	FormAuthorizationBusinessTask, which updates eSmartPage.SecurityToken
	and returns the refreshed structural data of the form - including the
	security items of the newly assigned tokens. The area is then
	re-populated from the refreshed data

Top

ultraComboEditor1_ValueChanged (Object, EventArgs)

Purpose:	Event handler for the ValueChanged event of the tab folder combo-box
Notes:	Offers to store pending changes of the previously selected tab folder
	and populates the grid with the tab pages of the newly selected one

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