Consultingwerk.SmartComponents.Implementation.SmartToolbarController

Namespace:

Consultingwerk.SmartComponents.Implementation

Class

SmartToolbarController

Parent classes:

Infragistics.Win.UltraWinToolbars.UltraToolbarsManager

Consultingwerk.SmartComponents.Implementation.SmartToolbarController

Inherits:

Infragistics.Win.UltraWinToolbars.UltraToolbarsManager

Implements:

Top Method Summary

	Options	Name	Purpose
		ActivateSmartExportTarget (ISmartExportTarget)	Activates the SmartExportTarget
		ActivateSmartNavigationTarget (ISmartNavigationTarget)	Activate the given SmartNavigationTarget if it is registered with the SmartNavigationSource.
		ActivateSmartTableIOTarget (ISmartTableIOTarget)	Activate the given SmartTableIOTarget if it is registered as a SmartTableIOSource.
		BeginControlUpdate ()	Begins a series of updates to the Control
		Infragistics.Win.UltraWinToolbars.ButtonTool CreateButtonTool (character, character, character, character)	Creates a ButtonTool with Key, Caption, Customizer Caption and Image. This Method is executed by CreateSmartNavigationTools and CreateSmartTableIOTools when adding Navigation and TableIO Toolbars to the SmartToolbarController.
		Infragistics.Win.UltraWinToolbars.ButtonTool CreateButtonTool (character, character, character, character, character)	Creates a ButtonTool with Key, Caption, Customizer Caption and Image.
		CreateSmartExportTools ()
		CreateSmartNavigationTools ()	Creates the default tools for the SmartNavigationSource. Invoked by the Property setter for AddNavigationTools.
		CreateSmartTableIOTools ()	Creates the default tools for the SmartTableIOSource. Invoked by the property setter for AddTableIOTools.
		CreateSmartTransactionTools ()	Creates the default tools for the SmartCommitSource.
		CreateVerbs ()	Creates Designer Verbs based on the DesignerVerbs property
		DeregisterSmartCommitTarget (ISmartCommitTarget)	Registers a new SmartCommitTarget
		DeregisterSmartExportTarget (ISmartExportTarget)	Deregister a SmartExportTarget with the SmartExportSource. Usually done when a SmartExportTarget is deleted and the SmartExportSource is still running
		DeregisterSmartNavigationTarget (ISmartNavigationTarget)	Deregisters a SmartNavigationTarget from the SmartNavigationSource.
		DeregisterSmartTableIOTarget (ISmartTableIOTarget)	Deregisters a SmartTableIOTarget with the SmartTableIOSource.
		DesignTimeDisposedHandler (Object, EventArgs)	Event handler for the Disposed Event of this Components
		LOGICAL DisableControlTool (character)	Disables the tool with the given Key when it exists in this instance. Invoked by DisableTools.
		LOGICAL DisableTool (character)	Disables the tool with the given Key when it exists in this instance. Invoked by DisableTools.
		DisableTools (character)	Disables a list of tools when they exist in this instance. This Method is called from within the Toolbar depending on what action has been performed and what actions are possible with the current SmartTableIOTarget and SmartNavigationTarget.
		DisposedHandler (Object, EventArgs)	Event handler for the Disposed Event of this Component
		LOGICAL EnableControlTool (character)	Enables the tool with the given Key when it exists in this instance.
		LOGICAL EnableTool (character)	Enables the tool with the given Key when it exists in this instance.
		EnableTools (character)	Enables a list of tools when they exist in this instance.
		EndControlUpdate ()	Ends a series of updates to the Control
		Consultingwerk.Framework.Collections.CharacterList GetAllToolKeys ()	Returns a CharacterList of all ToolKeys in the Toolbar
		System.ComponentModel.AttributeCollection GetAttributes ()	Returns a collection of custom attributes for this instance of a component.
		CHARACTER GetClassName ()	Returns the class name of this instance of a component.
		CHARACTER GetComponentName ()	Returns the name of this instance of a component.
		System.ComponentModel.TypeConverter GetConverter ()	Returns a type converter for this instance of a component.
		System.ComponentModel.EventDescriptor GetDefaultEvent ()	Returns the default event for this instance of a component.
		System.ComponentModel.PropertyDescriptor GetDefaultProperty ()	Returns the default property for this instance of a component.
		System.Object GetEditor (Type)	Returns an editor of the specified type for this instance of a component.
		System.ComponentModel.EventDescriptorCollection GetEvents ()	Returns the events for this instance of a component.
		System.ComponentModel.EventDescriptorCollection GetEvents (Attribute[])	Returns the events for this instance of a component using the specified attribute array as a filter.
		System.Windows.Forms.Form GetForm ()	Returns the reference to the Form that contains the Toolbar
		CHARACTER GetFormTypeName ()	Returns the type name of the Form that contains the Toolbar
		CHARACTER GetName ()	Returns the name of the Toolbar instance
		System.ComponentModel.PropertyDescriptorCollection GetProperties ()	Returns the properties for this instance of a component.
		System.ComponentModel.PropertyDescriptorCollection GetProperties (Attribute[])	Returns the properties for this instance of a component using the attribute array as a filter.
		System.Object GetPropertyOwner (PropertyDescriptor)	Returns an object that contains the property described by the specified property descriptor.
		LOGICAL GetTableIOActionDisabled (ISmartTableIOTarget, TableIOActionEnum)	Allows to permanently disable TableIO Tools in the SmartToolbarController
		LOGICAL HasTool (character)	Returns if the Toolbar has a tool with the given key
		InitializeCaptionOfTools ()	Assign customized Caption CustomizerCaption and ToolTipText to the Tools of the Toolbar. Invoked by the Method OnEndInit
		Consultingwerk.SmartComponents.Implementation.TableIOTargetControl InvokeNewTableIOTargetControl ()	Returns a new instance of the TableIOTargetControl class
		LOGICAL IsControlToolEnabled (character)	Returns if the given Control tool is currently enabled
		LOGICAL IsToolRestricted (character)	Returns if the given tool is restricted by the IToolbarItemSecurityService
		LoadDefaultRibbonConfiguration ()	Loads a default Ribbon Design
		LockControl ()	Locks the Control when the Session is locked
		Consultingwerk.SmartComponents.Implementation.TableIOTargetControl NewTableIOTargetControl ()	Factory method for instances of the TableIOTargetControl class
		OnActiveSmartCommitTargetChanged (EventArgs)	Raises the ActiveSmartCommitTargetChanged event
		OnBeforeDispose (EventArgs)	Raises the BeforeDispose
		OnEndInit ()	Invoked during the System.ComponentModel.ISupportInitialize.EndInit of the component (base class).
		OnToolClick (ToolClickEventArgs)	Raises the ToolClick event
		OnVerbClicked (character)	Event Handler method for Designer Verbs
		ParentFormDestroyedHandler (Object, EventArgs)	Event handler for the FormDestroyed event of the owning Form
		PerformToolbarSecurity ()	Performs Toolbar Security for non standard tools
		PerformToolbarSecurity (ISmartTableIOTarget)	Performs Toolbar Security
		PerformToolbarSecurity (Form)	Performs Toolbar Security for non standard tools
		RaiseActiveSmartCommitTargetChanged ()	Raises the ActiveSmartCommitTargetChanged event
		LOGICAL RaiseToolbarAction (Object, ToolClickEventArgs, character)	Raises a toolbar action (method)
		RegisterSmartCommitTarget (ISmartCommitTarget)	Registers a new SmartCommitTarget
		RegisterSmartExportTarget (ISmartExportTarget)	Register a SmartExportTarget with the SmartExportSource. This Method is called by Classes implementing the ISmartExportTarget Interface when a new SmartExportSource is set.
		RegisterSmartNavigationTarget (ISmartNavigationTarget)	Registers a SmartNavigationTarget with the SmartNavigationSource.
		RegisterSmartTableIOTarget (ISmartTableIOTarget)	Registers a SmartTableIOTarget with the SmartTableIOSource.
		RegisterSmartToolbarTarget (ISmartToolbarTarget)	Register a SmartToolbarTarget with the SmartToolbarSource. This Method is called by Classes implementing the ISmartToolbarTarget Interface when a new SmartToolbarSource is set.
		setDesignerProperties ()	Sets Properties to customize Visual Designer behavior
		SetName (character)	Sets the name of the Toolbar instance
		SetTableIOActionDisabled (ISmartTableIOTarget, TableIOActionEnum, logical)	Allows to permanently disable TableIO Tools in the SmartToolbarController
		SetTableIOActionDisabled (ISmartTableIOTarget, TableIOActionEnum, TableIOActionEnum, logical)	Allows to permanently disable TableIO Tools in the SmartToolbarController
		SetTableIOActionDisabled (ISmartTableIOTarget, TableIOActionEnum, TableIOActionEnum, TableIOActionEnum, logical)	Allows to permanently disable TableIO Tools in the SmartToolbarController
		SetTableIOActionDisabled (ISmartTableIOTarget, TableIOActionEnum, TableIOActionEnum, TableIOActionEnum, TableIOActionEnum, logical)	Allows to permanently disable TableIO Tools in the SmartToolbarController
		SetTableIOActionDisabled (ISmartTableIOTarget, TableIOActionEnum, TableIOActionEnum, TableIOActionEnum, TableIOActionEnum, TableIOActionEnum, logical)	Allows to permanently disable TableIO Tools in the SmartToolbarController
		SmartTransactionStateChangedHandler (Object, EventArgs)	Event handler for the SmartTransactionStateChanged event of the SmartCommitTarget
		UpdateSmartNavigationTargetPosition (ISmartNavigationTarget, character)	Handles the update of a Position from the SmartNavigationTarget. This Method is called from the SmartDataAdapter derived Classes if the PositionChangedHandler is executed or from inside the ISmartNavigationSource implementing class when the Method UpdateSmartNavigationTargetState or RegisterSmartNavigationTarget are executed.
		UpdateSmartNavigationTargetPosition (Object, SmartNavigationTargetPositionChangedEventArgs)	Event handler for the SmartNavigationTargetPositionChanged event of the SmartNavigationTarget
		UpdateSmartNavigationTargetState (ISmartNavigationTarget, character)	Handles the update of a State from the SmartNavigationTarget. This Method is called from the SmartDataAdapter derived Classes if the Property setter of SmartDataSourceState is executed.
		UpdateSmartNavigationTargetState (Object, SmartNavigationTargetStateChangedEventArgs)	Event handler for the SmartNavigationTargetStateChanged event
		UpdateSmartTableIOState (ISmartTableIOTarget, character)	Handles the update of a State from the SmartTableIOTarget. This Method is called from the SmartViewerControl derived Classes if the Property setter of SmartTableIOState is executed.
		UpdateSmartTableIOState (Object, SmartTableIOStateChangedEventArgs)	Event handler for the SmartTableIOStateChange event of the TableIO Target
		UpdateTransactionState ()	Updates the Buttons based on the TransactionState of the current SmartCommitTarget

