Namespace: Consultingwerk.WindowIntegrationKit.Forms
Class 
EmbeddedWindowTabFolderForm Copy to Clipboard
Parent classes:
Progress.Windows.Form
Consultingwerk.Forms.BaseForm
Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowTabFolderFormDesigner
Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowTabFolderForm

Inherits: Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowTabFolderFormDesigner
Implements: IBaseForm, ICustomTypeDescriptor, Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm, Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowTabFolderForm, Consultingwerk.Framework.IFormWithUltraToolbarsManager, IHasDesignerVerbs

File:EmbeddedWindowTabFolderForm
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Dec 03 14:12:13 CET 2008

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



Top Method Summary
Options Name Purpose
# ActiveTabChangingHandler (Object, ActiveTabChangingEventArgs) Event Handler for the ActiveTabChanging event handler
+ AssignTabLabels (character, character) Assigns the Labels of the Tabfolder based on a Character List
+ LOGICAL CanFindInComponentsCollection (Object) Returns if the component can be found in the ComponentsCollection
Inherited from Consultingwerk.Forms.BaseForm
+ CloseEmbeddedWindows (logical) Requests closing of the embedded window
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ CloseFromCode () Closes the Form after unsubscribing it's own FormClosing event handle
+ CloseTabs () Closes the dynamically created windows and WindowContainer objects
+ CreateTab (character, integer) Creates a Tab on the TabFolder with the given Label and key
+ CreateTabPageFrame (integer) Creates the Window and Frame used for folder pages
+ CreateTabs (character) Creates Tabs for a list of Tabs
+ CreateTabs (character, character) Creates Tabs for a list of Tabs
# 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
+ DeleteTabPage (integer) Deletes (removes) a Tab Page
# DesignerInsertUserControl () Inserts a user control instance at design time.
Inherited from Consultingwerk.Forms.BaseForm
+ DisableFolderPage (integer) Disables a folder Page
+ 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.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ EnableFolderPage (integer) Enables a folder Page
+ 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.
+ FinalizeTabPage (integer) Fianlizes the Embedding of a single Tab Page
+ 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
+ FindPageZeroChilds (logical, logical) Detects Folder98 and other SmartFrames/Viewers
+ 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
Overrides Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm:GetEmbeddedWindows ()
+ 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
+ System.Windows.Forms.Control GetTabPageControl (integer) Returns the UltraTab Control that was created for a tab page
+ HANDLE GetTabPageFrame (integer) Returns the HANDLE of the ABL Frame that was created as the default frame for a tab page
+ HANDLE GetTabPageWindow (integer) Returns the HANDLE of the ABL Window that was created for a tab page
+ Progress.Windows.WindowContainer GetTabPageWindowContainer (integer) Returns the WindowContainer Control that was created for a tab page
# 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
# OnActivated (EventArgs) Raises the Activated event
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
# OnDeactivate (EventArgs) Raises the Deactivate event
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
# OnFormClosed (FormClosedEventArgs) Raises the FormClosed event
Overrides Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm: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
# OnSizeChanged (EventArgs) Raises the SizeChanged event
+ 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
# RepositionWindowContainer () Adjusts the position of the WindowContainer based on the Col- and Row-Offset
# 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
+ SelectTab (integer) Selects a TabPage
+ SetSplitterFixed () Sets the Splitter to fixed, disallow users to change the splitter distance
# 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
# TimerTickHandler (Object, EventArgs) Event Handler for the Tick Event of the Timer Component
- ToolClickHandler (Object, ToolClickEventArgs) Event Handler for the ToolClick Event of the UltraToolbarsManager
- ToolClickTimerTickHandler (Object, EventArgs) Event handler for the Tick event of the ToolClickTimer component
# ToolDropDownHandler (Object, BeforeToolDropdownEventArgs) Handles the BeforeToolDropDown event of the UltraToolbarsManager
# UpdateControlsForEventHandler () Brings Controls/Widget's in sync for handling .NET Events
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ 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.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ Progress.Windows.WindowContainer WindowContainerOfWidget (handle) Returns the WindowContainer that contains the widget
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm

