Namespace: Consultingwerk.SmartComponents.Implementation
Class 
SmartToolbarController Copy to Clipboard
Parent classes:
Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
Consultingwerk.SmartComponents.Implementation.SmartToolbarController

Inherits: Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
Implements: Consultingwerk.SmartComponents.Interfaces.Design.IDesignCommitSource, Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource, Consultingwerk.SmartComponents.Interfaces.Design.IDesignTableIOSource, System.ComponentModel.ICustomTypeDescriptor, Consultingwerk.SmartComponents.IHasDesignerVerbs, Consultingwerk.SmartComponents.Interfaces.ISmartCommitSource, Consultingwerk.SmartComponents.Interfaces.ISmartNavigationSource, Consultingwerk.SmartComponents.Interfaces.ISmartTableIOSource, Consultingwerk.SmartComponents.Interfaces.ISmartToolbarControl

File:SmartToolbarController
Purpose:Main Toolbar/Ribbon Component of the SmartComponent Library
Provides controls for NavigationSource, TableIOSource
and CommitSource functions
Description:Extents the Infragistics UltraToolbarsManager class
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Jan 17 14:42:31 CET 2009

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ 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.
# CreateSmartNavigationTools () Creates the default tools for the SmarNavigationSource. 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
+ 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 Componetns
+ 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 Componetns
+ 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.
+ CHARACTER GetFormTypeName () Returns the type name of the Form that contains the Toolbar
+ 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 IsToolRestricted (character) Returns if the given tool is restricted by the IToolbarItemSecurityService
# LoadDefaultRibbonConfiguration () Loads a default Ribbon Design
# Consultingwerk.SmartComponents.Implementation.TableIOTargetControl NewTableIOTargetControl () Factory method for instances of the TableIOTargetControl class
# OnActiveSmartCommitTargetChanged (EventArgs) Raises the ActiveSmartCommitTargetChanged event
# 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
+ PerformToolbarSecurity () Performs Toolbar Security for non standard tools
+ PerformToolbarSecurity (ISmartTableIOTarget) Performs Toolbar Security
+ RaiseActiveSmartCommitTargetChanged () Raises the ActiveSmartCommitTargetChanged event
+ RegisterSmartCommitTarget (ISmartCommitTarget) Registers a new SmartCommitTarget
+ RegisterSmartNavigationTarget (ISmartNavigationTarget) Registers a SmartNavigationTarget with the SmartNavigationSource.
+ RegisterSmartTableIOTarget (ISmartTableIOTarget) Registers a SmartTableIOTarget with the SmartTableIOSource.
- SetDesignerProperties () Sets Properties to customize Visual Designer behaviour
+ 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

Top Property Summary
Options Name Purpose
+ Consultingwerk.SmartComponents.Interfaces.ISmartCommitTarget ActiveSmartCommitTarget Returns a reference to the current active SmartCommitTarget
+ Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget ActiveSmartNavigationTarget Returns a reference to the current active SmartNavigationTarget
+ Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget ActiveSmartTableIOTarget Returns a reference to the current active SmartTableIOTarget
+ LOGICAL AddNavigationTools This property is supposed to be set ONCE in the Visual Designer to create the default set of Navigation Tools
+ LOGICAL AddTableIOTools This property is supposed to be set ONCE in the Visual Designer to create the default set of TableIO Tools
# CHARACTER BindableProperties Property that is used to mark properties (comma-delimited list) that should be Data-Bindable
# CHARACTER CategorizedProperties Property that is used to mark properties (comma-delimited list) that should receive a Category attribute
# CHARACTER CategoryProperties Categories of the Property in the CategorizedProperty list
# CHARACTER DescribedProperties Property that is used to mark properties (comma-delimited list) that should receive a Description attribute
# CHARACTER DescriptionProperties Description of the Property in the DescribedProperties list
# CHARACTER DesignerVerbs Property that is used to generate Designer Verbs (actions for the Visual Designer)
# CHARACTER DesignerVisibilityAttributes The CHARACTER representation of the DesignerSerializationVisibiltiy attribute (Content/Visible/Hidden), see .NET Enumeration System.ComponentModel.DesignerSerializationVisibility
# CHARACTER DesignerVisibilityProperties Property that is used to mark properties (comma-delimited list) that should receive a DesignerSerializationVisibility Attribute
+ LOGICAL DesignTime Propery flags if the current instance of the SmartBindingSource is running at design time or runtime.
# CHARACTER HiddenProperties Property that is used to mark properties (comma-delimited list) that will be excluded from the .NET TypeDescriptor properties list
+ Consultingwerk.SmartComponents.Implementation.ListTableIOTargetControl ListTableIOTargetControl Returns the List of TableIOTargetControl instances
# CHARACTER NonBrowsableProperties Property that is used to mark properties (comma-delimited list) that should not show up in the Visual Designers Property Grid
+ Consultingwerk.SmartComponents.Base.ListISmartTableIOTarget SmartTableIOTargets Returns the List of SmartTableIOTargets as a generic List