Top Constructor Summary

	Options	Name	Purpose
		SmartToolbarController ()	Constructor for the SmartToolbarController class
		SmartToolbarController (IContainer)	Constructor for the SmartToolbarController class

Top Event Summary

	Options	Name	Purpose
		ActiveSmartCommitTargetChanged DELEGATE System.EventHandler	Indicates that the ActiveSmartCommitTarget property has changed
		BeforeDispose DELEGATE System.EventHandler	Raised before the SmartToolbarController is disposing

Top Property Summary

	Options	Name	Purpose
		Consultingwerk.SmartComponents.Interfaces.ISmartCommitTarget ActiveSmartCommitTarget
		Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget ActiveSmartNavigationTarget
		Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget ActiveSmartTableIOTarget
		LOGICAL AddNavigationTools
		LOGICAL AddTableIOTools
		CHARACTER BindableProperties
		CHARACTER CategorizedProperties
		CHARACTER CategoryProperties
		CHARACTER DescribedProperties
		CHARACTER DescriptionProperties
		CHARACTER DesignerVerbs
		CHARACTER DesignerVisibilityAttributes
		CHARACTER DesignerVisibilityProperties
		LOGICAL DesignTime
		CHARACTER HiddenProperties
		Consultingwerk.SmartComponents.Implementation.ListTableIOTargetControl ListTableIOTargetControl
		CHARACTER NonBrowsableProperties
		Consultingwerk.SmartComponents.Base.ListISmartTableIOTarget SmartTableIOTargets

