Namespace: Consultingwerk.Forms.Telerik
Class 
BaseRadRibbonForm Copy to Clipboard
Parent classes:
Telerik.WinControls.UI.RadRibbonForm
Consultingwerk.Forms.Telerik.BaseRadRibbonForm

Inherits: Telerik.WinControls.UI.RadRibbonForm
Implements: Consultingwerk.Forms.IBaseForm
Inherited by: Consultingwerk.SmartComponents.Base.SmartRadRibbonWindowForm

File:BaseRadRibbonForm
Purpose:Base Form extending the Telerik RadRibbonForm
Description:Extended base form based on the Telerik RadRibbonForm supporting
Telerik Styling
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Thu Mar 19 17:10:12 CET 2015
Notes:Currently not yet inheriting from Progress.Windows.Form
as Telerik Styling requires to inherit from their Forms.
It is expected that Progress will provide specific base
form classes combining the Telerik behavior and the
Progress.Windows.Form ABL window interop
https://community.progress.com/community_groups/openedge_development/f/19/p/16706/59825.aspx?Redirected=true#59825
/* &IF DEFINED (SmartComponentLibrary) NE 0 &THEN

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



Top Method Summary
Options Name Purpose
+ LOGICAL CanFindInComponentsCollection (Object) Returns if the component can be found in the ComponentsCollection
# DesignerInsertUserControl () Inserts a user control instance at design time.
+ 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
+ System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents () Returns a List of all Components in the Form
# LoadRibbonQuickAccessToolbar () Restores the Quick Access Toolbar items from the Registry
# CHARACTER LoadSettings () Loads the stored window settings (position etc.) from the registry
# CHARACTER LoadSettings (character) Loads stored window settings from the registry
# OnFormClosed (FormClosedEventArgs) Raises the FormClosed event
# OnFormClosing (FormClosingEventArgs) Raises the FormClosing event
# OnFormDestroyed (EventArgs) Raises the FormDestroyed event
# OnLoad (EventArgs) Raises the Load event
+ OnVerbClicked (character) Event Handler method for Designer Verbs
# RestoreRadSplitterPosition () Restores the position of the Rad Splitter Controls
# RestoreWindowPosition () Restores the stored window position
# StoreRadSplitterPosition () Stores the position of the RadSplitter Controls in the Registry
# StoreRibbonQuickAccessToolbar () Stores the current Quick Access Toolbar items in the Registry
# StoreSettings (character) Stores the current window settings (position etc.) to the registry
# StoreSettings (character, character) Stores window settings to the registry
# StoreWindowPosition () Stores the window position to the resgistry

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

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

Top Property Summary
Options Name Purpose
+ LOGICAL DeleteOnFormClosed
+ System.Collections.Generic.List <Progress.Windows.Form> DependentForms
# CHARACTER DesignerVerbs
+ LOGICAL DesignTime
+ LOGICAL IsClosed
# LOGICAL StoreFormPosition
+ LOGICAL UseStartupSizeAsMinSize
+ CHARACTER WindowPositionRegistryKey


Method Detail
Top

PUBLIC LOGICAL CanFindInComponentsCollection (Object)
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 DesignerInsertUserControl ()
Purpose: Inserts a user control instance at design time.
Notes:

Top

PUBLIC System.Collections.Generic.List <System.Windows.Forms.Control> FindAllControlsOfType (Type)
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 ()
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

PROTECTED LoadRibbonQuickAccessToolbar ()
Purpose: Restores the Quick Access Toolbar items from the Registry
Notes:

Top

PROTECTED CHARACTER LoadSettings ()
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)
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)
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)
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)
Purpose: Raises the FormDestroyed event
Notes:

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

PROTECTED OnLoad (EventArgs)
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

PUBLIC OnVerbClicked (character)
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 RestoreRadSplitterPosition ()
Purpose: Restores the position of the Rad Splitter Controls
Notes:

Top

PROTECTED RestoreWindowPosition ()
Purpose: Restores the stored window position
Notes:

Top

PROTECTED StoreRadSplitterPosition ()
Purpose: Stores the position of the RadSplitter Controls in the Registry
Notes:

Top

PROTECTED StoreRibbonQuickAccessToolbar ()
Purpose: Stores the current Quick Access Toolbar items in the Registry
Notes:

Top

PROTECTED StoreSettings (character)
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)
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 StoreWindowPosition ()
Purpose: Stores the window position to the resgistry
Notes:



Constructor Detail
Top

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



Event Detail
Top

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

Delegate: System.EventHandler


Property Detail
Top

PUBLIC LOGICAL DeleteOnFormClosed

Returns LOGICAL
Top

PUBLIC System.Collections.Generic.List <Progress.Windows.Form> DependentForms

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

PROTECTED CHARACTER DesignerVerbs

Returns CHARACTER
Top

PUBLIC LOGICAL DesignTime

Returns LOGICAL
Top

PUBLIC LOGICAL IsClosed

Returns LOGICAL
Top

PROTECTED LOGICAL StoreFormPosition

Returns LOGICAL
Top

PUBLIC LOGICAL UseStartupSizeAsMinSize

Returns LOGICAL
Top

PUBLIC CHARACTER WindowPositionRegistryKey

Returns CHARACTER


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 12:58:43