Namespace: Consultingwerk.Windows.Framework.System
Class 
SmartAttachmentControl Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.SmartComponents.Base.SmartUserControl
Implements: IHasDesignerVerbs

File:SmartAttachmentControl
Purpose:Allows access to attachments (add, delete, open, export)
based on the SmartAttachment table
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Jan 13 19:05:04 CET 2013
Notes:Customers using the SmartAttachmentControl should add
a call to the CleanTempFiles methods of the ITempFileManager
service after the main WAIT-FOR statement. Attachments
directly opened will be saved in the temp directory
(-T parameter) and will be deleted be the call to the
CleanUp method



Top Method Summary
Options Name Purpose
# AddAttachment () Adds Attachments using a File Open Dialog
# AfterRetrieveDataHandler (Object, EventArgs) Event handler for the AfterRetrieveData event of the Attachment's Business Entity Adapter
# BuildRibbonTab (UltraToolbarsManager) Builds a contextual RibbonTab for the SmartAttachmentControl
# Infragistics.Win.UltraWinToolbars.ButtonTool CreateRibbonButton (UltraToolbarsManager, RibbonGroup, character, character, character, character) Creates a Ribbon Button (ButtonTool)
# Infragistics.Win.UltraWinToolbars.StateButtonTool CreateRibbonStateButton (UltraToolbarsManager, RibbonGroup, character, character, character) Creates a Ribbon State Button (StateButtonTool)
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# DeleteAttachment () Deletes the selected attachment
# ExportAttachment () Exports the selected attachments to a local folder
+ 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
# LeaveHandler (Object, EventArgs) Event handler for the Leave event of the SmartAttachmentControl
# OnEnter (EventArgs) Raises the Enter event
# OnLoad (EventArgs) Raises the Load event
Overrides Consultingwerk.SmartComponents.Base.SmartUserControl:OnLoad (EventArgs)
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# OpenAttachment () Opens the selected Attachments
# ParentFormClosedHandler (Object, FormClosedEventArgs) Event handler for the FormClosed event of the parent Form
# ParentFormDestroyedHandler (Object, EventArgs) Event handler for the FormDestroyed event of the owning Form
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
- QueryClosedHandler (Object, EventArgs) Event handler for the QueryClosed event of the smartBusinessEntityAdapter1 instance
+ 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
- timer1_Tick (Object, EventArgs) Event handler for the Tick event of the timer1 component
# ToggleToolbarObjectsVisible (logical) Toggles the Visibility of the toolbar objects of this Control
+ ToggleView (character) Sets the View of the ListView
- ToolClickHandler (Object, ToolClickEventArgs) Event handler for the ToolClick event of the UltraToolbarsManager
- ultraListView1_DragDrop (Object, DragEventArgs) Event handler for the DragDrop event of the ListView control
- ultraListView1_DragEnter (Object, DragEventArgs) Event handler for the DragEnter event of the ListView control
- ultraListView1_ItemSelectionChanged (Object, ItemSelectionChangedEventArgs) Event handler for the ItemSelectionChanged event of the UltraListView1
- ultraListView1_MouseDown (Object, MouseEventArgs) Event handler for the MouseDown even of the ultraListView1
- ultraListView1_MouseMove (Object, MouseEventArgs) Event handler for the MouseMove event of the ultarListView1 control
- ultraListView1_MouseUp (Object, MouseEventArgs) Event handler for the MouseUp event of the ultarListView1 control

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

Top Property Summary
Options Name Purpose
+ LOGICAL CanAddAttachments
+ Infragistics.Win.UltraWinToolbars.ContextualTabGroup ContextualRibbonTabGroup
# CHARACTER DesignerVerbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ LOGICAL DesignTime
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# CHARACTER HiddenProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource LinkDataSource
# CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# LOGICAL ParentFormDestroyedSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource
# LOGICAL UserControlEventsSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl


Method Detail
Top

PROTECTED AddAttachment ()

Purpose: Adds Attachments using a File Open Dialog
Notes: Supports adding multiple files

Top

PROTECTED AfterRetrieveDataHandler (Object, EventArgs)

Purpose: Event handler for the AfterRetrieveData event of the Attachment's
Business Entity Adapter
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 BuildRibbonTab (UltraToolbarsManager)

Purpose: Builds a contextual RibbonTab for the SmartAttachmentControl
Notes:

Parameters:
poToolbar Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
The UltraToolbarsManager instance to add the Ribobn Tab to
Top

PROTECTED Infragistics.Win.UltraWinToolbars.ButtonTool CreateRibbonButton (UltraToolbarsManager, RibbonGroup, character, character, character, character)

Purpose: Creates a Ribbon Button (ButtonTool)
Notes:

Parameters:
poToolbar Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
The UltraToolbarsManager instance to add the Ribobn Tab to
poRibbonGroup Infragistics.Win.UltraWinToolbars.RibbonGroup
The RibbonGroup to add the new Ribbon Button to
pcKey CHARACTER
The key of the new Ribbon Button
pcLabel CHARACTER
The label of the new Ribbon Button
pcImageSmall CHARACTER
The key of the small image to be retrieved from the IImageProvider instance
pcImageLarge CHARACTER
The key of the large image to be retrieved from the IImageProvider instance
Returns Infragistics.Win.UltraWinToolbars.ButtonTool
The reference to the created ButtonTool
Top