Method Detail

Top

ActivateSmartExportTarget (ISmartExportTarget)

Purpose:	Activates the SmartExportTarget
Notes:	This method has to be called if one Toolbar handles Export Targets
	Enforced by Interface ISmartNavigationSource.

Parameters:
poSmartExportTarget	Consultingwerk.SmartComponents.Interfaces.ISmartExportTarget
	The ISmartExportTarget instance to activate

Top

ActivateSmartNavigationTarget (ISmartNavigationTarget)

Purpose:	Activate the given SmartNavigationTarget if it is registered with
	the SmartNavigationSource.
Notes:	This Method has to be called if one Toolbar handles two or more
	SmartDataSources at a time.
	Enforced by Interface ISmartNavigationSource.

Parameters:
poSmartNavigationTarget	Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget
	The ISmartNavigationTarget instance to activate

Top

ActivateSmartTableIOTarget (ISmartTableIOTarget)

Purpose:	Activate the given SmartTableIOTarget if it is registered as a
	SmartTableIOSource.
Notes:	This Method has to be called if one Toolbar handles two or more
	SmartDataSources at a time.
	Enforced by the Interface ISmartTableIOSource.

Parameters:
poSmartTableIOTarget	Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
	The ISmartTableIOTarget to activate

Top

BeginControlUpdate ()

Purpose:	Begins a series of updates to the Control
Notes:

Top

Infragistics.Win.UltraWinToolbars.ButtonTool CreateButtonTool (character, character, character, character)

Purpose:	Creates a ButtonTool with Key, Caption, Customizer Caption and
	Image.
	This Method is executed by CreateSmartNavigationTools and
	CreateSmartTableIOTools when adding Navigation and TableIO Toolbars
	to the SmartToolbarController.
Notes:	Used to create the default Navigation and TableIO tools

Parameters:
pcButtonKey	CHARACTER
	Key used to identify the Button
pcButtonCaption	CHARACTER
	The Caption of the Button
pcButtonCustomizerCaption	CHARACTER
	The CustomizerCaption of the Button
pcButtonImage	CHARACTER
	The Image of the Button
Returns	Infragistics.Win.UltraWinToolbars.ButtonTool
	The reference to the new ButtonTool

Top

Infragistics.Win.UltraWinToolbars.ButtonTool CreateButtonTool (character, character, character, character, character)

Purpose:	Creates a ButtonTool with Key, Caption, Customizer Caption and
	Image.
Notes:	This Method is executed by CreateSmartNavigationTools and
	CreateSmartTableIOTools when adding Navigation and TableIO Toolbars
	to the SmartToolbarController.
	Used to create the default Navigation and TableIO tools

Parameters:
pcButtonKey	CHARACTER
	Key used to identify the Button
pcButtonCaption	CHARACTER
	The Caption of the Button
pcButtonCustomizerCaption	CHARACTER
	The CustomizerCaption of the Button
pcButtonImage	CHARACTER
	The Image of the Button
pcLargeButtonImage	CHARACTER
	The large Image of the Button
Returns	Infragistics.Win.UltraWinToolbars.ButtonTool
	The reference to the new ButtonTool

Top

CreateSmartExportTools ()

Top

CreateSmartNavigationTools ()

Purpose:	Creates the default tools for the SmartNavigationSource.
	Invoked by the Property setter for AddNavigationTools.
Notes:	All ButtonTools for Navigation purposes are created and added to
	a new instance of Infragistics.Win.UltraWinToolbars.UltraToolbar.

Top

CreateSmartTableIOTools ()

Purpose:	Creates the default tools for the SmartTableIOSource.
	Invoked by the property setter for AddTableIOTools.
Notes:	All ButtonTools for TableIO purposes are created and added to
	a new instance of Infragistics.Win.UltraWinToolbars.UltraToolbar.

Top

CreateSmartTransactionTools ()

Purpose:	Creates the default tools for the SmartCommitSource.
Notes:

Top

CreateVerbs ()

Purpose:	Creates Designer Verbs based on the DesignerVerbs property
Notes:

Top

DeregisterSmartCommitTarget (ISmartCommitTarget)

Purpose:	Registers a new SmartCommitTarget
Notes:

Parameters:
poTarget	Consultingwerk.SmartComponents.Interfaces.ISmartCommitTarget
	The ISmartCommitTarget to add to this SmartToolbarController

Top