Top Constructor Summary
Options Name Purpose
+ EmbeddedWindowTabFolderForm () Constructor of the EmbeddedWindowTabFolderForm 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.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ LOGICAL Finalized
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ LOGICAL FocusEmbeddedWindowOnActivated
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ CHARACTER FrameHandles
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
# CHARACTER HiddenProperties
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL IsClosed
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL MakeMdiChild
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ WIDGET-HANDLE MENU-BAR
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ LOGICAL MenuBarAsToolbar
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ LOGICAL MenuItemsAsToolbar
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ DECIMAL MinHeightChars
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ DECIMAL MinWidthChars
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
# CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.Forms.BaseForm
+ CHARACTER OriginalWindowTitle
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ System.Collections.Generic.Dictionary <System.Windows.Forms.Control> OverlayControls
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ HANDLE PreviousFocus
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ System.Windows.Forms.FormWindowState PreviousWindowState
Inherited from Consultingwerk.Forms.BaseForm
+ HANDLE ProcedureHandle
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ LOGICAL ShowAsDialog
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ INTEGER SplitterDistance
# LOGICAL StoreFormPosition
Inherited from Consultingwerk.Forms.BaseForm
+ Infragistics.Win.UltraWinTabControl.UltraTabControl TabFolder
+ INTEGER TabFolderTop
+ LOGICAL TabFolderVisible
+ Infragistics.Win.UltraWinToolbars.UltraToolbarsManager ToolbarsManager
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ LOGICAL UseStartupSizeAsMinSize
Inherited from Consultingwerk.Forms.BaseForm
+ INTEGER WindowContainerColOffset
+ INTEGER WindowContainerRowOffset
+ System.Collections.Generic.List <WindowContainer> WindowContainers
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
+ CHARACTER WindowPositionRegistryKey
Inherited from Consultingwerk.Forms.BaseForm


Method Detail
Top

PROTECTED ActiveTabChangingHandler (Object, ActiveTabChangingEventArgs)
Purpose: Event Handler for the ActiveTabChanging event handler
Notes:

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

PUBLIC AssignTabLabels (character, character)
Purpose: Assigns the Labels of the Tabfolder based on a Character List
Notes:

Parameters:
pcLabels CHARACTER
A delimited list of tab labels
pcDelimiter CHARACTER
The list delimited, like the | (pipe) for ADM2 folder
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 CloseEmbeddedWindows (logical)
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
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

PUBLIC CloseTabs ()
Purpose: Closes the dynamically created windows and WindowContainer objects
Notes: Used by closewindow.i

Top

PUBLIC CreateTab (character, integer)
Purpose: Creates a Tab on the TabFolder with the given Label and key
Notes:

Parameters:
pcTabText CHARACTER
The label to use for the new tab
piTabKey INTEGER
The 1 based number for the tab to create
Top

PUBLIC CreateTabPageFrame (integer)
Purpose: Creates the Window and Frame used for folder pages
Notes: Creates ttFolderPages record

Parameters:
piPage INTEGER
The page number to create a window and frame for
Top

PUBLIC CreateTabs (character)
Purpose: Creates Tabs for a list of Tabs
Notes: Uses the comma as the default delimiter

Parameters:
pcLabels CHARACTER
A comma-charcater delimited list of tab labels
Top

PUBLIC CreateTabs (character, character)
Purpose: Creates Tabs for a list of Tabs
Notes:

Parameters:
pcLabels CHARACTER
A charcater delimited list of tab labels
pcDelimiter CHARACTER
The character used as the delimiter of the list
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

PUBLIC DeleteTabPage (integer)
Purpose: Deletes (removes) a Tab Page
Notes:

Parameters:
piPage INTEGER
The tab page to remove
Top

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

Top

PUBLIC DisableFolderPage (integer)
Purpose: Disables a folder Page
Notes:

Parameters:
piPage INTEGER
The page number to disable (based on 1)
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 incombatibily issues with the Infragistics
UltraTabbedMdiManager.

Parameters:
phWindow HANDLE
The handle of the Window to embed
Top

PUBLIC EnableDisableOverlayControls ()
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
Purpose: Toggles Sensitivity of OverlayControls based on the sensitive status
of the corresponding Widget/Frame
Notes:

Top

PUBLIC EnableFolderPage (integer)
Purpose: Enables a folder Page
Notes:

Parameters:
piPage INTEGER
The page number to enable (based on 1)
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 incombatibily issues with the Infragistics
UltraTabbedMdiManager.

Top

PUBLIC FinalizeTabPage (integer)
Purpose: Fianlizes the Embedding of a single Tab Page
Notes:

Parameters:
piPage INTEGER
The Tab Page Number
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 FindPageZeroChilds (logical, logical)
Purpose: Detects Folder98 and other SmartFrames/Viewers
Notes: Important for visibility and positioning of the UltraTabFoler

Parameters:
plFolder98 LOGICAL
OUTPUT True, when an folder98.w instance was found
plOtherObject LOGICAL
OUTPUT True, when another object was found
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/winkit/closewindow.i} can be used in the ON CLOSE OF THIS-
PROCEDURE trigger for that purpose

Parameters:
sender System.Object
The reference to the 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 ()
Overrides Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm:GetEmbeddedWindows ()
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 of window HANDLE's
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

PUBLIC System.Windows.Forms.Control GetTabPageControl (integer)
Purpose: Returns the UltraTab Control that was created for a tab page
Notes:

Parameters:
piPage INTEGER
The 1 based index of the tab page
Returns System.Windows.Forms.Control
The reference to the UltraTab Control that was created for a tab page
Top

PUBLIC HANDLE GetTabPageFrame (integer)
Purpose: Returns the HANDLE of the ABL Frame that was created as the default
frame for a tab page
Notes:
frame for a tab page

Parameters:
piPage INTEGER
The 1 based index of the tab page
Returns HANDLE
The HANDLE of the ABL Frame that was created as the default
Top

