Namespace: Consultingwerk.Studio.ProcedureEditor
Class 
ProcedureEditorForm Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
Implements: IBaseForm, ICustomTypeDescriptor, Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm, IHasDesignerVerbs, IHasSecurityKey

File:ProcedureEditorForm
Purpose:Uses the WinKit to embed the ADE Procedure Editor into
a .NET Form
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Fri Dec 18 22:28:25 CET 2009
Notes:This class is only accessible on Windows



Top Method Summary
Options Name Purpose
+ LOGICAL CanFindInComponentsCollection (Object) Returns if the component can be found in the ComponentsCollection
Inherited from Consultingwerk.Forms.BaseForm
+ CheckSyntax () Checks the Syntax of the current source code
+ CloseEmbeddedWindows (logical) Requests closing of the embedded window
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ CloseFromCode () Closes the Form after unsubscribing it's own FormClosing event handle
# 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
+ EmbedWindow (handle) Creates a new instance of the Progress.Windows.WindowContainer instance and embeds the given window widget in that instance - but does not parent the WindowContainer instance in the Form (THIS-OBJECT). This is delayed till later.
+ EnableDisableOverlayControls () Toggles Sensitivity of OverlayControls based on the sensitive status of the corresponding Widget/Frame
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ FinalizeEmbedding () Finalize the embedding of an ABL window widget by parenting the Progress.Windows.WindowContainer instance in the Form (THIS-OBJECT). Sets the Form Text property and applies the window-resized event to the window widget.
+ 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
+ Progress.Windows.Form FindDependentFormOfClass (Class) Returns the dependent form instance of the given class
Inherited from Consultingwerk.Forms.BaseForm
+ FormClosingHandler (Object, FormClosingEventArgs) Event Handler for the FormClosing event of the Form. When a window is embedded, the FormClosing event will be cancelled and the WINDOW-CLOSE event to the window will be applied.
+ 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
+ HANDLE GetEmbeddedWindows () Returns an indeterminate array of the HANDLEs of the embedded Windows
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ 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
+ InsertText (character, integer) Inserts text in the Procedure Editor at the given line
# 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
# LONGCHAR LoadSettingsLong (character) Loads stored window settings from the registry
Inherited from Consultingwerk.Forms.BaseForm
+ MoveCursor (integer) Moves editor cursor to a specified line number, column 1.
# OnActivated (EventArgs) Raises the Activated event
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
# OnDeactivate (EventArgs) Raises the Deactivate event
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
# OnFormClosed (FormClosedEventArgs) Raises the FormClosed event
Overrides Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm:OnFormClosed (FormClosedEventArgs)
# 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
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.Forms.BaseForm
+ RefreshButtons () Refreshes the state of all overlay buttons in the IEmbeddedWindowForm
# 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
+ CHARACTER Save () Saves the Editor contents
+ CHARACTER SaveToTemporaryFile () Saves the Editor contents to a temporary file
# 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
# StoreSettingsLong (longchar, 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 registry
Inherited from Consultingwerk.Forms.BaseForm
# SuspendSTAThreadWarning (UltraDockManager) Suspends STAThread warnings for an UltraDockManager instance
Inherited from Consultingwerk.Forms.BaseForm
- ultraToolbarsManager1_ToolClick (Object, ToolClickEventArgs) Event handler for the ToolClick event of the ultraToolbarsManager1
# UpdateControlsForEventHandler () Brings Controls/Widget's in sync for handling .NET Events
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ UpdateWindowAttributes () Update Form properties with Properties from the WindowWidget
+ ViewHideOverlayControls () Toggles Visibily of OverlayControls based on the view/hide status of the corresponding Widget/Frame
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ Progress.Windows.WindowContainer WindowContainerOfWidget (handle) Returns the WindowContainer that contains the widget
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm

Top Constructor Summary
Options Name Purpose
+ ProcedureEditorForm () Constructor for the ProcedureEditorForm 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
+ System.Windows.Forms.Control ClientArea
+ 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
+ WIDGET-HANDLE EmbeddedWindow
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ LOGICAL Finalized
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ LOGICAL FocusEmbeddedWindowOnActivated
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ CHARACTER FrameHandles
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
# CHARACTER HiddenProperties
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL IsClosed
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL IsModified
+ LOGICAL IsReadOnly
+ LOGICAL MakeMdiChild
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ WIDGET-HANDLE MENU-BAR
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ LOGICAL MenuBarAsToolbar
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ LOGICAL MenuItemsAsToolbar
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ DECIMAL MinHeightChars
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ DECIMAL MinWidthChars
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
# CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.Forms.BaseForm
+ CHARACTER OriginalWindowTitle
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ System.Collections.Generic.Dictionary <System.Windows.Forms.Control> OverlayControls
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ HANDLE PreviousFocus
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ System.Windows.Forms.FormWindowState PreviousWindowState
Inherited from Consultingwerk.Forms.BaseForm
+ HANDLE ProcedureHandle
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ CHARACTER SecurityKey
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL ShowAsDialog
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
# LOGICAL StoreFormPosition
Inherited from Consultingwerk.Forms.BaseForm
+ UltraToolbarsManager ToolbarsManager
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ LOGICAL UseStartupSizeAsMinSize
Inherited from Consultingwerk.Forms.BaseForm
+ INTEGER WindowContainerColOffset
+ INTEGER WindowContainerRowOffset
+ System.Collections.Generic.List <WindowContainer> WindowContainers
Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
+ CHARACTER WindowPositionRegistryKey
Inherited from Consultingwerk.Forms.BaseForm


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