DeregisterSmartExportTarget (ISmartExportTarget)

Purpose:	Deregister a SmartExportTarget with the SmartExportSource. Usually done
	when a SmartExportTarget is deleted and the SmartExportSource is still
	running
Notes:

Parameters:
poSmartExportTarget	Consultingwerk.SmartComponents.Interfaces.ISmartExportTarget
	The reference to the ISmartExportTarget to deregister

Top

DeregisterSmartNavigationTarget (ISmartNavigationTarget)

Purpose:	Deregisters a SmartNavigationTarget from the SmartNavigationSource.
Notes:

Parameters:
poSmartNavigationTarget	Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget
	The ISmartNavigationTarget to deregister

Top

DeregisterSmartTableIOTarget (ISmartTableIOTarget)

Purpose:	Deregisters a SmartTableIOTarget with the SmartTableIOSource.
Notes:

Parameters:
poSmartTableIOTarget	Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
	The ISmartTableIOTarget to deregister

Top

DesignTimeDisposedHandler (Object, EventArgs)

Purpose:	Event handler for the Disposed Event of this Components
Notes:	Removes links form this SmartToolbarController during design time
	to allow linking of the targets to another component after this
	component is removed

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

Top

LOGICAL DisableControlTool (character)

Purpose:	Disables the tool with the given Key when it exists in this instance.
	Invoked by DisableTools.
Notes:

Parameters:
pcToolKey	CHARACTER

Returns	LOGICAL
	True if the Tool exists, False if the Tool does not Exist

Top

LOGICAL DisableTool (character)

Purpose:	Disables the tool with the given Key when it exists in this instance.
	Invoked by DisableTools.
Notes:

Parameters:
pcToolKey	CHARACTER

Returns	LOGICAL
	true if the Tool exists, false if the Tool does not Exist

Top

DisableTools (character)

Purpose:	Disables a list of tools when they exist in this instance.
	This Method is called from within the Toolbar depending on what
	action has been performed and what actions are possible with the
	current SmartTableIOTarget and SmartNavigationTarget.
Notes:

Parameters:
pcToolKeys	CHARACTER
	Comma delimited list of ButtonTool Keys to be disabled

Top

DisposedHandler (Object, EventArgs)

Purpose:	Event handler for the Disposed Event of this Component
Notes:

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

Top

LOGICAL EnableControlTool (character)

Purpose:	Enables the tool with the given Key when it exists in this instance.
Notes:	Invoked by the SmartToolbarStateController:EnableTool. Does not check
	for any further authentication

Parameters:
pcToolKey	CHARACTER

Returns	LOGICAL
	True if the Tool exists, False if the Tool does not Exist

Top

LOGICAL EnableTool (character)

Purpose:	Enables the tool with the given Key when it exists in this instance.
Notes:	Invoked by EnableTools.

Parameters:
pcToolKey	CHARACTER

Returns	LOGICAL
	True if the Tool exists, False if the Tool does not Exist

Top

EnableTools (character)

Purpose:	Enables a list of tools when they exist in this instance.
Notes:	This Method is called from within the Toolbar depending on what
	action has been performed and what actions are possible with the
	current SmartTableIOTarget and SmartNavigationTarget.

Parameters:
pcToolKeys	CHARACTER
	Comma delimited list of ButtonTool Keys to be disabled

Top

EndControlUpdate ()

Purpose:	Ends a series of updates to the Control
Notes:

Top

Consultingwerk.Framework.Collections.CharacterList GetAllToolKeys ()

Purpose:	Returns a CharacterList of all ToolKeys in the Toolbar
Notes:

Returns	Consultingwerk.Framework.Collections.CharacterList
	The CharacterList of all ToolKeys in the Toolbar

Top

System.ComponentModel.AttributeCollection GetAttributes ()

Purpose:	Returns a collection of custom attributes for this instance of a
	component.
Notes:

Returns	System.ComponentModel.AttributeCollection
	The System.ComponentModel.AttributeCollection describing the types attributes

Top

CHARACTER GetClassName ()

Purpose:	Returns the class name of this instance of a component.
Notes:

Returns	CHARACTER
	The class name of the Component

Top

CHARACTER GetComponentName ()

Purpose:	Returns the name of this instance of a component.
Notes:

Returns	CHARACTER
	The Component Name of this instance

Top

System.ComponentModel.TypeConverter GetConverter ()

Purpose:	Returns a type converter for this instance of a component.
Notes:

Returns	System.ComponentModel.TypeConverter
	The System.ComponentModel.TypeConverter for this instance of a component.

Top

System.ComponentModel.EventDescriptor GetDefaultEvent ()

Purpose:	Returns the default event for this instance of a component.
Notes:

Returns	System.ComponentModel.EventDescriptor
	The System.ComponentModel.EventDescriptor for the default event of this component

Top

System.ComponentModel.PropertyDescriptor GetDefaultProperty ()

Purpose:	Returns the default property for this instance of a component.
Notes:

Returns	System.ComponentModel.PropertyDescriptor
	The System.ComponentModel.PropertyDescriptor for the default property of the component

Top

System.Object GetEditor (Type)

Purpose:	Returns an editor of the specified type for this instance of a
	component.
Notes:

Parameters:
editorBaseType	System.Type
	A System.Type that represents the editor for this object.
Returns	System.Object
	The reference to the Editor of the type of the component instance

Top

System.ComponentModel.EventDescriptorCollection GetEvents ()

Purpose:	Returns the events for this instance of a component.
Notes:

Returns	System.ComponentModel.EventDescriptorCollection
	The System.ComponentModel.EventDescriptorCollection describing the events of the component

Top

System.ComponentModel.EventDescriptorCollection GetEvents (Attribute[])

