Namespace: Consultingwerk.SmartComponents.Interfaces
Interface 
ISmartToolbarControl Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implemented by: Consultingwerk.SmartComponents.Implementation.SmartPanelController, Consultingwerk.SmartComponents.Implementation.SmartToolbarController

File:ISmartToolbarControl
Purpose:Interface for the callbacks from the SmartToolbarStateController
to the SmartToolbarController and the SmartRadRibbonController
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Apr 08 11:34:10 CEST 2015

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
+ LOGICAL DisableControlTool (character) Disables the tool with the given Key when it exists in this instance. Invoked by DisableTools.
+ LOGICAL EnableControlTool (character) Enables the tool with the given Key when it exists 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
+ CHARACTER GetFormTypeName () Returns the type name of the Form that contains the Toolbar
+ LOGICAL HasTool (character) Returns if the Toolbar has a tool with the given key
+ Consultingwerk.SmartComponents.Implementation.TableIOTargetControl InvokeNewTableIOTargetControl () Returns a new instance of the TableIOTargetControl class
+ RaiseActiveSmartCommitTargetChanged () Raises the ActiveSmartCommitTargetChanged event
+ SetTableIOActionDisabled (ISmartTableIOTarget, TableIOActionEnum, logical) Allows to permanently disable TableIO Tools in the SmartToolbarController

Top Property Summary
Options Name Purpose
+ LOGICAL DesignTime Propery flags if the current instance of the SmartBindingSource is running at design time or runtime.


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: Note, this method is actually typically proxy to the .NET BeginUpdate
method. It's named differently as the AVM .NET bridge sometimes has
issues with accessing .NET methods through ABL interfaces

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 EnableControlTool (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 EndControlUpdate ()
Purpose: Ends a series of updates to the Control
Notes: Note, this method is actually typically proxy to the .NET EndUpdate
method. It's named differently as the AVM .NET bridge sometimes has
issues with accessing .NET methods through ABL interfaces

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 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 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

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 RaiseActiveSmartCommitTargetChanged ()
Purpose: Raises the ActiveSmartCommitTargetChanged event
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


Property Detail
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


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