PUBLIC CheckSyntax ()

Purpose: Checks the Syntax of the current source code
Notes:

Top

PUBLIC CloseEmbeddedWindows (logical)

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
Purpose: Requests closing of the embedded window
Notes: Returns TRUE when window closed, otherwise FALSE

Parameters:
plOk LOGICAL
Logical value indicating if the windows were closed
Top

PUBLIC CloseFromCode ()

Purpose: Closes the Form after unsubscribing it's own FormClosing event handle
Notes: Invoked from src/winkit/closewindow.i after the ABL window WINDOW-CLOSE
event handler has not cancelled the closing of the WINDOW and Form

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 EmbedWindow (handle)

Purpose: Creates a new instance of the Progress.Windows.WindowContainer
instance and embeds the given window widget in that instance -
but does not parent the WindowContainer instance in the Form
(THIS-OBJECT). This is delayed till later.
Notes: Required due to incompatibility issues with the Infragistics
UltraTabbedMdiManager.

Parameters:
phWindow HANDLE
The handle of the WINDOW widget to embed
Top

PUBLIC EnableDisableOverlayControls ()

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
Purpose: Toggles Sensitivity of OverlayControls based on the sensitive status
of the corresponding Widget/Frame
Notes:

Top

PUBLIC FinalizeEmbedding ()

Purpose: Finalize the embedding of an ABL window widget by parenting
the Progress.Windows.WindowContainer instance in the Form
(THIS-OBJECT). Sets the Form Text property and applies the
window-resized event to the window widget.
Notes: Required due to incompatibility issues with the Infragistics
UltraTabbedMdiManager.

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 Progress.Windows.Form FindDependentFormOfClass (Class)

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the dependent form instance of the given class
Notes:

Parameters:
poClass Progress.Lang.Class
The class to locate
Returns Progress.Windows.Form
Form instance
Top

PUBLIC FormClosingHandler (Object, FormClosingEventArgs)

Purpose: Event Handler for the FormClosing event of the Form. When a window
is embedded, the FormClosing event will be cancelled and the
WINDOW-CLOSE event to the window will be applied.
Notes: The window is responsible for deleting the Form.
{src/adecommx/closewindow.i} can be used in the ON CLOSE OF THIS-
PROCEDURE trigger for that purpose

Parameters:
sender System.Object
The System.Object that raised the event
e System.Windows.Forms.FormClosingEventArgs
The FormClosingEventArgs with the data for this event
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 HANDLE GetEmbeddedWindows ()

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
Purpose: Returns an indeterminate array of the HANDLEs of the embedded Windows
Notes: Returns a size 1 array with the EmbeddedWindow HANDLE

Returns HANDLE
The array with the window HANDLE
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

PUBLIC InsertText (character, integer)

Purpose: Inserts text in the Procedure Editor at the given line
Notes:

Parameters:
pcText CHARACTER
The text to insert
piLine INTEGER
The line number to insert the text
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 LONGCHAR LoadSettingsLong (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 LONGCHAR
The string containing the stored window settings
Top

PUBLIC MoveCursor (integer)

Purpose: Moves editor cursor to a specified line number, column 1.
Notes: If entered line is greater than number of lines in buffer, then
move to EOF.

Parameters:
piLine INTEGER
The line number to move the cursor to
Top

PROTECTED OnActivated (EventArgs)

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
Purpose: Raises the Activated event
Notes: Optionally puts focus into the EmbeddedWindow

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

PROTECTED OnDeactivate (EventArgs)

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
Purpose: Raises the Deactivate event
Notes:

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

PROTECTED OnFormClosed (FormClosedEventArgs)

Overrides Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm: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)

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

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

PUBLIC RefreshButtons ()

Purpose: Refreshes the state of all overlay buttons in the IEmbeddedWindowForm
Notes: Actually this method has no functionally, but is required for the
implementation of the Interface IEmbeddedWindowForm

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

PUBLIC CHARACTER Save ()

Purpose: Saves the Editor contents
Notes:

Returns CHARACTER
The name of the file
Top

PUBLIC CHARACTER SaveToTemporaryFile ()

Purpose: Saves the Editor contents to a temporary file
Notes: Useful for parsing with Proparse

Returns CHARACTER
The name of the temporary file
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 StoreSettingsLong (longchar, character)

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Stores window settings to the registry
Notes:

Parameters:
plcSettings LONGCHAR
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