Purpose:	Returns the events for this instance of a component using the
	specified attribute array as a filter.
Notes:

Parameters:
attributes	System.Attribute[]
	A System.Attribute[] that is used as a filter.
Returns	System.ComponentModel.EventDescriptorCollection
	The System.ComponentModel.EventDescriptorCollection describing the events of the component

Top

System.Windows.Forms.Form GetForm ()

Purpose:	Returns the reference to the Form that contains the Toolbar
Notes:

Returns	System.Windows.Forms.Form
	The reference to the Form that contains the Toolbar

Top

CHARACTER GetFormTypeName ()

Purpose:	Returns the type name of the Form that contains the Toolbar
Notes:

Returns	CHARACTER
	The type name of the Form that contains the Toolbar

Top

CHARACTER GetName ()

Purpose:	Returns the name of the Toolbar instance
Notes:

Returns	CHARACTER
	The type name of the Toolbar instance

Top

System.ComponentModel.PropertyDescriptorCollection GetProperties ()

Purpose:	Returns the properties for this instance of a component.
Notes:

Returns	System.ComponentModel.PropertyDescriptorCollection
	A System.ComponentModel.PropertyDescriptorCollection that represents the properties for this component instance.

Top

System.ComponentModel.PropertyDescriptorCollection GetProperties (Attribute[])

Purpose:	Returns the properties for this instance of a component using the
	attribute array as a filter.
Notes:

Parameters:
attributes	System.Attribute[]
	A System.Attribute[] that is used as a filter.
Returns	System.ComponentModel.PropertyDescriptorCollection
	A System.ComponentModel.PropertyDescriptorCollection that represents the properties for this component instance.

Top

System.Object GetPropertyOwner (PropertyDescriptor)

Purpose:	Returns an object that contains the property described by the
	specified property descriptor.
Notes:

Parameters:
pd	System.ComponentModel.PropertyDescriptor
	A System.ComponentModel.PropertyDescriptor that represents the property whose owner is to be found.
Returns	System.Object
	An System.Object that represents the owner of the specified property.

Top

LOGICAL GetTableIOActionDisabled (ISmartTableIOTarget, TableIOActionEnum)

Purpose:	Allows to permanently disable TableIO Tools in the SmartToolbarController
Notes:	Useful for applying security settings to the toolbar
https://consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094803/Using+Toolbarsecurity+with+a+Security+Framework+like+Dynamics+Dynamics4.NET	//consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094803/Using+Toolbarsecurity+with+a+Security+Framework+like+Dynamics+Dynamics4.NET
	See http://jira.consultingwerkcloud.com/browse/SCL-442 for details on
	extending this for custom buttons

Parameters:
poSmartTableIOTarget	Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
	The reference to the ISmartTableIOTarget for this an action should be disabled
poTableIOAction	Consultingwerk.SmartComponents.Enum.TableIOActionEnum
	The TableIOActionEnum member identifying the action to enable/disable
Returns	LOGICAL
	Logical value indicating if the tool should be disabled. Set to FALSE to enable the tool

Top

LOGICAL HasTool (character)

Purpose:	Returns if the Toolbar has a tool with the given key
Notes:

Parameters:
pcToolKey	CHARACTER
	The key of the tool to check for
Returns	LOGICAL
	Logical value indicating if the tool has a key with the given name

Top

InitializeCaptionOfTools ()

Purpose:	Assign customized Caption CustomizerCaption and ToolTipText to the
	Tools of the Toolbar.
	Invoked by the Method OnEndInit
Notes:

Top

Consultingwerk.SmartComponents.Implementation.TableIOTargetControl InvokeNewTableIOTargetControl ()

Purpose:	Returns a new instance of the TableIOTargetControl class
Notes:

Returns	Consultingwerk.SmartComponents.Implementation.TableIOTargetControl
	The reference to the new instance of the TableIOTargetControl class

Top

LOGICAL IsControlToolEnabled (character)

Purpose:	Returns if the given Control tool is currently enabled
Notes:

Parameters:
pcToolKey	CHARACTER

Returns	LOGICAL
	Logical value indicating if the given Control tool is currently enabled

Top

LOGICAL IsToolRestricted (character)

Purpose:	Returns if the given tool is restricted by the IToolbarItemSecurityService
Notes:	Requires EndInit() to be executed first, not applicable to the
	TableIO Tools as they are maintained on a per SmartTableIOTarget base

Parameters:
pcToolKey	CHARACTER
	The key of the tool to test
Returns	LOGICAL
	Logical value indicating of the given tool is restricted by the IToolbarItemSecurityService service

Top

LoadDefaultRibbonConfiguration ()

Purpose:	Loads a default Ribbon Design
Notes:

Top

LockControl ()

Purpose:	Locks the Control when the Session is locked
Notes:

Top

Consultingwerk.SmartComponents.Implementation.TableIOTargetControl NewTableIOTargetControl ()

Purpose:	Factory method for instances of the TableIOTargetControl class
Notes:	Allows customers to return an extended version of the class in a custom
	variant of the SmartToolbarController class

Returns	Consultingwerk.SmartComponents.Implementation.TableIOTargetControl
	The new instance of the TableIOTargetControl class

Top

OnActiveSmartCommitTargetChanged (EventArgs)

Purpose:	Raises the ActiveSmartCommitTargetChanged event
Notes:

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

Top

OnBeforeDispose (EventArgs)

Purpose:	Raises the BeforeDispose
Notes:

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

Top

OnEndInit ()

Purpose:	Invoked during the System.ComponentModel.ISupportInitialize.EndInit
	of the component (base class).
Notes:	Set Navigation and TableIO tools disabled after initialization.

