Namespace: Consultingwerk.BusinessEntityDesigner.UI
Class 
BusinessEntitySourceEditorForm Copy to Clipboard
Parent classes:
Progress.Windows.Form
Consultingwerk.Forms.BaseForm
Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Consultingwerk.BusinessEntityDesigner.UI.BusinessEntitySourceEditorForm

Inherits: Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Implements: IBaseForm, ICustomTypeDescriptor, IHasDesignerVerbs

File:BusinessEntitySourceEditorForm
Purpose:An Editor for the generated source code
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Fri Jun 28 12:26:40 CEST 2013

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
- BindDataset (dataset) Do nothing, just receive the parameter and bind to the received Dataset reference
+ LOGICAL CanFindInComponentsCollection (Object) Returns if the component can be found in the ComponentsCollection
Inherited from Consultingwerk.Forms.BaseForm
# CheckSyntax () Performs a syntax check
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
+ LOGICAL CloseAll () Closes all open editors and when successful the SmartEditorForm itself
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
# CreateRibbonTools () Creates the Ribbon Tools specific to the Business Entity Source Editor
# 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
# DeleteTemporaryFile (character) Deletes a temporary file
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
# DesignerInsertUserControl () Inserts a user control instance at design time.
Inherited from Consultingwerk.Forms.BaseForm
+ DisplayStatus (character) Displays status in the status bar
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
# EditorFormClosedHandler (Object, FormClosedEventArgs) Event handle for the FormClosedHandler event of the Procedure Editor Forms
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
# EvaluateSaveEnabled () Determines and sets the Enabled status of the Save button
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
+ 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
+ CHARACTER GetCurrentFileName () Returns the name of the currently active file
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
+ 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
+ org.prorefactor.core.JPNode GetJPNode (integer) Returns a JPNode by a node number
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
+ 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
# InsertClientCallableMethod () Shows a dialog and allows inserting a client-callable method
# InsertDatasetCallback () Shows a dialog and allows inserting a dataset read callback
# InsertMethod () Inserts a method into the source code
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
+ InsertMethod (character, character) Inserts a method into the current class
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
# InsertValidationHook () Shows a dialog and allows inserting a validation hook
# 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
# OnDragDrop (DragEventArgs) Raises the DragDrop event
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
# OnDragEnter (DragEventArgs) Raises the DragEnter event
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
# OnFormClosed (FormClosedEventArgs) Raises the MdiChildActivate event
Overrides Consultingwerk.Forms.BaseForm:OnFormClosed (FormClosedEventArgs)
# OnFormClosing (FormClosingEventArgs) Raises the FormClosing event
Overrides Consultingwerk.Studio.ProcedureEditor.SmartEditorForm:OnFormClosing (FormClosingEventArgs)
# OnFormDestroyed (EventArgs) Raises the FormDestroyed event
Inherited from Consultingwerk.Forms.BaseForm
# OnLoad (EventArgs) Raises the Load event
Inherited from Consultingwerk.Forms.BaseForm
# OnMdiChildActivate (EventArgs) Raises the MdiChildActivate event
Overrides Consultingwerk.Studio.ProcedureEditor.SmartEditorForm:OnMdiChildActivate (EventArgs)
# OnShown (EventArgs) Raises the Shown event
Overrides Consultingwerk.Studio.ProcedureEditor.SmartEditorForm:OnShown (EventArgs)
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.Forms.BaseForm
# OpenBusinessEntity () Opens the Business Entity files
# Consultingwerk.Studio.ProcedureEditor.ProcedureEditorForm OpenBusinessEntityFile (character, character, BusinessEntityPartEnum) Opens a file of the business entity
# OpenFile () Shows the File Open dialog
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
+ Consultingwerk.Studio.ProcedureEditor.ProcedureEditorForm OpenFile (character) Opens the given file
Overrides Consultingwerk.Studio.ProcedureEditor.SmartEditorForm:OpenFile (character)
# ParseClassMembers (JPNode) Parses the ClassNode
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
# ParseProcedureMembers (JPNode) Parses the ProcedureNode
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
# ParseSourceCode () Parses the current editor contents
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
# PopulateMethodTempTable () Populates the temp-table with the current class methods
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
# PopulateOutline (ParseUnit) Populates the Outline View
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
# LOGICAL Reparse () Reparses the current editor contents
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
# 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
# Save () Saves the current editors
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
# SaveAll () Saves all open editors
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
+ SetTimersEnabled (logical) Enables or Disables the Timer Components
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
# 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
# TreeNodeSelectedHandler (Object, TreeNodeSelectedEventArgs) Event handler for the treeNodeSelected event of the ultraTreeWithSearchControl1
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
- ultraToolbarsManager1_ToolClick (Object, ToolClickEventArgs) Event handler for the ToolClick event of the ultraToolbarsManager1

