Namespace: Consultingwerk.SmartComponents.Implementation
Class 
SmartNavigationPanel Copy to Clipboard
Parent classes:
Progress.Windows.UserControl
Consultingwerk.SmartComponents.Base.SmartUserControl
Consultingwerk.SmartComponents.Implementation.SmartNavigationPanel

Inherits: Consultingwerk.SmartComponents.Base.SmartUserControl
Implements: Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource, Consultingwerk.SmartComponents.Interfaces.IDoNotCheckOkToClose, IHasDesignerVerbs, Consultingwerk.SmartComponents.Interfaces.ISmartNavigationSource

File:SmartNavigationPanel
Purpose:A simple navigation panel in Windows Vista / Windows 7
Explorer style
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Mar 10 18:49:25 CET 2010

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.
- BtnFirst_Click (Object, EventArgs) Event handler for the Click event of BtnFirst
- BtnLast_Click (Object, EventArgs) Event handler for the Click event of BtnLast
- BtnNext_Click (Object, EventArgs) Event handler for the Click event of BtnNext
- BtnPrev_Click (Object, EventArgs) Event handler for the Click event of BtnPrev
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ DeregisterSmartNavigationTarget (ISmartNavigationTarget) Deregisters a SmartNavigationTarget from the SmartNavigationSource.
+ 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.
+ 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.
+ System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents () Returns a List of all Components in the Form
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
- InitializeComponent () Initializes the Visual Design
# OnLoad (EventArgs) Raises the Load event
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# ParentFormDestroyedHandler (Object, EventArgs) Event handler for the FormDestroyed event of the owning Form
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ RegisterSmartNavigationTarget (ISmartNavigationTarget) Registers a SmartNavigationTarget with the SmartNavigationSource.
+ SubscribeParentFormDestroyed () Subscribes the ParentFormDestroyed event
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# SubscribeUserControlEvents () Allows for custom event subscriptions during OnLoad()
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# 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

Top Constructor Summary
Options Name Purpose
+ SmartNavigationPanel () Constructor for the SmartToolbarController class

Top Property Summary
Options Name Purpose
# CHARACTER DesignerVerbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ LOGICAL DesignTime
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# CHARACTER HiddenProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# LOGICAL ParentFormDestroyedSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# LOGICAL UserControlEventsSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl


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

PRIVATE BtnFirst_Click (Object, EventArgs)
Purpose: Event handler for the Click event of BtnFirst
Notes:

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

PRIVATE BtnLast_Click (Object, EventArgs)
Purpose: Event handler for the Click event of BtnLast
Notes:

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

PRIVATE BtnNext_Click (Object, EventArgs)
Purpose: Event handler for the Click event of BtnNext
Notes:

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

PRIVATE BtnPrev_Click (Object, EventArgs)
Purpose: Event handler for the Click event of BtnPrev
Notes:

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

PROTECTED CreateVerbs ()
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Creates Designer Verbs based on the DesignerVerbs property
Notes:

Top

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

Parameters:
poSmartNavigationTarget Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget
The ISmartNavigationTarget to deregister
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

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 System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents ()
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Returns a List of all Components in the Form
Notes: Supported on OpenEdge 11 only, due to dependency to the ComponentsCollection
list not available on 10.2B

Returns System.Collections.Generic.List <System.ComponentModel.Component>
The List of Components in the Form
Top

PRIVATE InitializeComponent ()
Purpose: Initializes the Visual Design
Notes:

Top

PROTECTED OnLoad (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Raises the Load event
Notes: Subscribes the FormDestroyed event from the ParentForm

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

PUBLIC OnVerbClicked (character)
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Event Handler method for Designer Verbs
Notes: This method is intended to be overridden

Parameters:
pcDesignerVerb CHARACTER
The name (Label) of the Designer Verb that was invoked
Top

PROTECTED ParentFormDestroyedHandler (Object, EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Event handler for the FormDestroyed event of the owning Form
Notes:

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

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 SubscribeParentFormDestroyed ()
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Subscribes the ParentFormDestroyed event
Notes:

Top

PROTECTED SubscribeUserControlEvents ()
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Allows for custom event subscriptions during OnLoad()
Notes: Intended to be overridden in the inheriting user control

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


Constructor Detail
Top

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



Property Detail
Top

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

Returns CHARACTER
Top

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

Returns LOGICAL
Top

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

Returns CHARACTER
Top

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

Returns CHARACTER
Top

PROTECTED LOGICAL ParentFormDestroyedSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL
Top

PROTECTED LOGICAL UserControlEventsSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 13:02:14