Top

OnToolClick (ToolClickEventArgs)

Purpose:	Raises the ToolClick event
Notes:	Invokes HandleToolClick with the key of the tool that was clicked

Parameters:
e	Infragistics.Win.UltraWinToolbars.ToolClickEventArgs
	The Infragistics.Win.UltraWinToolbars.ToolClickEventArgs with the data for this event

Top

OnVerbClicked (character)

Purpose:	Event Handler method for Designer Verbs
Notes:	This method is intended to be overridden

Parameters:
pcVerbText	CHARACTER
	The text indicating the verb that was clicked

Top

ParentFormDestroyedHandler (Object, EventArgs)

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

PerformToolbarSecurity ()

Purpose:	Performs Toolbar Security for non standard tools
Notes:

Top

PerformToolbarSecurity (ISmartTableIOTarget)

Purpose:	Performs Toolbar Security
Notes:

Parameters:
poSmartTableIOTarget	Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
	The ISmartTableIOTarget to perform authorization for

Top

PerformToolbarSecurity (Form)

Purpose:	Performs Toolbar Security for non standard tools
Notes:

Parameters:
poForm	System.Windows.Forms.Form
	The reference to the Form

Top

RaiseActiveSmartCommitTargetChanged ()

Purpose:	Raises the ActiveSmartCommitTargetChanged event
Notes:

Top

LOGICAL RaiseToolbarAction (Object, ToolClickEventArgs, character)

Purpose:	Raises a toolbar action (method)
Notes:

Parameters:
sender	System.Object
	The reference to the control that raised the ToolClick event
e	Infragistics.Win.UltraWinToolbars.ToolClickEventArgs
	The ToolClickEventArgs with the data for the ToolClick event
pcToolbarAction	CHARACTER
	The name of the toolbar action to raise (method name)
Returns	LOGICAL
	Logical value indicating if the action was executed

Top

RegisterSmartCommitTarget (ISmartCommitTarget)

Purpose:	Registers a new SmartCommitTarget
Notes:

Parameters:
poTarget	Consultingwerk.SmartComponents.Interfaces.ISmartCommitTarget
	The ISmartCommitTarget to register

Top

RegisterSmartExportTarget (ISmartExportTarget)

Purpose:	Register a SmartExportTarget with the SmartExportSource.
	This Method is called by Classes implementing the ISmartExportTarget
	Interface when a new SmartExportSource is set.
Notes:

Parameters:
poSmartExportTarget	Consultingwerk.SmartComponents.Interfaces.ISmartExportTarget
	The reference to the ISmartExportTarget to add to this SmartExportAdapter

Top

RegisterSmartNavigationTarget (ISmartNavigationTarget)

Purpose:	Registers a SmartNavigationTarget with the SmartNavigationSource.
Notes:	This Method is invoked by the SmartDataAdapter in the setter of
	the Property SmartNavigationSource.
	Enforced by the Interface ISmartNavigationSource.

Parameters:
poSmartNavigationTarget	Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget
	The ISmartNavigationTarget to register

Top

RegisterSmartTableIOTarget (ISmartTableIOTarget)

Purpose:	Registers a SmartTableIOTarget with the SmartTableIOSource.
Notes:	This Method is invoked by the SmartDataAdapter in the setter of
	the Property SmartTableIOSource.
	Enforced by the Interface ISmartTableIOSource.

Parameters:
poSmartTableIOTarget	Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
	The ISmartTableIOTarget to register

Top

RegisterSmartToolbarTarget (ISmartToolbarTarget)

Purpose:	Register a SmartToolbarTarget with the SmartToolbarSource.
	This Method is called by Classes implementing the ISmartToolbarTarget
	Interface when a new SmartToolbarSource is set.
Notes:

Parameters:
poSmartToolbarTarget	Consultingwerk.SmartComponents.Interfaces.ISmartToolbarTarget
	The reference to the ISmartToolbarTarget to add to this SmartToolbarAdapter

Top

setDesignerProperties ()

Purpose:	Sets Properties to customize Visual Designer behavior
Notes:

Top

SetName (character)

Purpose:	Sets the name of the Toolbar instance
Notes:

Parameters:
pcName	CHARACTER
	The type name of the Toolbar instance

Top

SetTableIOActionDisabled (ISmartTableIOTarget, TableIOActionEnum, logical)

Purpose:	Allows to permanently disable TableIO Tools in the SmartToolbarController
Notes:	Useful for applying security settings to the toolbar
https://consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094803/Using+Toolbarsecurity+with+a+Security+Framework+like+Dynamics+Dynamics4.NET	//consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094803/Using+Toolbarsecurity+with+a+Security+Framework+like+Dynamics+Dynamics4.NET
	See http://jira.consultingwerkcloud.com/browse/SCL-442 for details on
	extending this for custom buttons

Parameters:
poSmartTableIOTarget	Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
	The reference to the ISmartTableIOTarget for this an action should be disabled
poTableIOAction	Consultingwerk.SmartComponents.Enum.TableIOActionEnum
	The TableIOActionEnum member identifying the action to enable/disable
plDisabled	LOGICAL
	Logical value indicating if the tool should be disabled. Set to FALSE to enable the tool

Top

SetTableIOActionDisabled (ISmartTableIOTarget, TableIOActionEnum, TableIOActionEnum, logical)

Purpose:	Allows to permanently disable TableIO Tools in the SmartToolbarController
Notes:	Useful for applying security settings to the toolbar
https://consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094803/Using+Toolbarsecurity+with+a+Security+Framework+like+Dynamics+Dynamics4.NET	//consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094803/Using+Toolbarsecurity+with+a+Security+Framework+like+Dynamics+Dynamics4.NET
	See http://jira.consultingwerkcloud.com/browse/SCL-442 for details on
	extending this for custom buttons

