Namespace: Consultingwerk.Windows.Framework.Repository.Rendering
Class 
DynamicForm Copy to Clipboard
Parent classes:
Progress.Windows.Form
Consultingwerk.Forms.BaseForm
Consultingwerk.SmartComponents.Base.SmartWindowForm
Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm

Inherits: Consultingwerk.SmartComponents.Base.SmartWindowForm
Implements: IBaseForm, Consultingwerk.SmartComponents.Interfaces.ICheckOkToClose, ICustomTypeDescriptor, Consultingwerk.SmartComponents.Interfaces.IFormSupportsHelp, Consultingwerk.Windows.IFormWithHash, Consultingwerk.Framework.IFormWithUltraDockManager, Consultingwerk.SmartComponents.IHasDesignerVerbs, Consultingwerk.SmartComponents.Interfaces.IHasPrimaryDataSourceAndTarget, IHasSecurityKey, Consultingwerk.SmartComponents.Interfaces.IHasTabDataSourceCount, Consultingwerk.SmartComponents.Interfaces.ISmartToolbarTarget, Consultingwerk.SmartComponents.Interfaces.ISmartWindowForm, Consultingwerk.Windows.Framework.Repository.Rendering.ITabFolderParent
Inherited by: Consultingwerk.Windows.Framework.Repository.Rendering.DynamicFormWithRibbon Consultingwerk.Windows.Framework.Repository.Rendering.DynamicTreeViewForm

