Namespace: Consultingwerk.WindowIntegrationKit.Forms
Interface 
IEmbeddedWindowTabFolderForm Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implemented by: Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowTabFolderForm

File:IEmbeddedWindowTabFolderForm
Purpose:An Interface describing the methods required in WinKit
Forms that realize a TabFolder
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Tue Jan 15 13:11:13 CET 2013

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ AssignTabLabels (character, character) Assigns the Labels of the Tabfolder based on a Character List
+ 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
+ DeleteTabPage (integer) Deletes (removes) a Tab Page
+ DisableFolderPage (integer) Disables a folder Page
+ EnableFolderPage (integer) Enables a folder Page
+ FinalizeTabPage (integer) Fianlizes the Embedding of a single Tab Page
+ 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
+ SelectTab (integer) Selects a TabPage

Top Property Summary
Options Name Purpose
+ INTEGER SplitterDistance Gets and sets the Splitter's distance
+ Infragistics.Win.UltraWinTabControl.UltraTabControl TabFolder Returns the reference to the UltraTabControl used in this Form


Method Detail
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 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 delimited character list of tab labels
pcDelimiter CHARACTER
The character used as the delimiter of the list
Top

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

Parameters:
piPage INTEGER
The tab page to remove
Top

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

Parameters:
piPage INTEGER
The page number to disable (based on 1)
Top

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

Parameters:
piPage INTEGER
The page number to enable (based on 1)
Top

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

Parameters:
piPage INTEGER
The Tab Page Number
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

PUBLIC SelectTab (integer)
Purpose: Selects a TabPage
Notes:

Parameters:
piPage INTEGER
The tab page number


Property Detail
Top

PUBLIC INTEGER SplitterDistance
Purpose: Gets and sets the Splitter's distance
Notes: Should be set to match the position of the original ABL tabfolder

Returns INTEGER
Top

PUBLIC Infragistics.Win.UltraWinTabControl.UltraTabControl TabFolder
Purpose: Returns the reference to the UltraTabControl used in this Form
Notes:

Returns Infragistics.Win.UltraWinTabControl.UltraTabControl


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