Parameters:
poSmartTableIOTarget	Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
	The reference to the ISmartTableIOTarget for this an action should be disabled
poTableIOAction	Consultingwerk.SmartComponents.Enum.TableIOActionEnum
	The TableIOActionEnum member identifying the action to enable/disable
poTableIOAction2	Consultingwerk.SmartComponents.Enum.TableIOActionEnum
	The TableIOActionEnum member identifying the action to enable/disable
plDisabled	LOGICAL
	Logical value indicating if the tool should be disabled. Set to FALSE to enable the tool

Top

SetTableIOActionDisabled (ISmartTableIOTarget, TableIOActionEnum, TableIOActionEnum, TableIOActionEnum, logical)

Purpose:	Allows to permanently disable TableIO Tools in the SmartToolbarController
Notes:	Useful for applying security settings to the toolbar
https://consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094803/Using+Toolbarsecurity+with+a+Security+Framework+like+Dynamics+Dynamics4.NET	//consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094803/Using+Toolbarsecurity+with+a+Security+Framework+like+Dynamics+Dynamics4.NET
	See http://jira.consultingwerkcloud.com/browse/SCL-442 for details on
	extending this for custom buttons

Parameters:
poSmartTableIOTarget	Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
	The reference to the ISmartTableIOTarget for this an action should be disabled
poTableIOAction	Consultingwerk.SmartComponents.Enum.TableIOActionEnum
	The TableIOActionEnum member identifying the action to enable/disable
poTableIOAction2	Consultingwerk.SmartComponents.Enum.TableIOActionEnum
	The TableIOActionEnum member identifying the action to enable/disable
poTableIOAction3	Consultingwerk.SmartComponents.Enum.TableIOActionEnum
	The TableIOActionEnum member identifying the action to enable/disable
plDisabled	LOGICAL
	Logical value indicating if the tool should be disabled. Set to FALSE to enable the tool

Top

SetTableIOActionDisabled (ISmartTableIOTarget, TableIOActionEnum, TableIOActionEnum, TableIOActionEnum, TableIOActionEnum, logical)

Purpose:	Allows to permanently disable TableIO Tools in the SmartToolbarController
Notes:	Useful for applying security settings to the toolbar
https://consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094803/Using+Toolbarsecurity+with+a+Security+Framework+like+Dynamics+Dynamics4.NET	//consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094803/Using+Toolbarsecurity+with+a+Security+Framework+like+Dynamics+Dynamics4.NET
	See http://jira.consultingwerkcloud.com/browse/SCL-442 for details on
	extending this for custom buttons

Parameters:
poSmartTableIOTarget	Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
	The reference to the ISmartTableIOTarget for this an action should be disabled
poTableIOAction	Consultingwerk.SmartComponents.Enum.TableIOActionEnum
	The TableIOActionEnum member identifying the action to enable/disable
poTableIOAction2	Consultingwerk.SmartComponents.Enum.TableIOActionEnum
	The TableIOActionEnum member identifying the action to enable/disable
poTableIOAction3	Consultingwerk.SmartComponents.Enum.TableIOActionEnum
	The TableIOActionEnum member identifying the action to enable/disable
poTableIOAction4	Consultingwerk.SmartComponents.Enum.TableIOActionEnum
	The TableIOActionEnum member identifying the action to enable/disable
plDisabled	LOGICAL
	Logical value indicating if the tool should be disabled. Set to FALSE to enable the tool

Top

SetTableIOActionDisabled (ISmartTableIOTarget, TableIOActionEnum, TableIOActionEnum, TableIOActionEnum, TableIOActionEnum, TableIOActionEnum, logical)

Purpose:	Allows to permanently disable TableIO Tools in the SmartToolbarController
Notes:	Useful for applying security settings to the toolbar
https://consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094803/Using+Toolbarsecurity+with+a+Security+Framework+like+Dynamics+Dynamics4.NET	//consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094803/Using+Toolbarsecurity+with+a+Security+Framework+like+Dynamics+Dynamics4.NET
	See http://jira.consultingwerkcloud.com/browse/SCL-442 for details on
	extending this for custom buttons

Parameters:
poSmartTableIOTarget	Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
	The reference to the ISmartTableIOTarget for this an action should be disabled
poTableIOAction	Consultingwerk.SmartComponents.Enum.TableIOActionEnum
	The TableIOActionEnum member identifying the action to enable/disable
poTableIOAction2	Consultingwerk.SmartComponents.Enum.TableIOActionEnum
	The TableIOActionEnum member identifying the action to enable/disable
poTableIOAction3	Consultingwerk.SmartComponents.Enum.TableIOActionEnum
	The TableIOActionEnum member identifying the action to enable/disable
poTableIOAction4	Consultingwerk.SmartComponents.Enum.TableIOActionEnum
	The TableIOActionEnum member identifying the action to enable/disable
poTableIOAction5	Consultingwerk.SmartComponents.Enum.TableIOActionEnum
	The TableIOActionEnum member identifying the action to enable/disable
plDisabled	LOGICAL
	Logical value indicating if the tool should be disabled. Set to FALSE to enable the tool

Top

SmartTransactionStateChangedHandler (Object, EventArgs)

Purpose:	Event handler for the SmartTransactionStateChanged event of the SmartCommitTarget
Notes:

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

Top

UpdateSmartNavigationTargetPosition (ISmartNavigationTarget, character)