PUBLIC HANDLE GetTabPageWindow (integer)
Purpose: Returns the HANDLE of the ABL Window that was created for a tab page
Notes:

Parameters:
piPage INTEGER
The 1 based index of the tab page
Returns HANDLE
The HANDLE of the ABL Window that was created for a tab page
Top

PUBLIC Progress.Windows.WindowContainer GetTabPageWindowContainer (integer)
Purpose: Returns the WindowContainer Control that was created for a tab page
Notes:

Parameters:
piPage INTEGER
The 1 based index of the tab page
Returns Progress.Windows.WindowContainer
The reference to the WindowContainer Control that was created for a tab page
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 OnActivated (EventArgs)
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
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.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
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.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm:OnFormClosed (FormClosedEventArgs)
Purpose: Raises the FormClosed event
Notes:

Parameters:
e System.Windows.Forms.FormClosedEventArgs
The FormClosedEventArgs with the data for this event
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 OnSizeChanged (EventArgs)
Purpose: Raises the SizeChanged event
Notes: Don't forward sizing events when the window is minimized

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

PUBLIC RefreshButtons ()
Purpose: Refreshes the state of all overlay buttons in the IEmbeddedWindowForm
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 RepositionWindowContainer ()
Purpose: Adjusts the position of the WindowContainer based on the Col- and
Row-Offset
Notes:

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 SelectTab (integer)
Purpose: Selects a TabPage
Notes:

Parameters:
piPage INTEGER
The tab page number
Top

PUBLIC SetSplitterFixed ()
Purpose: Sets the Splitter to fixed, disallow users to change the splitter
distance
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

PROTECTED TimerTickHandler (Object, EventArgs)
Purpose: Event Handler for the Tick Event of the Timer Component
Notes:

Parameters:
sender System.Object
The event sender
e System.EventArgs
The .NET default System.EventArgs for this event
Top

PRIVATE ToolClickHandler (Object, ToolClickEventArgs)
Purpose: Event Handler for the ToolClick Event of the UltraToolbarsManager
Notes: Applies CHOOSE to the base menu item

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

PRIVATE ToolClickTimerTickHandler (Object, EventArgs)
Purpose: Event handler for the Tick event of the ToolClickTimer component
Notes:

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

PROTECTED ToolDropDownHandler (Object, BeforeToolDropdownEventArgs)
Purpose: Handles the BeforeToolDropDown event of the UltraToolbarsManager
Notes: Delegates action to the MENU-DROP Event of the Progress SUB-MENU widget

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

PROTECTED UpdateControlsForEventHandler ()
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
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.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
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.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm
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 EmbeddedWindowTabFolderForm ()
Purpose: Constructor of the EmbeddedWindowTabFolderForm 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.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm

Returns WIDGET-HANDLE
Top

PUBLIC LOGICAL Finalized
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm

Returns LOGICAL
Top

PUBLIC LOGICAL FocusEmbeddedWindowOnActivated
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm

Returns LOGICAL
Top

PUBLIC CHARACTER FrameHandles
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm

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 MakeMdiChild
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm

Returns LOGICAL
Top

PUBLIC WIDGET-HANDLE MENU-BAR
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm

Returns WIDGET-HANDLE
Top

PUBLIC LOGICAL MenuBarAsToolbar
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm

Returns LOGICAL
Top

PUBLIC LOGICAL MenuItemsAsToolbar
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm

Returns LOGICAL
Top

PUBLIC DECIMAL MinHeightChars
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm

Returns DECIMAL
Top

PUBLIC DECIMAL MinWidthChars
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm

Returns DECIMAL
Top

PROTECTED CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PUBLIC CHARACTER OriginalWindowTitle
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm

Returns CHARACTER
Top

PUBLIC System.Collections.Generic.Dictionary <System.Windows.Forms.Control> OverlayControls
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm

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

PUBLIC HANDLE PreviousFocus
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm

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.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm

Returns HANDLE
Top

PUBLIC LOGICAL ShowAsDialog
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm

Returns LOGICAL
Top

PUBLIC INTEGER SplitterDistance

Returns INTEGER
Top

PROTECTED LOGICAL StoreFormPosition
Inherited from Consultingwerk.Forms.BaseForm

Returns LOGICAL
Top

PUBLIC Infragistics.Win.UltraWinTabControl.UltraTabControl TabFolder

Returns Infragistics.Win.UltraWinTabControl.UltraTabControl
Top

PUBLIC INTEGER TabFolderTop

Returns INTEGER
Top

PUBLIC LOGICAL TabFolderVisible

Returns LOGICAL
Top

PUBLIC Infragistics.Win.UltraWinToolbars.UltraToolbarsManager ToolbarsManager
Inherited from Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm

Returns Infragistics.Win.UltraWinToolbars.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.WindowIntegrationKit.Forms.EmbeddedWindowBaseForm

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

PUBLIC CHARACTER WindowPositionRegistryKey
Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       04.02.2020 23:41:12