Method Detail
Top

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

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

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

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

PUBLIC BeginControlUpdate ()
Purpose: Begins a series of updates to the Control
Notes:

Top

PUBLIC 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

PUBLIC 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

PROTECTED CreateSmartNavigationTools ()
Purpose: Creates the default tools for the SmarNavigationSource.
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

PROTECTED 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

PROTECTED CreateSmartTransactionTools ()
Purpose: Creates the default tools for the SmartCommitSource.
Notes:

Top

PROTECTED CreateVerbs ()
Purpose: Creates Designer Verbs based on the DesignerVerbs property
Notes:

Top

PUBLIC DeregisterSmartCommitTarget (ISmartCommitTarget)
Purpose: Registers a new SmartCommitTarget
Notes:

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

PUBLIC DeregisterSmartNavigationTarget (ISmartNavigationTarget)
Purpose: Deregisters a SmartNavigationTarget from the SmartNavigationSource.
Notes:

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

PUBLIC DeregisterSmartTableIOTarget (ISmartTableIOTarget)
Purpose: Deregisters a SmartTableIOTarget with the SmartTableIOSource.
Notes:

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

PROTECTED DesignTimeDisposedHandler (Object, EventArgs)
Purpose: Event handler for the Disposed Event of this Componetns
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

PUBLIC 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

PUBLIC 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

PUBLIC 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 delimeted list of ButtonTool Keys to be disabled
Top

PROTECTED DisposedHandler (Object, EventArgs)
Purpose: Event handler for the Disposed Event of this Componetns
Notes:

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

PUBLIC 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

PUBLIC 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

PUBLIC 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 delimeted list of ButtonTool Keys to be disabled
Top

PUBLIC EndControlUpdate ()
Purpose: Ends a series of updates to the Control
Notes:

Top

PUBLIC 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

PUBLIC 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

PUBLIC CHARACTER GetClassName ()
Purpose: Returns the class name of this instance of a component.
Notes:

Returns CHARACTER
The class name of the Component
Top

PUBLIC CHARACTER GetComponentName ()
Purpose: Returns the name of this instance of a component.
Notes:

Returns CHARACTER
The Component Name of this instance
Top

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC LOGICAL GetTableIOActionDisabled (ISmartTableIOTarget, TableIOActionEnum)
Purpose: Allows to permanently disable TableIO Tools in the SmartToolbarController
Notes: Useful for applying security settings to the toolbar
http://confluence.consultingwerkcloud.com/wiki/pages/viewpage.action?pageId=722342
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

PUBLIC 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

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

Top

PUBLIC 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

PUBLIC 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 maintaind on a per SmartTableIOTarget base
IToolbarItemSecurityService service

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

PROTECTED LoadDefaultRibbonConfiguration ()
Purpose: Loads a default Ribbon Design
Notes:

Top

PROTECTED 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

