Namespace: Consultingwerk.Windows.Util.Forms
Class 
FolderBrowserForm Copy to Clipboard
Parent classes:
Progress.Windows.Form
Consultingwerk.Forms.BaseForm
Consultingwerk.Windows.Util.Forms.FolderBrowserForm

Inherits: Consultingwerk.Forms.BaseForm
Implements: Consultingwerk.Forms.IBaseForm, ICustomTypeDescriptor, IHasDesignerVerbs

File:FolderBrowserForm
Purpose:Allows selection of a folder under a given (custom)
root folder
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Thu May 15 14:08:19 CEST 2014

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



Top Method Summary
Options Name Purpose
- button3_Click (Object, EventArgs) Event handler for the Click event of the button3
+ LOGICAL CanFindInComponentsCollection (Object) Returns if the component can be found in the ComponentsCollection
Inherited from Consultingwerk.Forms.BaseForm
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
Inherited from Consultingwerk.Forms.BaseForm
# CustomizeToolbar () Customizes the UltraToolbarController associated with this BaseForm
Inherited from Consultingwerk.Forms.BaseForm
# DesignerInsertUserControl () Inserts a user control instance at design time.
Inherited from Consultingwerk.Forms.BaseForm
+ System.Collections.Generic.List <System.Windows.Forms.Control> FindAllControlsOfType (Type) Returns a List of all Controls in the Form that are of the given type
Inherited from Consultingwerk.Forms.BaseForm
+ System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents () Returns a List of all Components in the Form
Inherited from Consultingwerk.Forms.BaseForm
+ AttributeCollection GetAttributes () Returns a collection of custom attributes for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ CHARACTER GetClassName () Returns the class name of this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ CHARACTER GetComponentName () Returns the name of this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ TypeConverter GetConverter () Returns a type converter for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ EventDescriptor GetDefaultEvent () Returns the default event for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ PropertyDescriptor GetDefaultProperty () Returns the default property for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ System.Object GetEditor (Type) Returns an editor of the specified type for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ EventDescriptorCollection GetEvents () Returns the events for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ EventDescriptorCollection GetEvents (Attribute[]) Returns the events for this instance of a component using the specified attribute array as a filter.
Inherited from Consultingwerk.Forms.BaseForm
+ PropertyDescriptorCollection GetProperties () Returns the properties for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ PropertyDescriptorCollection GetProperties (Attribute[]) Returns the properties for this instance of a component using the attribute array as a filter.
Inherited from Consultingwerk.Forms.BaseForm
+ System.Object GetPropertyOwner (PropertyDescriptor) Returns an object that contains the property described by the specified property descriptor.
Inherited from Consultingwerk.Forms.BaseForm
- InitializeComponent () Initializes the Visual Design
# InsertRootNode () Inserts the Root Node
# LoadRibbonQuickAccessToolbar () Restores the Quick Access Toolbar items from the Registry
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER LoadSettings () Loads the stored window settings (position etc.) from the registry
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER LoadSettings (character) Loads stored window settings from the registry
Inherited from Consultingwerk.Forms.BaseForm
# OnFormClosed (FormClosedEventArgs) Raises the FormClosed event
Inherited from Consultingwerk.Forms.BaseForm
# OnFormClosing (FormClosingEventArgs) Raises the FormClosing event
Inherited from Consultingwerk.Forms.BaseForm
# OnFormDestroyed (EventArgs) Raises the FormDestroyed event
Inherited from Consultingwerk.Forms.BaseForm
# OnLoad (EventArgs) Raises the Load event
Inherited from Consultingwerk.Forms.BaseForm
# OnShown (EventArgs) Raises the Shown event
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.Forms.BaseForm
# PerformSearch () Performs the search based on the search text
# RemoveSetting (character) Removes a stored setting
Inherited from Consultingwerk.Forms.BaseForm
# RestoreUltraSplitterPosition () Restores the position of the Ultra Splitter Controls
Inherited from Consultingwerk.Forms.BaseForm
# RestoreWindowPosition () Restores the stored window position
Inherited from Consultingwerk.Forms.BaseForm
# StoreRibbonQuickAccessToolbar () Stores the current Quick Access Toolbar items in the Registry
Inherited from Consultingwerk.Forms.BaseForm
# StoreSettings (character) Stores the current window settings (position etc.) to the registry
Inherited from Consultingwerk.Forms.BaseForm
# StoreSettings (character, character) Stores window settings to the registry
Inherited from Consultingwerk.Forms.BaseForm
# StoreUltraSplitterPosition () Stores the position of the UltraSplitter Controls in the Registry
Inherited from Consultingwerk.Forms.BaseForm
# StoreWindowPosition () Stores the window position to the resgistry
Inherited from Consultingwerk.Forms.BaseForm
- timer1_Tick (Object, EventArgs) Event handler for the Tick event of the timer1
- ultraTextEditor1_KeyDown (Object, KeyEventArgs) Event handler for the KeyDown event of the ultraTextEditor1
- ultraTextEditor1_TextChanged (Object, EventArgs) Event handler for the TextChanged of the ultraTextEditor1
- ultraTree1_AfterSelect (Object, SelectEventArgs) Event handler for the AfterSelect event of the ultraTree1
- ultraTree1_BeforeExpand (Object, CancelableNodeEventArgs) Event handler for the BeforeExport event of the ultraTree1
- ultraTree1_MouseDoubleClick (Object, MouseEventArgs) Event handler for the MouseDoubleClick event of the ultraTree1
# ViewHideAllNodes (logical) Views or hides all tree nodes

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