PROTECTED Infragistics.Win.UltraWinToolbars.StateButtonTool CreateRibbonStateButton (UltraToolbarsManager, RibbonGroup, character, character, character)

Purpose: Creates a Ribbon State Button (StateButtonTool)
Notes:

Parameters:
poToolbar Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
The UltraToolbarsManager instance to add the Ribobn Tab to
poRibbonGroup Infragistics.Win.UltraWinToolbars.RibbonGroup
The RibbonGroup to add the new Ribbon Button to
pcKey CHARACTER
The key of the new Ribbon Button
pcLabel CHARACTER
The label of the new Ribbon Button
pcOptionSetKey CHARACTER
The key of the option set this belongs to
Returns Infragistics.Win.UltraWinToolbars.StateButtonTool
The reference to the created StateButtonTool
Top

PROTECTED CreateVerbs ()

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

Top

PROTECTED DeleteAttachment ()

Purpose: Deletes the selected attachment
Notes:

Top

PROTECTED ExportAttachment ()

Purpose: Exports the selected attachments to a local folder
Notes:

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 LeaveHandler (Object, EventArgs)

Purpose: Event handler for the Leave event of the SmartAttachmentControl
Notes:

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

PROTECTED OnEnter (EventArgs)

Purpose: Raises the Enter event
Notes:

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

PROTECTED OnLoad (EventArgs)

Overrides Consultingwerk.SmartComponents.Base.SmartUserControl:OnLoad (EventArgs)
Purpose: Raises the Load event
Notes:

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 OpenAttachment ()

Purpose: Opens the selected Attachments
Notes:

Top

PROTECTED ParentFormClosedHandler (Object, FormClosedEventArgs)

Purpose: Event handler for the FormClosed event of the parent Form
Notes:

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

PRIVATE QueryClosedHandler (Object, EventArgs)

Purpose: Event handler for the QueryClosed event of the smartBusinessEntityAdapter1
instance
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 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

PRIVATE timer1_Tick (Object, EventArgs)

Purpose: Event handler for the Tick event of the timer1 component
Notes: Starts the Drag and drop operation

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

PROTECTED ToggleToolbarObjectsVisible (logical)

Purpose: Toggles the Visibility of the toolbar objects of this Control
Notes:

Parameters:
plVisible LOGICAL
Logical value indicating if the Toolbar objects (RibbonTab) should be visible
Top

PUBLIC ToggleView (character)

Purpose: Sets the View of the ListView
Notes:

Parameters:
pcView CHARACTER
The View: Icon, List, Tiles
Top

PRIVATE ToolClickHandler (Object, ToolClickEventArgs)

Purpose: Event handler for the ToolClick event of the UltraToolbarsManager
Notes:

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

PRIVATE ultraListView1_DragDrop (Object, DragEventArgs)

Purpose: Event handler for the DragDrop event of the ListView control
Notes:

Parameters:
sender System.Object
The reference to the sending Control
e System.Windows.Forms.DragEventArgs
The DragEventArgs with the data for this event
Top

PRIVATE ultraListView1_DragEnter (Object, DragEventArgs)

Purpose: Event handler for the DragEnter event of the ListView control
Notes:

Parameters:
sender System.Object
The reference to the sending Control
e System.Windows.Forms.DragEventArgs
The DragEventArgs with the data for this event
Top

PRIVATE ultraListView1_ItemSelectionChanged (Object, ItemSelectionChangedEventArgs)

Purpose: Event handler for the ItemSelectionChanged event of the UltraListView1
Notes:

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

PRIVATE ultraListView1_MouseDown (Object, MouseEventArgs)

Purpose: Event handler for the MouseDown even of the ultraListView1
Notes:

Parameters:
sender System.Object
The object that raised the MouseDown event
e System.Windows.Forms.MouseEventArgs
The System.Windows.Forms.MouseEventArgs with the data for this event
Top

PRIVATE ultraListView1_MouseMove (Object, MouseEventArgs)

Purpose: Event handler for the MouseMove event of the ultarListView1 control
Notes: Cancels a pending drag and drop operation

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

PRIVATE ultraListView1_MouseUp (Object, MouseEventArgs)

Purpose: Event handler for the MouseUp event of the ultarListView1 control
Notes: Cancels a pending drag and drop operation

Parameters:
sender System.Object
The reference to the object that raised the event
e System.Windows.Forms.MouseEventArgs
The reference to the MouseEventArgs instance with the data for this event


Constructor Detail
Top

PUBLIC SmartAttachmentControl ()

Purpose: Constructor for the SmartAttachmentControl class
Notes:



Property Detail
Top

PUBLIC LOGICAL CanAddAttachments


Returns LOGICAL
Top

PUBLIC Infragistics.Win.UltraWinToolbars.ContextualTabGroup ContextualRibbonTabGroup


Returns Infragistics.Win.UltraWinToolbars.ContextualTabGroup
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

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource LinkDataSource


Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource
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

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource


Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
Top

PROTECTED LOGICAL UserControlEventsSubscribed

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       14.08.2022 21:56:05