PROTECTED OnActiveSmartCommitTargetChanged (EventArgs)
Purpose: Raises the ActiveSmartCommitTargetChanged event
Notes:

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

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

Top

PROTECTED 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

PUBLIC 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

PUBLIC PerformToolbarSecurity ()
Purpose: Performs Toolbar Security for non standard tools
Notes:

Top

PUBLIC PerformToolbarSecurity (ISmartTableIOTarget)
Purpose: Performs Toolbar Security
Notes:

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

PUBLIC RaiseActiveSmartCommitTargetChanged ()
Purpose: Raises the ActiveSmartCommitTargetChanged event
Notes:

Top

PUBLIC RegisterSmartCommitTarget (ISmartCommitTarget)
Purpose: Registers a new SmartCommitTarget
Notes:

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

PUBLIC 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

PUBLIC 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

PRIVATE SetDesignerProperties ()
Purpose: Sets Properties to customize Visual Designer behaviour
Notes:

Top

PUBLIC SetTableIOActionDisabled (ISmartTableIOTarget, TableIOActionEnum, logical)
Purpose: Allows to permanently disable TableIO Tools in the SmartToolbarController
Notes: Useful for applying security settings to the toolbar
http://confluence.consultingwerkcloud.com/wiki/pages/viewpage.action?pageId=722342
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

PUBLIC SetTableIOActionDisabled (ISmartTableIOTarget, TableIOActionEnum, TableIOActionEnum, logical)
Purpose: Allows to permanently disable TableIO Tools in the SmartToolbarController
Notes: Useful for applying security settings to the toolbar
http://confluence.consultingwerkcloud.com/wiki/pages/viewpage.action?pageId=722342
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

PUBLIC 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
http://confluence.consultingwerkcloud.com/wiki/pages/viewpage.action?pageId=722342
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

PUBLIC 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
http://confluence.consultingwerkcloud.com/wiki/pages/viewpage.action?pageId=722342
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

PUBLIC 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
http://confluence.consultingwerkcloud.com/wiki/pages/viewpage.action?pageId=722342
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

PROTECTED 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

PROTECTED 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

PUBLIC 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 evnet
e Consultingwerk.SmartComponents.Base.SmartNavigationTargetPositionChangedEventArgs
The SmartNavigationTargetPositionChangedEventArgs instance with the data for this event
Top

PROTECTED 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

PUBLIC 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

PROTECTED 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

PROTECTED 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

PROTECTED UpdateTransactionState ()
Purpose: Updates the Buttons based on the TransactionState of the current SmartCommitTarget
Notes:



Constructor Detail
Top

PUBLIC SmartToolbarController ()
Purpose: Constructor for the SmartToolbarController class
Notes:

Top

PUBLIC 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

PUBLIC ActiveSmartCommitTargetChanged DELEGATE System.EventHandler
Purpose: Indicates that the ActiveSmartCommitTarget property has changed
Notes:

Delegate: System.EventHandler


Property Detail
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartCommitTarget ActiveSmartCommitTarget
Purpose: Returns a reference to the current active SmartCommitTarget
Notes:

Returns Consultingwerk.SmartComponents.Interfaces.ISmartCommitTarget
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget ActiveSmartNavigationTarget
Purpose: Returns a reference to the current active SmartNavigationTarget
Notes:

Returns Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget ActiveSmartTableIOTarget
Purpose: Returns a reference to the current active SmartTableIOTarget
Notes:

Returns Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
Top

PUBLIC LOGICAL AddNavigationTools
Purpose: This property is supposed to be set ONCE in the Visual Designer
to create the default set of Navigation Tools
Notes: In 10.2A a PUBLIC PROPERTY seems to be the only interaction possible
between custom ABL code and the Visual Designer. So this property
allows a developer to add the Tools required for the Navigation
Interface. This property is supposed to be "pressed" only once
(double click in the Property grid will set it to True, but the
property value will actually not change!).
Adding the Tools in the Visual Designer seems to be the only
possibility to have the tools available (for customization) in the
Visual Designer and not cause double tool key conflicts - as the
code generated for the SmartToolbarController instance
(UltraToolbarsManager) will add all Tools/Toolbars at runtime without
checking if they might have been created by the constructor etc.