Top Constructor Summary
Options Name Purpose
+ BusinessEntitySourceEditorForm (handle) Constructor for the BusinessEntitySourceEditorForm 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 Property that is used to mark properties (comma-delimited list) that should be Data-Bindable
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER CategorizedProperties Property that is used to mark properties (comma-delimited list) that should receive a Category attribute
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER CategoryProperties Categories of the Property in the CategorizedProperty list
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL DeleteOnFormClosed Gets/Sets if the BaseForm instance should automatically delete itself in the OnFormClosed method (defaults to True). Setting this to FALSE will allow to let the BaseForm instance in memory (when no other reference exists), i.e. to access properties of the Form class when the Form has been closed.
Inherited from Consultingwerk.Forms.BaseForm
+ System.Collections.Generic.List <Progress.Windows.Form> DependentForms A list of Forms that are dependent from this Form.
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DescribedProperties Property that is used to mark properties (comma-delimited list) that should receive a Description attribute
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DescriptionProperties Description of the Property in the DescribedProperties list
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DesignerVerbs Property that is used to generate Designer Verbs (actions for the Visual Designer)
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DesignerVisibilityAttributes The CHARACTER representation of the DesignerSerializationVisibiltiy attribute (Content/Visible/Hidden), see .NET Enumeration System.ComponentModel.DesignerSerializationVisibility
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DesignerVisibilityProperties Property that is used to mark properties (comma-delimited list) that should receive a DesignerSerializationVisibility Attribute
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL DesignTime Propery flags if the current instance of the SmartBindingSource is running at design time or runtime.
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER HiddenProperties Property that is used to mark properties (comma-delimited list) that will be excluded from the .NET TypeDescriptor properties list
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL IsClosed Returns if the Forms has been closed.
Inherited from Consultingwerk.Forms.BaseForm
+ System.Collections.Generic.Dictionary < org.prorefactor.core.JPNode> Nodes
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
# CHARACTER NonBrowsableProperties Property that is used to mark properties (comma-delimited list) that should not show up in the Visual Designers Property Grid
Inherited from Consultingwerk.Forms.BaseForm
+ System.Windows.Forms.FormWindowState PreviousWindowState Returns the previous WindowState
Inherited from Consultingwerk.Forms.BaseForm
# LOGICAL StoreFormPosition Controls if this Form instance should store and restore the Form position and size.
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL UseStartupSizeAsMinSize When set to True the OnLoad method will apply the current form (startup size) to the MinimumSize. This will be done before loading the stored Form size from the user profile (e.g. Windows Registry)
Inherited from Consultingwerk.Forms.BaseForm
+ CHARACTER WindowPositionRegistryKey Gets and sets the Registry Key used for storing this Forms window position
Inherited from Consultingwerk.Forms.BaseForm


Method Detail
Top

PRIVATE BindDataset (dataset)
Purpose: Do nothing, just receive the parameter and bind to the received
Dataset reference
Notes: Invoked from the class constructor

Parameters:
dsBusinessEntity DATASET
DATASET to bind to
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 CheckSyntax ()
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Performs a syntax check
Notes:

Top

PUBLIC LOGICAL CloseAll ()
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Closes all open editors and when successful the SmartEditorForm itself
Notes:

Returns LOGICAL
Logical value indicating if the editor was closed
Top

PROTECTED CreateRibbonTools ()
Purpose: Creates the Ribbon Tools specific to the Business Entity Source Editor
Notes:

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 DeleteTemporaryFile (character)
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Deletes a temporary file
Notes:

Parameters:
pcFileName CHARACTER
The name of the temporary file
Top

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

Top

PUBLIC DisplayStatus (character)
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Displays status in the status bar
Notes:

Parameters:
pcStatus CHARACTER
The status to display
Top

PROTECTED EditorFormClosedHandler (Object, FormClosedEventArgs)
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Event handle for the FormClosedHandler event of the Procedure Editor
Forms
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 EvaluateSaveEnabled ()
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Determines and sets the Enabled status of the Save button
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 CHARACTER GetCurrentFileName ()
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Returns the name of the currently active file
Notes:

Returns CHARACTER
The name of the currently active file
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 org.prorefactor.core.JPNode GetJPNode (integer)
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Returns a JPNode by a node number
Notes:

Parameters:
piNodeNum INTEGER
The node number to return
Returns org.prorefactor.core.JPNode
The refernce to the specified JPNode
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

PROTECTED InsertClientCallableMethod ()
Purpose: Shows a dialog and allows inserting a client-callable method
Notes:

Top

PROTECTED InsertDatasetCallback ()
Purpose: Shows a dialog and allows inserting a dataset read callback
Notes:

Top

PROTECTED InsertMethod ()
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Inserts a method into the source code
Notes:

Top

PUBLIC InsertMethod (character, character)
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Inserts a method into the current class
Notes: Locates the position by alphabeth

Parameters:
pcMethodName CHARACTER
The name of the method to insert
pcCode CHARACTER
The complete code of the method to insert (including comments and the METHOD statement)
Top

PROTECTED InsertValidationHook ()
Purpose: Shows a dialog and allows inserting a validation hook
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 OnDragDrop (DragEventArgs)
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Raises the DragDrop event
Notes:

Parameters:
e System.Windows.Forms.DragEventArgs
The DragEventArgs with the data for this event
Top

PROTECTED OnDragEnter (DragEventArgs)
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Raises the DragEnter event
Notes:

Parameters:
e System.Windows.Forms.DragEventArgs
The DragEventArgs with the data for this event
Top

PROTECTED OnFormClosed (FormClosedEventArgs)
Overrides Consultingwerk.Forms.BaseForm:OnFormClosed (FormClosedEventArgs)
Purpose: Raises the MdiChildActivate event
Notes:

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

PROTECTED OnFormClosing (FormClosingEventArgs)
Overrides Consultingwerk.Studio.ProcedureEditor.SmartEditorForm: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)
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 OnMdiChildActivate (EventArgs)
Overrides Consultingwerk.Studio.ProcedureEditor.SmartEditorForm:OnMdiChildActivate (EventArgs)
Purpose: Raises the MdiChildActivate event
Notes:

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

PROTECTED OnShown (EventArgs)
Overrides Consultingwerk.Studio.ProcedureEditor.SmartEditorForm: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 OpenBusinessEntity ()
Purpose: Opens the Business Entity files
Notes:

Top

PROTECTED Consultingwerk.Studio.ProcedureEditor.ProcedureEditorForm OpenBusinessEntityFile (character, character, BusinessEntityPartEnum)
Purpose: Opens a file of the business entity
Notes:

Parameters:
pcClassName CHARACTER
The file name to open
pcFileTitle CHARACTER
The file title for error messages
poPart Consultingwerk.BusinessEntityDesigner.BusinessEntityPartEnum
The BusinessEntityPartEnum value describing the part to be opened
Returns Consultingwerk.Studio.ProcedureEditor.ProcedureEditorForm
The reference to the ProcedureEditorForm
Top

