Namespace: Consultingwerk.SmartComponents.Implementation
Class 
SmartRadRibbonBarController Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.SmartComponents.Base.SmartComponent
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.IPerformToolbarSecurity, Consultingwerk.SmartComponents.Interfaces.ISmartCommitSource, Consultingwerk.SmartComponents.Interfaces.ISmartNavigationSource, Consultingwerk.SmartComponents.Interfaces.ISmartTableIOSource, Consultingwerk.SmartComponents.Interfaces.ISmartToolbarControl, System.ComponentModel.ISupportInitialize

File:SmartRadRibbonBarController
Purpose:Enhances RabRibbonBar (or RadRibbonForm) with runtime
and design time functionality of the SmartComponent Library
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Apr 26 17:54:41 CEST 2015



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.
AddDefaultRibbonElements () Adds the Default Ribbon Elements
BeginControlUpdate () Begins a series of updates to the Control
BeginInit () Begins component initialization
Telerik.WinControls.UI.RibbonTab CreateDefaultRibbonTab () Creates the Default Ribbon Tab
System.Object CreateDesignTimeObjectInstance (Type) Creates a design time instance of the given System.Type
CreateNavigationGroup () Creates the Default Navigation Ribbon Group
Telerik.WinControls.UI.RadButtonElement CreateRibbonButton (RadRibbonBarGroup, character, character, character, character) Creates a Ribbon Button at Design Time
CreateTableIOGroup () Creates the Default TableIO Ribbon Group
CreateTransactionGroup () Creates the Default Transaction Ribbon Group
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 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 Components
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
EndInit () Invoked during the System.ComponentModel.ISupportInitialize.EndInit of the component (base class).
Consultingwerk.Framework.Collections.CharacterList GetAllToolKeys () Returns a CharacterList of all ToolKeys in the Toolbar
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
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
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
ItemClickHandler (Object, EventArgs) Event handler for the Click event of the Items
Consultingwerk.SmartComponents.Implementation.TableIOTargetControl NewTableIOTargetControl () Factory method for instances of the TableIOTargetControl class
OnActiveSmartCommitTargetChanged (EventArgs) Raises the ActiveSmartCommitTargetChanged event
OnVerbClicked (character) Event Handler method for Designer Verbs
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
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 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
SmartRadRibbonBarController () Constructor of the SmartRadRibbonBarController class. Set's the DesignTime property using the LicenseManager.
SmartRadRibbonBarController (IContainer) Constructor of the SmartRadRibbonBarController 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
Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget ActiveSmartNavigationTarget
Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget ActiveSmartTableIOTarget
Consultingwerk.SmartComponents.Implementation.ListTableIOTargetControl ListTableIOTargetControl
Telerik.WinControls.UI.RadRibbonBar RadRibbonBar
Consultingwerk.SmartComponents.Base.ListISmartTableIOTarget SmartTableIOTargets


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

AddDefaultRibbonElements ()

Purpose: Adds the Default Ribbon Elements
Notes:

Top

BeginControlUpdate ()

Purpose: Begins a series of updates to the Control
Notes: Not supported by the RadRibbonBar

Top

BeginInit ()

Purpose: Begins component initialization
Notes:

Top

Telerik.WinControls.UI.RibbonTab CreateDefaultRibbonTab ()

Purpose: Creates the Default Ribbon Tab
Notes:

Returns Telerik.WinControls.UI.RibbonTab
The new RibbonTab
Top

System.Object CreateDesignTimeObjectInstance (Type)

Purpose: Creates a design time instance of the given System.Type
Notes:

Parameters:
poType System.Type
The reference to the type to create an instance of
Returns System.Object
The reference to the new object instance
Top

CreateNavigationGroup ()

Purpose: Creates the Default Navigation Ribbon Group
Notes:

Top

Telerik.WinControls.UI.RadButtonElement CreateRibbonButton (RadRibbonBarGroup, character, character, character, character)

Purpose: Creates a Ribbon Button at Design Time
Notes:

Parameters:
poRibbonGroup Telerik.WinControls.UI.RadRibbonBarGroup
The RibbonGroup to add the button to
pcName CHARACTER
The name of the button to create
pcCaption CHARACTER
The caption to assign to the Button
pcLargeImage CHARACTER
The large image file name to load into the button
pcSmallImage CHARACTER
The small image file name to load into the button
Returns Telerik.WinControls.UI.RadButtonElement
The reference to the Ribbon Button that was created
Top

CreateTableIOGroup ()

Purpose: Creates the Default TableIO Ribbon Group
Notes:

Top

CreateTransactionGroup ()

Purpose: Creates the Default Transaction Ribbon Group
Notes:

Top

DeregisterSmartCommitTarget (ISmartCommitTarget)

Purpose: Registers a new SmartCommitTarget
Notes:

Parameters:
poTarget Consultingwerk.SmartComponents.Interfaces.ISmartCommitTarget
The ISmartCommitTarget to add to this SmartToolbarController
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 Components
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: Not supported by the RadRibbonBar

Top

EndInit ()

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

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

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

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

ItemClickHandler (Object, EventArgs)

Purpose: Event handler for the Click event of the Items
Notes:

Parameters:
sender System.Object
The reference to the Item that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
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

OnVerbClicked (character)

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

Parameters:
pcVerbText CHARACTER
The label of the verb the developer clicked on in the Visual Designer
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

RegisterSmartCommitTarget (ISmartCommitTarget)

Purpose: Registers a new SmartCommitTarget
Notes:

Parameters:
poTarget Consultingwerk.SmartComponents.Interfaces.ISmartCommitTarget
The ISmartCommitTarget to register
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

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

SmartRadRibbonBarController ()

Purpose: Constructor of the SmartRadRibbonBarController class. Set's the
DesignTime property using the LicenseManager.
Notes: According to
http://dotnetfacts.blogspot.com/2009/01/identifying-run-time-and-design-mode.html
that is only possible during the constructor of the class.

Top

SmartRadRibbonBarController (IContainer)

Purpose: Constructor of the SmartRadRibbonBarController class
Notes: Set's the DesignTime property using the LicenseManager. According to
http://dotnetfacts.blogspot.com/2009/01/identifying-run-time-and-design-mode.html
that is only possible during the constructor of the class.

Parameters:
poContainer System.ComponentModel.IContainer
The IContainer to add the SmartBusinessEntityAdapter to.


Event Detail
Top

ActiveSmartCommitTargetChanged DELEGATE System.EventHandler

Purpose: Indicates that the ActiveSmartCommitTarget property has changed
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

Consultingwerk.SmartComponents.Implementation.ListTableIOTargetControl ListTableIOTargetControl


Returns Consultingwerk.SmartComponents.Implementation.ListTableIOTargetControl
Top

Telerik.WinControls.UI.RadRibbonBar RadRibbonBar


Returns Telerik.WinControls.UI.RadRibbonBar
Top

Consultingwerk.SmartComponents.Base.ListISmartTableIOTarget SmartTableIOTargets


Returns Consultingwerk.SmartComponents.Base.ListISmartTableIOTarget


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       13.04.2026 10:23:44