Namespace: Consultingwerk.SmartComponents.Implementation
Class 
SmartRadRibbonBarController Copy to Clipboard
Parent classes:
Consultingwerk.SmartComponents.ComponentBase
Consultingwerk.SmartComponents.Base.SmartComponent
Consultingwerk.SmartComponents.Implementation.SmartRadRibbonBarController

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

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



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 Tiem
+ CreateTableIOGroup () Creates the Default TableIO Ribbon Group
+ CreateTransactionGroup () Creates the Default Transaction Ribbon Group
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ 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
+ 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.ComponentModel.AttributeCollection GetAttributes () Returns a collection of custom attributes for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ CHARACTER GetClassName () Returns the class name of this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ CHARACTER GetComponentName () Returns the name of this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ System.ComponentModel.TypeConverter GetConverter () Returns a type converter for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ System.ComponentModel.EventDescriptor GetDefaultEvent () Returns the default event for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ System.ComponentModel.PropertyDescriptor GetDefaultProperty () Returns the default property for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ System.Object GetEditor (Type) Returns an editor of the specified type for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ System.ComponentModel.EventDescriptorCollection GetEvents () Returns the events for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ System.ComponentModel.EventDescriptorCollection GetEvents (Attribute[]) Returns the events for this instance of a component using the specified attribute array as a filter.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ 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.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ System.ComponentModel.PropertyDescriptorCollection GetProperties (Attribute[]) Returns the properties for this instance of a component using the attribute array as a filter.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ System.Object GetPropertyOwner (PropertyDescriptor) Returns an object that contains the property described by the specified property descriptor.
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ 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
Overrides Consultingwerk.SmartComponents.Base.SmartComponent:OnVerbClicked (character)
+ 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
+ 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
# CHARACTER BindableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER CategorizedProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER CategoryProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER DescribedProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER DescriptionProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER DesignerVerbs
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER DesignerVisibilityAttributes
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER DesignerVisibilityProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ LOGICAL DesignTime
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# LOGICAL DesingerHostLoading
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# CHARACTER HiddenProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
# Consultingwerk.SmartComponents.Implementation.ListTableIOTargetControl ListTableIOTargetControl
# CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
+ Telerik.WinControls.UI.RadRibbonBar RadRibbonBar
+ Consultingwerk.SmartComponents.Base.ListISmartTableIOTarget SmartTableIOTargets


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

PROTECTED AddDefaultRibbonElements ()
Purpose: Adds the Default Ribbon Elements
Notes:

Top

PUBLIC BeginControlUpdate ()
Purpose: Begins a series of updates to the Control
Notes: Not supported by the RadRibbonBar

Top

PUBLIC BeginInit ()
Purpose: Begins component initialization
Notes:

Top

PUBLIC Telerik.WinControls.UI.RibbonTab CreateDefaultRibbonTab ()
Purpose: Creates the Default Ribbon Tab
Notes:

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

PROTECTED 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

PUBLIC CreateNavigationGroup ()
Purpose: Creates the Default Navigation Ribbon Group
Notes:

Top

PROTECTED Telerik.WinControls.UI.RadButtonElement CreateRibbonButton (RadRibbonBarGroup, character, character, character, character)
Purpose: Creates a Ribbon Button at Design Tiem
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

PUBLIC CreateTableIOGroup ()
Purpose: Creates the Default TableIO Ribbon Group
Notes:

Top

PUBLIC CreateTransactionGroup ()
Purpose: Creates the Default Transaction Ribbon Group
Notes:

Top

PROTECTED CreateVerbs ()
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
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: Not supported by the RadRibbonBar

Top

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

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 ()
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
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 ()
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
Purpose: Returns the class name of this instance of a component.
Notes:

Returns CHARACTER
The class name of the Component
Top

PUBLIC CHARACTER GetComponentName ()
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
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 ()
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
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 ()
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
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 ()
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
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)
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
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 ()
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
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[])
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
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 ()
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
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[])
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
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)
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent
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 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 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

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

PRIVATE 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

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

PUBLIC OnVerbClicked (character)
Overrides Consultingwerk.SmartComponents.Base.SmartComponent: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

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

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

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

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

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

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

PUBLIC 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

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

Returns Consultingwerk.SmartComponents.Interfaces.ISmartCommitTarget
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget ActiveSmartNavigationTarget

Returns Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget ActiveSmartTableIOTarget

Returns Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
Top

PROTECTED CHARACTER BindableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PROTECTED CHARACTER CategorizedProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PROTECTED CHARACTER CategoryProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PROTECTED CHARACTER DescribedProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PROTECTED CHARACTER DescriptionProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVerbs
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityAttributes
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PUBLIC LOGICAL DesignTime
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns LOGICAL
Top

PROTECTED LOGICAL DesingerHostLoading
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns LOGICAL
Top

PROTECTED CHARACTER HiddenProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PROTECTED Consultingwerk.SmartComponents.Implementation.ListTableIOTargetControl ListTableIOTargetControl

Returns Consultingwerk.SmartComponents.Implementation.ListTableIOTargetControl
Top

PROTECTED CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartComponent

Returns CHARACTER
Top

PUBLIC Telerik.WinControls.UI.RadRibbonBar RadRibbonBar

Returns Telerik.WinControls.UI.RadRibbonBar
Top

PUBLIC Consultingwerk.SmartComponents.Base.ListISmartTableIOTarget SmartTableIOTargets

Returns Consultingwerk.SmartComponents.Base.ListISmartTableIOTarget


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       04.02.2020 23:16:46