Top Event Summary
Options Name Purpose
+ FormDestroyed DELEGATE System.EventHandler Raised when a Form is destroyed (in the Destructor)
Inherited from Consultingwerk.Forms.BaseForm

Top Property Summary
Options Name Purpose
# CHARACTER BindableProperties
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER CategorizedProperties
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER CategoryProperties
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL DeleteOnFormClosed
Inherited from Consultingwerk.Forms.BaseForm
+ System.Collections.Generic.List <Progress.Windows.Form> DependentForms
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DescribedProperties
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DescriptionProperties
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DesignerVerbs
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DesignerVisibilityAttributes
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DesignerVisibilityProperties
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL DesignTime
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER HiddenProperties
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL IsClosed
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.Forms.BaseForm
+ System.Windows.Forms.FormWindowState PreviousWindowState
Inherited from Consultingwerk.Forms.BaseForm
+ CHARACTER RootFolder
+ CHARACTER SelectedFolder
# LOGICAL StoreFormPosition
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL UseStartupSizeAsMinSize
Inherited from Consultingwerk.Forms.BaseForm
+ CHARACTER WindowPositionRegistryKey
Inherited from Consultingwerk.Forms.BaseForm


Method Detail
Top

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

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

PUBLIC LOGICAL CanFindInComponentsCollection (Object)
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns if the component can be found in the ComponentsCollection
Notes: Available from OpenEdge 11.1 on

Parameters:
poComponent System.Object
The component to locate
Returns LOGICAL
Logical value indicating if the component can be found in the ComponentsCollection
Top

PROTECTED CreateVerbs ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Creates Designer Verbs based on the DesignerVerbs property
Notes:

Top

PROTECTED CustomizeToolbar ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Customizes the UltraToolbarController associated with this BaseForm
Notes: Uses the IFormToolbarCustomizer Service if present

Top

PROTECTED DesignerInsertUserControl ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Inserts a user control instance at design time.
Notes:

Top

PUBLIC System.Collections.Generic.List <System.Windows.Forms.Control> FindAllControlsOfType (Type)
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns a List of all Controls in the Form that are of the given type
Notes:

Parameters:
poType System.Type
The reference to the System.Type
Returns System.Collections.Generic.List <System.Windows.Forms.Control>
The List of all Controls of the given type
Top

PUBLIC System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents ()
Inherited from Consultingwerk.Forms.BaseForm
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

PUBLIC AttributeCollection GetAttributes ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns a collection of custom attributes for this instance of a
component.
Notes:

Returns AttributeCollection
The System.ComponentModel.AttributeCollection describing the types attributes
Top

PUBLIC CHARACTER GetClassName ()
Inherited from Consultingwerk.Forms.BaseForm
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.Forms.BaseForm
Purpose: Returns the name of this instance of a component.
Notes:

Returns CHARACTER
The Component Name of this instance
Top

PUBLIC TypeConverter GetConverter ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns a type converter for this instance of a component.
Notes:

Returns TypeConverter
The System.ComponentModel.TypeConverter for this instance of a component.
Top

PUBLIC EventDescriptor GetDefaultEvent ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the default event for this instance of a component.
Notes:

Returns EventDescriptor
The System.ComponentModel.EventDescriptor for the default event of this component
Top

PUBLIC PropertyDescriptor GetDefaultProperty ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the default property for this instance of a component.
Notes:

Returns PropertyDescriptor
The System.ComponentModel.PropertyDescriptor for the default property of the component
Top

PUBLIC System.Object GetEditor (Type)
Inherited from Consultingwerk.Forms.BaseForm
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 EventDescriptorCollection GetEvents ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the events for this instance of a component.
Notes:

Returns EventDescriptorCollection
The System.ComponentModel.EventDescriptorCollection describing the events of the component
Top

PUBLIC EventDescriptorCollection GetEvents (Attribute[])
Inherited from Consultingwerk.Forms.BaseForm
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 EventDescriptorCollection
The System.ComponentModel.EventDescriptorCollection describing the events of the component
Top

PUBLIC PropertyDescriptorCollection GetProperties ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the properties for this instance of a component.
Notes:

Returns PropertyDescriptorCollection
A System.ComponentModel.PropertyDescriptorCollection that represents the properties for this component instance.
Top

PUBLIC PropertyDescriptorCollection GetProperties (Attribute[])
Inherited from Consultingwerk.Forms.BaseForm
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 PropertyDescriptorCollection
A System.ComponentModel.PropertyDescriptorCollection that represents the properties for this component instance.
Top

PUBLIC System.Object GetPropertyOwner (PropertyDescriptor)
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns an object that contains the property described by the
specified property descriptor.
Notes:

Parameters:
pd 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

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

Top

PROTECTED InsertRootNode ()
Purpose: Inserts the Root Node
Notes:

Top

PROTECTED LoadRibbonQuickAccessToolbar ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Restores the Quick Access Toolbar items from the Registry
Notes:

Top

PROTECTED CHARACTER LoadSettings ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Loads the stored window settings (position etc.) from the registry
Notes:

Returns CHARACTER
The string containing the stored window settings
Top

PROTECTED CHARACTER LoadSettings (character)
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Loads stored window settings from the registry
Notes:

Parameters:
pcSettingsKey CHARACTER
The key under which the settings for this Form are stored (e.g. Position)
Returns CHARACTER
The string containing the stored window settings
Top

PROTECTED OnFormClosed (FormClosedEventArgs)
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Raises the FormClosed event
Notes: Deletes the Form Instance when it has been closed.
See Progress K-Base Entry ID: P179041
Title: "User Controls that have events attached to them cause
parent forms to not get garbage collected"
Dialog Forms will not get deleted. Typically Dialog Forms will need
to return values to the calling Program using properties. This
requires that the dialog form is valid after the WAIT-FOR
ShowDialog statement.
(Dialog Forms are detected using the Modal property)

Parameters:
e System.Windows.Forms.FormClosedEventArgs
A FormClosedEventArgs that contains the event data.
Top

PROTECTED OnFormClosing (FormClosingEventArgs)
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Raises the FormClosing event
Notes: Invoked when the Form is about to be closed

Parameters:
e System.Windows.Forms.FormClosingEventArgs
A FormClosingEventArgs that contains the event data.
Top

PROTECTED OnFormDestroyed (EventArgs)
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Raises the FormDestroyed event
Notes:

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

PROTECTED OnLoad (EventArgs)
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Raises the Load event
Notes: Invoked when a Form is displayed for the first time

Parameters:
e System.EventArgs
An EventArgs that contains the event data.
Top

PROTECTED OnShown (EventArgs)
Purpose: Raises the Shown event
Notes:

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

PUBLIC OnVerbClicked (character)
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Event Handler method for Designer Verbs
Notes:

Parameters:
pcVerbText CHARACTER
The label of the verb the developer clicked on in the Visual Designer
Top

PROTECTED PerformSearch ()
Purpose: Performs the search based on the search text
Notes:

Top

PROTECTED RemoveSetting (character)
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Removes a stored setting
Notes:

Parameters:
pcSettingsKey CHARACTER
The settings key to remove
Top

PROTECTED RestoreUltraSplitterPosition ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Restores the position of the Ultra Splitter Controls
Notes:

Top

PROTECTED RestoreWindowPosition ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Restores the stored window position
Notes:

Top

PROTECTED StoreRibbonQuickAccessToolbar ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Stores the current Quick Access Toolbar items in the Registry
Notes:

Top

PROTECTED StoreSettings (character)
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Stores the current window settings (position etc.) to the registry
Notes:

Parameters:
pcSettings CHARACTER
The string containing the window settings to be stored
Top

PROTECTED StoreSettings (character, character)
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Stores window settings to the registry
Notes:

Parameters:
pcSettings CHARACTER
The string containing the window settings to be stored
pcSettingsKey CHARACTER
The key under which the settings for this Form are stored (e.g. Position)
Top

PROTECTED StoreUltraSplitterPosition ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Stores the position of the UltraSplitter Controls in the Registry
Notes:

Top

PROTECTED StoreWindowPosition ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Stores the window position to the resgistry
Notes:

Top

PRIVATE timer1_Tick (Object, EventArgs)
Purpose: Event handler for the Tick event of the timer1
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 ultraTextEditor1_KeyDown (Object, KeyEventArgs)
Purpose: Event handler for the KeyDown event of the ultraTextEditor1
Notes:

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

PRIVATE ultraTextEditor1_TextChanged (Object, EventArgs)
Purpose: Event handler for the TextChanged of the ultraTextEditor1
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 ultraTree1_AfterSelect (Object, SelectEventArgs)
Purpose: Event handler for the AfterSelect event of the ultraTree1
Notes:

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

PRIVATE ultraTree1_BeforeExpand (Object, CancelableNodeEventArgs)
Purpose: Event handler for the BeforeExport event of the ultraTree1
Notes: Creates sub-nodes if required

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

PRIVATE ultraTree1_MouseDoubleClick (Object, MouseEventArgs)
Purpose: Event handler for the MouseDoubleClick event of the ultraTree1
Notes:

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

PROTECTED ViewHideAllNodes (logical)
Purpose: Views or hides all tree nodes
Notes:

Parameters:
plView LOGICAL
Logical value indicating if the nodes should be shown


Constructor Detail
Top

PUBLIC FolderBrowserForm ()
Purpose: Constructor for the FolderBrowserForm class
Notes:



Event Detail
Top

PUBLIC FormDestroyed DELEGATE System.EventHandler
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Raised when a Form is destroyed (in the Destructor)
Notes:

Delegate: System.EventHandler


Property Detail
Top

PROTECTED CHARACTER BindableProperties
Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PROTECTED CHARACTER CategorizedProperties
Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PROTECTED CHARACTER CategoryProperties
Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PUBLIC LOGICAL DeleteOnFormClosed
Inherited from Consultingwerk.Forms.BaseForm

Returns LOGICAL
Top

PUBLIC System.Collections.Generic.List <Progress.Windows.Form> DependentForms
Inherited from Consultingwerk.Forms.BaseForm

Returns System.Collections.Generic.List <Progress.Windows.Form>
Top

PROTECTED CHARACTER DescribedProperties
Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PROTECTED CHARACTER DescriptionProperties
Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVerbs
Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityAttributes
Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityProperties
Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PUBLIC LOGICAL DesignTime
Inherited from Consultingwerk.Forms.BaseForm

Returns LOGICAL
Top

PROTECTED CHARACTER HiddenProperties
Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PUBLIC LOGICAL IsClosed
Inherited from Consultingwerk.Forms.BaseForm

Returns LOGICAL
Top

PROTECTED CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PUBLIC System.Windows.Forms.FormWindowState PreviousWindowState
Inherited from Consultingwerk.Forms.BaseForm

Returns System.Windows.Forms.FormWindowState
Top

PUBLIC CHARACTER RootFolder

Returns CHARACTER
Top

PUBLIC CHARACTER SelectedFolder

Returns CHARACTER
Top

PROTECTED LOGICAL StoreFormPosition
Inherited from Consultingwerk.Forms.BaseForm

Returns LOGICAL
Top

PUBLIC LOGICAL UseStartupSizeAsMinSize
Inherited from Consultingwerk.Forms.BaseForm

Returns LOGICAL
Top

PUBLIC CHARACTER WindowPositionRegistryKey
Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER


©2006-2019 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.08.2019 00:09:38