PUBLIC 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 registry
Notes:

Top

PROTECTED SuspendSTAThreadWarning (UltraDockManager)

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Suspends STAThread warnings for an UltraDockManager instance
Notes: SCL-3144
https://www.infragistics.com/community/forums/f/ultimate-ui-for-windows-forms/121824/appstylist-for-windows-forms-2020-1/537711 //www.infragistics.com/community/forums/f/ultimate-ui-for-windows-forms/121824/appstylist-for-windows-forms-2020-1/537711

Parameters:
poDockManager UltraDockManager
The reference to the UltraDockManager
Top

PRIVATE ultraToolbarsManager1_ToolClick (Object, ToolClickEventArgs)

Purpose: Event handler for the ToolClick event of the ultraToolbarsManager1
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

PROTECTED UpdateControlsForEventHandler ()

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
Purpose: Brings Controls/Widget's in sync for handling .NET Events
Notes: Used for instance with the ToolClick event and updatable browsers

Top

PUBLIC UpdateWindowAttributes ()

Purpose: Update Form properties with Properties from the WindowWidget
Notes:

Top

PUBLIC ViewHideOverlayControls ()

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
Purpose: Toggles Visibily of OverlayControls based on the view/hide status
of the corresponding Widget/Frame
Notes:

Top

PUBLIC Progress.Windows.WindowContainer WindowContainerOfWidget (handle)

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm
Purpose: Returns the WindowContainer that contains the widget
Notes:

Parameters:
phWidget HANDLE
The handle of the WINDOW widget to locate
Returns Progress.Windows.WindowContainer
The reference to the WindowContainer that contains the WINDOW


Constructor Detail
Top

PUBLIC ProcedureEditorForm ()

Purpose: Constructor for the ProcedureEditorForm 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 System.Windows.Forms.Control ClientArea


Returns System.Windows.Forms.Control
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

PUBLIC WIDGET-HANDLE EmbeddedWindow

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm

Returns WIDGET-HANDLE
Top

PUBLIC LOGICAL Finalized

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm

Returns LOGICAL
Top

PUBLIC LOGICAL FocusEmbeddedWindowOnActivated

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm

Returns LOGICAL
Top

PUBLIC CHARACTER FrameHandles

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm

Returns CHARACTER
Top

PROTECTED CHARACTER HiddenProperties

Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PUBLIC LOGICAL IsClosed

Inherited from Consultingwerk.Forms.BaseForm

Returns LOGICAL
Top

PUBLIC LOGICAL IsModified


Returns LOGICAL
Top

PUBLIC LOGICAL IsReadOnly


Returns LOGICAL
Top

PUBLIC LOGICAL MakeMdiChild

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm

Returns LOGICAL
Top

PUBLIC WIDGET-HANDLE MENU-BAR

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm

Returns WIDGET-HANDLE
Top

PUBLIC LOGICAL MenuBarAsToolbar

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm

Returns LOGICAL
Top

PUBLIC LOGICAL MenuItemsAsToolbar

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm

Returns LOGICAL
Top

PUBLIC DECIMAL MinHeightChars

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm

Returns DECIMAL
Top

PUBLIC DECIMAL MinWidthChars

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm

Returns DECIMAL
Top

PROTECTED CHARACTER NonBrowsableProperties

Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PUBLIC CHARACTER OriginalWindowTitle

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm

Returns CHARACTER
Top

PUBLIC System.Collections.Generic.Dictionary <System.Windows.Forms.Control> OverlayControls

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm

Returns System.Collections.Generic.Dictionary <System.Windows.Forms.Control>
Top

PUBLIC HANDLE PreviousFocus

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm

Returns HANDLE
Top

PUBLIC System.Windows.Forms.FormWindowState PreviousWindowState

Inherited from Consultingwerk.Forms.BaseForm

Returns System.Windows.Forms.FormWindowState
Top

PUBLIC HANDLE ProcedureHandle

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm

Returns HANDLE
Top

PUBLIC CHARACTER SecurityKey

Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PUBLIC LOGICAL ShowAsDialog

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm

Returns LOGICAL
Top

PROTECTED LOGICAL StoreFormPosition

Inherited from Consultingwerk.Forms.BaseForm

Returns LOGICAL
Top

PUBLIC UltraToolbarsManager ToolbarsManager

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm

Returns UltraToolbarsManager
Top

PUBLIC LOGICAL UseStartupSizeAsMinSize

Inherited from Consultingwerk.Forms.BaseForm

Returns LOGICAL
Top

PUBLIC INTEGER WindowContainerColOffset


Returns INTEGER
Top

PUBLIC INTEGER WindowContainerRowOffset


Returns INTEGER
Top

PUBLIC System.Collections.Generic.List <WindowContainer> WindowContainers

Inherited from Consultingwerk.Studio.ProcedureEditor.ProcedureEditorBaseForm

Returns System.Collections.Generic.List <WindowContainer>
Top

PUBLIC CHARACTER WindowPositionRegistryKey

Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER


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