Purpose:	Handles the update of a Position from the SmartNavigationTarget.
	This Method is called from the SmartDataAdapter derived Classes
	if the PositionChangedHandler is executed or from inside the
	ISmartNavigationSource implementing class when the Method
	UpdateSmartNavigationTargetState or RegisterSmartNavigationTarget
	are executed.
Notes:	Enforced by Interface ISmartNavigationSource.

Parameters:
poSmartNavigationTarget	Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget
	The reference to the current SmartNavigationTarget
pcPosition	CHARACTER
	The RecordPositionEnum member indicating the new navigation target position

Top

UpdateSmartNavigationTargetPosition (Object, SmartNavigationTargetPositionChangedEventArgs)

Purpose:	Event handler for the SmartNavigationTargetPositionChanged event of the SmartNavigationTarget
Notes:

Parameters:
sender	System.Object
	The reference to the object that raised the event
e	Consultingwerk.SmartComponents.Base.SmartNavigationTargetPositionChangedEventArgs
	The SmartNavigationTargetPositionChangedEventArgs instance with the data for this event

Top

UpdateSmartNavigationTargetState (ISmartNavigationTarget, character)

Purpose:	Handles the update of a State from the SmartNavigationTarget.
	This Method is called from the SmartDataAdapter derived Classes
	if the Property setter of SmartDataSourceState is executed.
Notes:	Enforced by Interface ISmartNavigationSource.

Parameters:
poSmartNavigationTarget	Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget
	The reference to the current SmartNavigationTarget
pcState	CHARACTER
	The RecordPositionEnum member indicating the new navigation target state, Updating or Navigatable

Top

UpdateSmartNavigationTargetState (Object, SmartNavigationTargetStateChangedEventArgs)

Purpose:	Event handler for the SmartNavigationTargetStateChanged event
Notes:

Parameters:
sender	System.Object
	The reference to the object that raised the event
e	Consultingwerk.SmartComponents.Base.SmartNavigationTargetStateChangedEventArgs
	The SmartNavigationTargetStateChangedEventArgs instance with the data for this event

Top

UpdateSmartTableIOState (ISmartTableIOTarget, character)

Purpose:	Handles the update of a State from the SmartTableIOTarget.
	This Method is called from the SmartViewerControl derived Classes
	if the Property setter of SmartTableIOState is executed.
Notes:	Enforced by Interface ISmartTableIOSource.

Parameters:
poSmartTableIOTarget	Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
	The reference to the current ISmartTableIOTarget
pcSmartTableIOState	CHARACTER
	The current state of the SmartTableIOTarget instance, e.g. AddCopyAllowed, FieldsDisabled, FieldsEnabled, ModifyingData, NoDatasource

Top

UpdateSmartTableIOState (Object, SmartTableIOStateChangedEventArgs)

Purpose:	Event handler for the SmartTableIOStateChange event of the TableIO
	Target
Notes:

Parameters:
sender	System.Object
	The reference to the object that raised the event
e	Consultingwerk.SmartComponents.Base.SmartTableIOStateChangedEventArgs
	The SmartTableIOStateChangedEventArgs instance with the data for this event

Top

UpdateTransactionState ()

Purpose:	Updates the Buttons based on the TransactionState of the current SmartCommitTarget
Notes:

Constructor Detail

Top

SmartToolbarController ()

Purpose:	Constructor for the SmartToolbarController class
Notes:

Top

SmartToolbarController (IContainer)

Purpose:	Constructor for the SmartToolbarController class
Notes:

Parameters:
poContainer	System.ComponentModel.IContainer
	The System.ComponentModel.IContainer used as the Container for this component

Event Detail

Top

ActiveSmartCommitTargetChanged DELEGATE System.EventHandler

Purpose:	Indicates that the ActiveSmartCommitTarget property has changed
Notes:

Delegate: System.EventHandler

Top

BeforeDispose DELEGATE System.EventHandler

Purpose:	Raised before the SmartToolbarController is disposing
Notes:

Delegate: System.EventHandler

Property Detail

Top

Consultingwerk.SmartComponents.Interfaces.ISmartCommitTarget ActiveSmartCommitTarget

Returns	Consultingwerk.SmartComponents.Interfaces.ISmartCommitTarget

Top

Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget ActiveSmartNavigationTarget

Returns	Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget

Top

Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget ActiveSmartTableIOTarget

Returns	Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget

Top

LOGICAL AddNavigationTools

Returns	LOGICAL

Top

LOGICAL AddTableIOTools

Returns	LOGICAL

Top

CHARACTER BindableProperties

Returns	CHARACTER

Top

CHARACTER CategorizedProperties

Returns	CHARACTER

Top

CHARACTER CategoryProperties

Returns	CHARACTER

Top

CHARACTER DescribedProperties

Returns	CHARACTER

Top

CHARACTER DescriptionProperties

Returns	CHARACTER

Top

CHARACTER DesignerVerbs

Returns	CHARACTER

Top

CHARACTER DesignerVisibilityAttributes

Returns	CHARACTER

Top

CHARACTER DesignerVisibilityProperties

Returns	CHARACTER

Top

LOGICAL DesignTime

Returns	LOGICAL

Top

CHARACTER HiddenProperties

Returns	CHARACTER

Top

Consultingwerk.SmartComponents.Implementation.ListTableIOTargetControl ListTableIOTargetControl

Returns	Consultingwerk.SmartComponents.Implementation.ListTableIOTargetControl

Top

CHARACTER NonBrowsableProperties

Returns	CHARACTER

Top

Consultingwerk.SmartComponents.Base.ListISmartTableIOTarget SmartTableIOTargets

Returns	Consultingwerk.SmartComponents.Base.ListISmartTableIOTarget

info@consultingwerk.de http://www.consultingwerk.de 13.04.2026 10:23:47