Returns LOGICAL
Top

PUBLIC LOGICAL AddTableIOTools
Purpose: This property is supposed to be set ONCE in the Visual Designer
to create the default set of TableIO Tools
Notes: In 10.2A a PUBLIC PROPERTY seems to be the only interaction possible
between custom ABL code and the Visual Designer. So this property
allows a developer to add the Tools required for the Navigation
Interface. This property is supposed to be "pressed" only once
(double click in the Property grid will set it to True, but the
property value will actually not change!).
Adding the Tools in the Visual Designer seems to be the only
possibility to have the tools available (for customization) in the
Visual Designer and not cause double tool key conflicts - as the
code generated for the SmartToolbarController instance
(UltraToolbarsManager) will add all Tools/Toolbars at runtime without
checking if they might have been created by the constructor etc.

Returns LOGICAL
Top

PROTECTED CHARACTER BindableProperties
Purpose: Property that is used to mark properties (comma-delimited list) that
should be Data-Bindable
Notes: C# Annotation: [Bindable(true)]

Returns CHARACTER
Top

PROTECTED CHARACTER CategorizedProperties
Purpose: Property that is used to mark properties (comma-delimited list) that
should receive a Category attribute
Notes: C# Annotation: [Category("...")]
This is a comma delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER CategoryProperties
Purpose: Categories of the Property in the CategorizedProperty list
Notes: C# Annotation: [Category("...")]
This is a comma delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER DescribedProperties
Purpose: Property that is used to mark properties (comma-delimited list) that
should receive a Description attribute
Notes: C# Annotation: [Description("...")]
This is a comma delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER DescriptionProperties
Purpose: Description of the Property in the DescribedProperties list
Notes: C# Annotation: [Description("...")]
This is a CHR(1) delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVerbs
Purpose: Property that is used to generate Designer Verbs (actions for the
Visual Designer)
Notes:

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityAttributes
Purpose: The CHARACTER representation of the DesignerSerializationVisibiltiy
attribute (Content/Visible/Hidden), see .NET Enumeration
System.ComponentModel.DesignerSerializationVisibility
Notes: C# Annotation: [DesignerSerializationVisibility(...)]
This is a comma delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityProperties
Purpose: Property that is used to mark properties (comma-delimited list) that
should receive a DesignerSerializationVisibility Attribute
Notes: C# Annotation: [DesignerSerializationVisibility(...)]
This is a comma delimited list

Returns CHARACTER
Top

PUBLIC LOGICAL DesignTime
Purpose: Propery flags if the current instance of the SmartBindingSource
is running at design time or runtime.
Notes: Set during constructor using a check at the
System.ComponentModel.LicenseManager

Returns LOGICAL
Top

PROTECTED CHARACTER HiddenProperties
Purpose: Property that is used to mark properties (comma-delimited list) that
will be excluded from the .NET TypeDescriptor properties list
Notes:

Returns CHARACTER
Top

PUBLIC Consultingwerk.SmartComponents.Implementation.ListTableIOTargetControl ListTableIOTargetControl
Purpose: Returns the List of TableIOTargetControl instances
Notes: See http://jira.consultingwerkcloud.com/browse/SCL-442 for details

Returns Consultingwerk.SmartComponents.Implementation.ListTableIOTargetControl
Top

PROTECTED CHARACTER NonBrowsableProperties
Purpose: Property that is used to mark properties (comma-delimited list) that
should not show up in the Visual Designers Property Grid
Notes:

Returns CHARACTER
Top

PUBLIC Consultingwerk.SmartComponents.Base.ListISmartTableIOTarget SmartTableIOTargets
Purpose: Returns the List of SmartTableIOTargets as a generic List
Notes:

Returns Consultingwerk.SmartComponents.Base.ListISmartTableIOTarget


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