PROTECTED OpenFile ()
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Shows the File Open dialog
Notes:

Top

PUBLIC Consultingwerk.Studio.ProcedureEditor.ProcedureEditorForm OpenFile (character)
Overrides Consultingwerk.Studio.ProcedureEditor.SmartEditorForm:OpenFile (character)
Purpose: Opens the given file
Notes:

Parameters:
pcFileName CHARACTER
The name of the file to open
Returns Consultingwerk.Studio.ProcedureEditor.ProcedureEditorForm
The reference to the ProcedureEditorForm
Top

PROTECTED ParseClassMembers (JPNode)
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Parses the ClassNode
Notes:

Parameters:
poClassName org.prorefactor.core.JPNode
The JPNode for the Class Node
Top

PROTECTED ParseProcedureMembers (JPNode)
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Parses the ProcedureNode
Notes:

Parameters:
poProcedureNode org.prorefactor.core.JPNode
The JPNode for the Procedure Node
Top

PROTECTED ParseSourceCode ()
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Parses the current editor contents
Notes:

Top

PROTECTED PopulateMethodTempTable ()
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Populates the temp-table with the current class methods
Notes:

Top

PROTECTED PopulateOutline (ParseUnit)
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Populates the Outline View
Notes:

Parameters:
poParseUnit ParseUnit
The ParseUnit of the File to parse
Top

PROTECTED LOGICAL Reparse ()
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Reparses the current editor contents
Notes:

Returns LOGICAL
Logical value indicating if the file could be parsed
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 Save ()
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Saves the current editors
Notes:

Top

PROTECTED SaveAll ()
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Saves all open editors
Notes:

Top

PUBLIC SetTimersEnabled (logical)
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Enables or Disables the Timer Components
Notes:

Parameters:
plEnabled LOGICAL
Logical value indicating if the timers should be enabled or not
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

PROTECTED TreeNodeSelectedHandler (Object, TreeNodeSelectedEventArgs)
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm
Purpose: Event handler for the treeNodeSelected event of the ultraTreeWithSearchControl1
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e TreeNodeSelectedEventArgs
The TreeNodeSelectedEventArgs with the data for this event
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 event that raised this event
e Infragistics.Win.UltraWinToolbars.ToolClickEventArgs
The ToolClickEventArgs with the data for this event


Constructor Detail
Top

PUBLIC BusinessEntitySourceEditorForm (handle)
Purpose: Constructor for the BusinessEntitySourceEditorForm class
Notes:

Parameters:
phDataset HANDLE
The handle of the dsBusinessEntity used in the Business Entity Designer


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
Purpose: Property that is used to mark properties (comma-delimited list) that
should be Data-Bindable
Notes: C# Annotation: [Bindable(true)]

Returns CHARACTER
Top

PROTECTED CHARACTER CategorizedProperties
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Property that is used to mark properties (comma-delimited list) that
should receive a Category attribute
Notes: C# Annotation: [Category("...")]
This is a comma delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER CategoryProperties
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Categories of the Property in the CategorizedProperty list
Notes: C# Annotation: [Category("...")]
This is a comma delimited list

Returns CHARACTER
Top

PUBLIC LOGICAL DeleteOnFormClosed
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Gets/Sets if the BaseForm instance should automatically delete
itself in the OnFormClosed method (defaults to True). Setting this
to FALSE will allow to let the BaseForm instance in memory (when no
other reference exists), i.e. to access properties of the Form
class when the Form has been closed.
Notes: See Progress K-Base Entry ID: P179041
Title: "User Controls that have events attached to them cause
parent forms to not get garbage collected"

Returns LOGICAL
Top

PUBLIC System.Collections.Generic.List <Progress.Windows.Form> DependentForms
Inherited from Consultingwerk.Forms.BaseForm
Purpose: A list of Forms that are dependent from this Form.
Notes: Dependent Forms are similar to ChildForms with the exception that
DependentForms are not automatically kept on top of the Owner.
But when the owner is closed, ths DependentForms will be closed as
well.

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