/*&GLOBAL-DEFINE NoUserLobStatistics NoUserLobStatistics

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



Top Method Summary
Options Name Purpose
ActivateDataSources (character, character) Activates data sources of the given tab page
ActivateExportLink (integer) Activates Export links of the given tab page
ActivateLinks (integer) Activates links of the given tab page
ActivateNavigationLink (integer) Activates Navigation links of the given tab page
ActivateTableIoLink (integer) Activates TableIO links of the given tab page
AfterUpdateRecordHandler (Object, AfterUpdateRecordEventArgs) Handler for the AfterUpdateRecord event of the primary SmartBusinessEntityAdapter
ClearRibbon () Clears the Ribbon
ContextMenuBeforeToolDropdownHandler (Object, BeforeToolDropdownEventArgs) Event handler for the BeforeToolDropdown event of the UltraToolbarsManager
ContextMenuToolClickHandler (Object, ToolClickEventArgs) Event handler for the ToolClick event of the UltraToolbarsManager
LOGICAL DispatchFormInitializedInOnShown () Returns if the OnShown method of the SmartWindowForm dispatches the FormInitialized SSEH event
DoFormAction (character) Executes the Form Action
System.Collections.Generic.List <Progress.Windows.Form> FindDynamicFormInstances (character) Returns a list of DynamicForms of the given object master
System.Windows.Forms.TextBoxBase FindTextBox (Control) Returns the text box of a control
GetActiveTabPages (character, character) Returns the active tab pages
CHARACTER GetDataSourceInstanceName (Object) Returns the instance name of a data source
Consultingwerk.Windows.Controls.DynamicTreeViewControl GetDynamicTreeViewControlInstance (character) Returns the reference to the instance with the provided name as a DynamicTreeViewControl
System.Windows.Forms.TextBoxBase GetFocusedTextBox () Returns the text box that has the focus
CHARACTER GetFormName () Returns the name of the Form
CHARACTER GetImplicitToolDataSource (ToolBase) Returns the data source of a tool whose definition does not name a data source
System.ComponentModel.Component GetInstance (character) Returns the reference to the instance with the provided name
System.Collections.Generic.List <System.ComponentModel.Component> GetInstances (integer, Class) Returns a List of components of the given type on the given page
Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityAdapter GetSmartBusinessEntityAdapterInstance (character) Returns the reference to the instance with the provided name as a SmartBusinessEntityAdapter
Consultingwerk.SmartComponents.Implementation.SmartDataBrowser GetSmartDataBrowserInstance (character) Returns the reference to the instance with the provided name as a SmartDataBrowser
Consultingwerk.SmartComponents.Base.SmartDatasetAdapter GetSmartDatasetAdapterInstance (character) Returns the reference to the instance with the provided name as a SmartDatasetAdapter
Consultingwerk.SmartComponents.Implementation.SmartPanelController GetSmartPanelControllerByPage (character) Returns the SmartPanelController for the given page if it exists
Consultingwerk.SmartComponents.Implementation.SmartPanelController GetSmartPanelControllerByPage (integer) Returns the SmartPanelController for the given page if it exists
Consultingwerk.SmartComponents.Implementation.SmartToolbarController GetSmartToolbarControllerInstance (character) Returns the reference to the instance with the provided name as a SmartToolbarController
Consultingwerk.SmartComponents.Base.SmartViewerControl GetSmartViewerControlInstance (character) Returns the reference to the instance with the provided name as a SmartViewerControl
Infragistics.Win.UltraWinStatusBar.UltraStatusBar GetUltraStatusBarInstance (character) Returns the reference to the instance with the provided name as a UltraStatusBar
Infragistics.Win.UltraWinTabControl.UltraTabControl GetUltraTabControlInstance (character) Returns the reference to the instance with the provided name as a UltraTabControl
InitializeComponent ()
Infragistics.Win.UltraWinDock.UltraDockManager InitializeDockManager () Initializes the UltraDockManager instance
InitializeFormLruController (FormLruController, logical) Stores the FormLruController created for this Form during rendering and optionally wires the store-on-save behaviour
InitializeTabFolderEvents (UltraTabControl) Initializes the Tab Folder event handler
LOGICAL IsGrid (Object) Returns if the provided object is a grid
LOGICAL IsOkToClose (logical, CloseReason) Check if it is ok to close the parent form. Returns TRUE when the form can be closed. Otherwise returns FALSE. Enforced by the Interface ICheckOkToClose.
LOGICAL IsTabFolder (Object) Returns if the provided object is a tab folder
KeyDownHandler (Object, KeyEventArgs) Event handler for the KeyDown event of the Form
Consultingwerk.Windows.Framework.Repository.Rendering.Form.IHelpRegistry NewHelpRegistry () Factory method for IHelpRegistry instance
OnFormClosed (FormClosedEventArgs) Raises the FormClosed event
OnFormClosing (FormClosingEventArgs) Raises the FormClosing Event
OnLoad (EventArgs) Raises the Load event
OnPageInitializing (PageInitializingEventArgs) Raises the PageInitializing event
OnShown (EventArgs) Raises the Shown event
OpenDetailFormHandler (Object, OpenDetailFormEventArgs) Event handler for the OpenDetailForm of a Grid
LOGICAL OpenHelpPage () Opens the Help Page for the currently focussed Control
PerformClipboardTool (character) Performs one of the standard clipboard tools on the field the context menu was opened on
ReceiveInstances (table) Receives a copy of the temp-table with the rendered instances
RegisterContextMenu (UltraToolbarsManager, character, character) Registers a context menu rendered from the ContextMenu attribute
RegisterDataSourceForPageActivation (SmartDataAdapter, character) Registers Data-Sources for activation on a tab page
RegisterHelp (Object, handle) Registers Help URL and/or Help Text for a Control or Component in the Form
RegisterPage (character, integer, character, character) Registers a page with the DynamicForm
RegisterTabFolder (UltraTabControl, character, character) Registers a TabFolder with the DynamicForm
RegisterToolbarButtonEnableRule (ToolbarButtonEnableRule) Registers a ToolbarButtonEnableRule with the DynamicForm
RenderRuntimeRepositoryDeveloperMenu () Renders the developer runtime repository menu if available
SelectContextMenuGridRow (Control) Selects the grid row a context menu is opened on
SelectedPageChangedHandler (Object, TabEventArgs) Event handler for the SelectedPageChangedHandler event
SelectedPageChangingHandler (Object, SelectedTabChangingEventArgs) Event handler for the SelectedPageChangingHandler event

Top Constructor Summary
Options Name Purpose
DynamicForm () Constructor of the DynamicForm class
DynamicForm (character, character) Constructor of the DynamicForm class

Top Event Summary
Options Name Purpose
PageInitializing (Object, PageInitializingEventArgs) Raised when a page is initialized, i.e. before it's shown for the first time

Top Property Summary
Options Name Purpose
LOGICAL AutomaticExportLinks
LOGICAL AutomaticNavigationLinks
LOGICAL AutomaticTableIoLinks
CHARACTER CharacterParameterValue
System.ComponentModel.IContainer ComponentContainer
System.Windows.Forms.Control ContextMenuSourceControl
CHARACTER ContextMenuSourceInstanceName
Infragistics.Win.UltraWinDock.UltraDockManager DockManager
Infragistics.Win.Misc.UltraPanel FillPanel
RAW FormHash
Consultingwerk.Windows.Controls.FormLruController FormLruController
Consultingwerk.Windows.Framework.Repository.Rendering.Form.IHelpRegistry HelpRegistry
CHARACTER IconFileName
CHARACTER IconFileNameWeb
LOGICAL KeepFormContextProperties
CHARACTER ObjectMasterName
LOGICAL StoreDockManagerSettings
Consultingwerk.SmartComponents.Implementation.SmartToolbarController ToolbarController


Method Detail
Top

ActivateDataSources (character, character)
Purpose: Activates data sources of the given tab page
Notes:

Parameters:
pcPageSequences CHARACTER
The page sequences to activate data sources for
pcPageKeys CHARACTER
The page key to activate data sources for
Top

ActivateExportLink (integer)
Purpose: Activates Export links of the given tab page
Notes:

Parameters:
piPage INTEGER
Top

ActivateLinks (integer)
Purpose: Activates links of the given tab page
Notes:

Parameters:
piPage INTEGER
The page number to activate links for
Top

ActivateNavigationLink (integer)
Purpose: Activates Navigation links of the given tab page
Notes:

Parameters:
piPage INTEGER
The page number to activate links for
Top

ActivateTableIoLink (integer)
Purpose: Activates TableIO links of the given tab page
Notes:

Parameters:
piPage INTEGER
The page number to activate links for
Top

AfterUpdateRecordHandler (Object, AfterUpdateRecordEventArgs)
Purpose: Handler for the AfterUpdateRecord event of the primary
SmartBusinessEntityAdapter
Notes: SCL-5305: Stores the current record in the Ribbon LRU list after
a record update (store-on-save behaviour). Wired up by
InitializeFormLruController when the LruStoreAfterUpdateRecord
repository attribute is set.

Parameters:
sender System.Object
The reference to the System.Object that raised the event
e Consultingwerk.SmartComponents.Implementation.AfterUpdateRecordEventArgs
The AfterUpdateRecordEventArgs with the data for this event
Top

ClearRibbon ()
Purpose: Clears the Ribbon
Notes: Only executes this once to support multiple MetaToolbar instances to
share the Ribbon

Top

ContextMenuBeforeToolDropdownHandler (Object, BeforeToolDropdownEventArgs)
Purpose: Event handler for the BeforeToolDropdown event of the UltraToolbarsManager
Notes: SCL-6081: Before a context menu rendered from the ContextMenu
attribute drops down, the source control and component are
remembered, the grid row that was clicked is selected and the
enable rules of the tools are evaluated again, so that the state
of the tools reflects the record that was clicked

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

ContextMenuToolClickHandler (Object, ToolClickEventArgs)
Purpose: Event handler for the ToolClick event of the UltraToolbarsManager
Notes: SCL-6081: Performs the standard clipboard tools EditCut, EditCopy
and EditPaste of the context menus of fields

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

LOGICAL DispatchFormInitializedInOnShown ()
Purpose: Returns if the OnShown method of the SmartWindowForm dispatches
the FormInitialized SSEH event
Notes: SCL-6063 - the DynamicForm dispatches the event at the end of
its own OnShown method, after the tab folders, links and the
FormAction have been initialized

Returns LOGICAL
Logical value indicating if the OnShown method of the SmartWindowForm dispatches the FormInitialized event
Top

DoFormAction (character)
Purpose: Executes the Form Action
Notes:

Parameters:
pcAction CHARACTER
The FormAction to execute
Top

System.Collections.Generic.List <Progress.Windows.Form> FindDynamicFormInstances (character)
Purpose: Returns a list of DynamicForms of the given object master
Notes:

Parameters:
pcObjectMasterName CHARACTER
The name of the repository object master to locate
Returns System.Collections.Generic.List <Progress.Windows.Form>
The .NET Generic List of Form instances
Top

System.Windows.Forms.TextBoxBase FindTextBox (Control)
Purpose: Returns the text box of a control
Notes: SCL-6081: The control itself when it is a text box, otherwise the
first text box among its child controls, e.g. the text box of an
editor in edit mode

Parameters:
poControl System.Windows.Forms.Control
The reference to the control
Returns System.Windows.Forms.TextBoxBase
The TextBoxBase or the unknown value
Top

GetActiveTabPages (character, character)
Purpose: Returns the active tab pages
Notes:

Parameters:
pcActiveTabKeys CHARACTER
The keys of the active tabs
pcActiveTabIndexes CHARACTER
The indexes of the active tabs
Top

CHARACTER GetDataSourceInstanceName (Object)
Purpose: Returns the instance name of a data source
Notes: SCL-6081: Only a SmartDatasetAdapter rendered on this form can be
used as the data source of a server-side tool

Parameters:
poDataSource Progress.Lang.Object
The reference to the data source
Returns CHARACTER
The instance name of the data source or the empty value
Top

Consultingwerk.Windows.Controls.DynamicTreeViewControl GetDynamicTreeViewControlInstance (character)
Purpose: Returns the reference to the instance with the provided name as
a DynamicTreeViewControl
Notes: SCL-5861. A MetaTreeView instance placed on the form is
registered as a form level instance; one rendered inside a
MetaViewer is not - it carries its instance name as the Name of
the control, so the controls of the form are searched as well.
The tree view types are referenced fully qualified - a
using Consultingwerk.Windows.Controls.* would make the
SplitContainer of that package ambiguous with
System.Windows.Forms.SplitContainer

Parameters:
pcInstanceName CHARACTER
The name of the instance to locate
Returns Consultingwerk.Windows.Controls.DynamicTreeViewControl
The reference to the DynamicTreeViewControl or the unknown value
Top

System.Windows.Forms.TextBoxBase GetFocusedTextBox ()
Purpose: Returns the text box that has the focus
Notes: SCL-6081: Follows the ActiveControl of nested container controls
(viewers, user controls)

Returns System.Windows.Forms.TextBoxBase
The TextBoxBase with the focus or the unknown value
Top

CHARACTER GetFormName ()
Purpose: Returns the name of the Form
Notes: SCL-6071 - used as the FormName of the FormEventArgs of the
global events (GlobalSmartComponentEvents). Returns the name
of the repository object master of the Form

Returns CHARACTER
The name of the Form
Top

CHARACTER GetImplicitToolDataSource (ToolBase)
Purpose: Returns the data source of a tool whose definition does not name
a data source
Notes: SCL-6081: For a tool of a context menu rendered from the ContextMenu
attribute the component the context menu belongs to - when it
handles server-side events itself (grid, viewer) or is a data
source - or otherwise its data source or filter target

Parameters:
poTool Infragistics.Win.UltraWinToolbars.ToolBase
The reference to the tool that was clicked
Returns CHARACTER
The name of the data source instance or the empty value
Top

System.ComponentModel.Component GetInstance (character)
Purpose: Returns the reference to the instance with the provided name
Notes:

Parameters:
pcInstanceName CHARACTER
The name of the instance to locate
Returns System.ComponentModel.Component
The reference to the Component
Top

System.Collections.Generic.List <System.ComponentModel.Component> GetInstances (integer, Class)
Purpose: Returns a List of components of the given type on the given page
Notes:

Parameters:
piPage INTEGER
The page number to return instances from
poType Progress.Lang.Class
The Progress.Lang.Class specifying which instances to return
Returns System.Collections.Generic.List <System.ComponentModel.Component>
The reference to the Component
Top

Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityAdapter GetSmartBusinessEntityAdapterInstance (character)
Purpose: Returns the reference to the instance with the provided name as a SmartBusinessEntityAdapter
Notes:

Parameters:
pcInstanceName CHARACTER
The name of the instance to locate
Returns Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityAdapter
The reference to the Component
Top

Consultingwerk.SmartComponents.Implementation.SmartDataBrowser GetSmartDataBrowserInstance (character)
Purpose: Returns the reference to the instance with the provided name as a SmartDataBrowser
Notes:

Parameters:
pcInstanceName CHARACTER
The name of the instance to locate
Returns Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
The reference to the Component
Top

Consultingwerk.SmartComponents.Base.SmartDatasetAdapter GetSmartDatasetAdapterInstance (character)
Purpose: Returns the reference to the instance with the provided name as a SmartDatasetAdapter
Notes:

Parameters:
pcInstanceName CHARACTER
The name of the instance to locate
Returns Consultingwerk.SmartComponents.Base.SmartDatasetAdapter
The reference to the Component
Top

Consultingwerk.SmartComponents.Implementation.SmartPanelController GetSmartPanelControllerByPage (character)
Purpose: Returns the SmartPanelController for the given page if it exists
Notes:

Parameters:
pcPageKey CHARACTER
The page key
Returns Consultingwerk.SmartComponents.Implementation.SmartPanelController
The SmartPanelController
Top

Consultingwerk.SmartComponents.Implementation.SmartPanelController GetSmartPanelControllerByPage (integer)
Purpose: Returns the SmartPanelController for the given page if it exists
Notes:

Parameters:
piPageSequence INTEGER
The page number
Returns Consultingwerk.SmartComponents.Implementation.SmartPanelController
The SmartPanelController
Top

Consultingwerk.SmartComponents.Implementation.SmartToolbarController GetSmartToolbarControllerInstance (character)
Purpose: Returns the reference to the instance with the provided name as a SmartToolbarController
Notes:

Parameters:
pcInstanceName CHARACTER
The name of the instance to locate
Returns Consultingwerk.SmartComponents.Implementation.SmartToolbarController
The reference to the Component
Top

Consultingwerk.SmartComponents.Base.SmartViewerControl GetSmartViewerControlInstance (character)
Purpose: Returns the reference to the instance with the provided name as a SmartViewerControl
Notes:

Parameters:
pcInstanceName CHARACTER
The name of the instance to locate
Returns Consultingwerk.SmartComponents.Base.SmartViewerControl
The reference to the Component
Top

Infragistics.Win.UltraWinStatusBar.UltraStatusBar GetUltraStatusBarInstance (character)
Purpose: Returns the reference to the instance with the provided name as a UltraStatusBar
Notes:

Parameters:
pcInstanceName CHARACTER
The name of the instance to locate
Returns Infragistics.Win.UltraWinStatusBar.UltraStatusBar
The reference to the Component
Top

Infragistics.Win.UltraWinTabControl.UltraTabControl GetUltraTabControlInstance (character)
Purpose: Returns the reference to the instance with the provided name as a UltraTabControl
Notes:

Parameters:
pcInstanceName CHARACTER
The name of the instance to locate
Returns Infragistics.Win.UltraWinTabControl.UltraTabControl
The reference to the Component
Top

InitializeComponent ()

Top

Infragistics.Win.UltraWinDock.UltraDockManager InitializeDockManager ()
Purpose: Initializes the UltraDockManager instance
Notes:

Returns Infragistics.Win.UltraWinDock.UltraDockManager
The UltraDockManager instance
Top

InitializeFormLruController (FormLruController, logical)
Purpose: Stores the FormLruController created for this Form during
rendering and optionally wires the store-on-save behaviour
Notes: SCL-5305: Called by the DynamicFormRenderingService when the
LruDisplayFieldList repository attribute is set. When
plStoreAfterUpdateRecord is TRUE the AfterUpdateRecord event of
the controller's SmartBusinessEntityAdapter is subscribed so a
new LRU entry is stored whenever a record is saved.

Parameters:
poFormLruController Consultingwerk.Windows.Controls.FormLruController
The FormLruController instance to expose from this Form
plStoreAfterUpdateRecord LOGICAL
Logical value indicating if a new LRU entry is stored after a record update
Top

InitializeTabFolderEvents (UltraTabControl)
Purpose: Initializes the Tab Folder event handler
Notes:

Parameters:
poTabControl Infragistics.Win.UltraWinTabControl.UltraTabControl
The reference to the UltraTabControl instance
Top

LOGICAL IsGrid (Object)
Purpose: Returns if the provided object is a grid
Notes:

Parameters:
poObject Progress.Lang.Object
The object reference to verify
Returns LOGICAL
Logical value indicating if the object is a grid
Top

LOGICAL IsOkToClose (logical, CloseReason)
Purpose: Check if it is ok to close the parent form.
Returns TRUE when the form can be closed. Otherwise returns FALSE.
Enforced by the Interface ICheckOkToClose.
Notes:

Parameters:
plShowMessage LOGICAL
When TRUE a message is Shown explaining why it is not ok to close the parent form
poCloseReason System.Windows.Forms.CloseReason
The System.Windows.Forms.CloseReason passed from then OnFormClosing Method of the parent form giving the reason why the form is closed
Returns LOGICAL
Logical value indicating if the parent Form may be closed
Top

LOGICAL IsTabFolder (Object)
Purpose: Returns if the provided object is a tab folder
Notes:

Parameters:
poObject Progress.Lang.Object
The object reference to verify
Returns LOGICAL
Logical value indicating if the object is a tab folder
Top

KeyDownHandler (Object, KeyEventArgs)
Purpose: Event handler for the KeyDown event of the Form
Notes: Previous keys

Parameters:
sender System.Object
The reference to the component that raised the event
e System.Windows.Forms.KeyEventArgs
The KeyEventArgs with the data for this event
Top

Consultingwerk.Windows.Framework.Repository.Rendering.Form.IHelpRegistry NewHelpRegistry ()
Purpose: Factory method for IHelpRegistry instance
Notes: Returns new instance of HelpRegistry

Returns Consultingwerk.Windows.Framework.Repository.Rendering.Form.IHelpRegistry
The reference to the new IHelpRegistry instance
Top

OnFormClosed (FormClosedEventArgs)
Purpose: Raises the FormClosed event
Notes: SCL-6064: Removes the form-scoped session context properties
(<FormName>.<Property>) of the Form - after the FormClosed
server-side event handler (dispatched by SmartWindowForm), so that
it can still read them - unless KeepFormContextProperties is set

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

OnFormClosing (FormClosingEventArgs)
Purpose: Raises the FormClosing Event
Notes: Shut's down Plugins and saves UI preferences to .BusinessEntityDesignerSettings2.xml

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

OnLoad (EventArgs)
Purpose: Raises the Load event
Notes:

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

OnPageInitializing (PageInitializingEventArgs)
Purpose: Raises the PageInitializing event
Notes:

Parameters:
e Consultingwerk.Windows.Framework.Repository.Rendering.Form.PageInitializingEventArgs
The PageInitializingEventArgs with the data for the event
Top

OnShown (EventArgs)
Purpose: Raises the Shown event
Notes:

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

OpenDetailFormHandler (Object, OpenDetailFormEventArgs)
Purpose: Event handler for the OpenDetailForm of a Grid
Notes: Opens the DetailForm for a Grid

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.SmartComponents.Implementation.OpenDetailFormEventArgs
The OpenDetailFormEventArgs with the data for this event
Top

LOGICAL OpenHelpPage ()
Purpose: Opens the Help Page for the currently focussed Control
Notes:

Returns LOGICAL
Logical value indicating if a help page was opened
Top

PerformClipboardTool (character)
Purpose: Performs one of the standard clipboard tools on the field the
context menu was opened on
Notes: SCL-6081: Acts on the text box that has the focus - a right click
on a field moves the focus into the field - or on the text box of
the source control of the context menu

Parameters:
pcToolKey CHARACTER
The key of the tool: EditCut, EditCopy or EditPaste
Top

ReceiveInstances (table)
Purpose: Receives a copy of the temp-table with the rendered instances
Notes:

Parameters:
ttInstances TEMP-TABLE ttInstances
The temp-table with the temp-tables (BY-REFERENCE)
Top

RegisterContextMenu (UltraToolbarsManager, character, character)
Purpose: Registers a context menu rendered from the ContextMenu attribute
Notes: SCL-6081: The form tracks the component of every context menu,
so that tools without a dataSource in their definition act on the
data source of that component, and prepares the context menu
before it drops down

Parameters:
poToolbarsManager Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
The reference to the UltraToolbarsManager owning the context menu
pcPopupMenuKey CHARACTER
The key of the PopupMenuTool of the context menu
pcInstanceName CHARACTER
The instance name of the component the context menu belongs to
Top

RegisterDataSourceForPageActivation (SmartDataAdapter, character)
Purpose: Registers Data-Sources for activation on a tab page
Notes:

Parameters:
poDataAdapter Consultingwerk.SmartComponents.Base.SmartDataAdapter
The SmartDataAdapter to register
pcPagesList CHARACTER
The comma delimited list of pages
Top

RegisterHelp (Object, handle)
Purpose: Registers Help URL and/or Help Text for a Control or Component in the Form
Notes:

Parameters:
poControl System.Object
The reference to the Control or Component
phBuffer HANDLE
The handle of the buffer with the attribute values
Top

RegisterPage (character, integer, character, character)
Purpose: Registers a page with the DynamicForm
Notes:

Parameters:
pcPageGuid CHARACTER
The GUID of the Page
piPageSequence INTEGER
The Page Sequence
pcPageLabel CHARACTER
The Page Label
pcPageKey CHARACTER
The Page Key
Top

RegisterTabFolder (UltraTabControl, character, character)
Purpose: Registers a TabFolder with the DynamicForm
Notes:

Parameters:
poTabFolder Infragistics.Win.UltraWinTabControl.UltraTabControl
The reference to the TabFolder
pcTabFolderName CHARACTER
The name of the TabFolder
pcTabGroup CHARACTER
The name of the TabGroup
Top

RegisterToolbarButtonEnableRule (ToolbarButtonEnableRule)
Purpose: Registers a ToolbarButtonEnableRule with the DynamicForm
Notes: SCL-4112: Keeps a reference to the EnableRule instances of the
custom toolbar buttons, so that they share the lifetime of the form

Parameters:
poEnableRule Consultingwerk.Windows.Framework.Repository.Rendering.Toolbar.ToolbarButtonEnableRule
The reference to the ToolbarButtonEnableRule to register
Top

RenderRuntimeRepositoryDeveloperMenu ()
Purpose: Renders the developer runtime repository menu if available
Notes:

Top

SelectContextMenuGridRow (Control)
Purpose: Selects the grid row a context menu is opened on
Notes: SCL-6081: A row that is not selected is activated and selected
before the context menu opens, a row that is part of the
selection keeps the selection. Nothing changes when the context
menu was not opened on a data row, e.g. with the keyboard

Parameters:
poControl System.Windows.Forms.Control
The source control of the context menu
Top

SelectedPageChangedHandler (Object, TabEventArgs)
Purpose: Event handler for the SelectedPageChangedHandler event
Notes:

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

SelectedPageChangingHandler (Object, SelectedTabChangingEventArgs)
Purpose: Event handler for the SelectedPageChangingHandler event
Notes:

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


Constructor Detail
Top

DynamicForm ()
Purpose: Constructor of the DynamicForm class
Notes:

Top

DynamicForm (character, character)
Purpose: Constructor of the DynamicForm class
Notes:

Parameters:
pcObjectMasterName CHARACTER
The name of the repository object master
pcCharacterParameterValue CHARACTER
The value of the character startup parameter


Event Detail
Top

PageInitializing (Object, PageInitializingEventArgs)
Purpose: Raised when a page is initialized, i.e. before it's shown for the
first time
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the PageInitializing event
e Consultingwerk.Windows.Framework.Repository.Rendering.Form.PageInitializingEventArgs
The PageInitializingEventArgs with the data for the event


Property Detail
Top

LOGICAL AutomaticExportLinks

Returns LOGICAL
Top

LOGICAL AutomaticNavigationLinks

Returns LOGICAL
Top

LOGICAL AutomaticTableIoLinks

Returns LOGICAL
Top

CHARACTER CharacterParameterValue

Returns CHARACTER
Top

System.ComponentModel.IContainer ComponentContainer

Returns System.ComponentModel.IContainer
Top

System.Windows.Forms.Control ContextMenuSourceControl

Returns System.Windows.Forms.Control
Top

CHARACTER ContextMenuSourceInstanceName

Returns CHARACTER
Top

Infragistics.Win.UltraWinDock.UltraDockManager DockManager

Returns Infragistics.Win.UltraWinDock.UltraDockManager
Top

Infragistics.Win.Misc.UltraPanel FillPanel

Returns Infragistics.Win.Misc.UltraPanel
Top

RAW FormHash

Returns RAW
Top

Consultingwerk.Windows.Controls.FormLruController FormLruController

Returns Consultingwerk.Windows.Controls.FormLruController
Top

Consultingwerk.Windows.Framework.Repository.Rendering.Form.IHelpRegistry HelpRegistry

Returns Consultingwerk.Windows.Framework.Repository.Rendering.Form.IHelpRegistry
Top

CHARACTER IconFileName

Returns CHARACTER
Top

CHARACTER IconFileNameWeb

Returns CHARACTER
Top

LOGICAL KeepFormContextProperties

Returns LOGICAL
Top

CHARACTER ObjectMasterName

Returns CHARACTER
Top

LOGICAL StoreDockManagerSettings

Returns LOGICAL
Top

Consultingwerk.SmartComponents.Implementation.SmartToolbarController ToolbarController

Returns Consultingwerk.SmartComponents.Implementation.SmartToolbarController


Temp-Table Detail

Temp-Table ttInstances

Defined in:


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2026 08:19:26