PROTECTED CHARACTER DescribedProperties
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Property that is used to mark properties (comma-delimited list) that
should receive a Description attribute
Notes: C# Annotation: [Description("...")]
This is a comma delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER DescriptionProperties
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Description of the Property in the DescribedProperties list
Notes: C# Annotation: [Description("...")]
This is a CHR(1) delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVerbs
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Property that is used to generate Designer Verbs (actions for the
Visual Designer)
Notes:

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityAttributes
Inherited from Consultingwerk.Forms.BaseForm
Purpose: The CHARACTER representation of the DesignerSerializationVisibiltiy
attribute (Content/Visible/Hidden), see .NET Enumeration
System.ComponentModel.DesignerSerializationVisibility
Notes: C# Annotation: [DesignerSerializationVisibility(...)]
This is a comma delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityProperties
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Property that is used to mark properties (comma-delimited list) that
should receive a DesignerSerializationVisibility Attribute
Notes: C# Annotation: [DesignerSerializationVisibility(...)]
This is a comma delimited list

Returns CHARACTER
Top

PUBLIC LOGICAL DesignTime
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Propery flags if the current instance of the SmartBindingSource
is running at design time or runtime.
Notes: Set during constructor using a check at the
System.ComponentModel.LicenseManager

Returns LOGICAL
Top

PROTECTED CHARACTER HiddenProperties
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Property that is used to mark properties (comma-delimited list) that
will be excluded from the .NET TypeDescriptor properties list
Notes:

Returns CHARACTER
Top

PUBLIC LOGICAL IsClosed
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns if the Forms has been closed.
Notes: A Form may be closed but not yet deleted

Returns LOGICAL
Top

PUBLIC System.Collections.Generic.Dictionary < org.prorefactor.core.JPNode> Nodes
Inherited from Consultingwerk.Studio.ProcedureEditor.SmartEditorForm

Returns System.Collections.Generic.Dictionary < org.prorefactor.core.JPNode>
Top

PROTECTED CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Property that is used to mark properties (comma-delimited list) that
should not show up in the Visual Designers Property Grid
Notes:

Returns CHARACTER
Top

PUBLIC System.Windows.Forms.FormWindowState PreviousWindowState
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the previous WindowState
Notes: This is useful when minimized Form should be brought back to foreground
and it is important to know if the window should be receiving Normal
or Maximized window state
Progress introduced in a 10.2B service pack the property previousState
that returned the previous WindowState. However in OpenEdge 11.1 this
property has been removed (or marked private) as this property was
never intended for the public use. As we and other customer have
been relying on this property Progress has logged bug # OE00222715
to restore this property in a future release or service pack

Returns System.Windows.Forms.FormWindowState
Top

PROTECTED LOGICAL StoreFormPosition
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Controls if this Form instance should store and restore the Form
position and size.
Notes: Allows alternative Form positions (like CenterParent etc.)

Returns LOGICAL
Top

PUBLIC LOGICAL UseStartupSizeAsMinSize
Inherited from Consultingwerk.Forms.BaseForm
Purpose: When set to True the OnLoad method will apply the current form (startup
size) to the MinimumSize. This will be done before loading the stored
Form size from the user profile (e.g. Windows Registry)
Notes: Defaulted by static property UseStartupSizeAsMinSizeDefault in
Consultingwerk.Framework.FrameworkSettings. This property used to
be in the class itself, but was moved to the FrameworkSettings class
to avoid issues with the combination of static and hybrids on 11.2
and 11.3, OE defect OE00240707
http://knowledgebase.progress.com/articles/Article/000042229?popup=true

Returns LOGICAL
Top

PUBLIC CHARACTER WindowPositionRegistryKey
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Gets and sets the Registry Key used for storing this Forms
window position
Notes:

Returns CHARACTER


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:26:56