Namespace: Consultingwerk.BusinessEntityDesigner.Plugins
Class 
IndexSelectionPlugin Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.BusinessEntityDesigner.Plugins.IndexSelectionPlugin

Inherits: Progress.Lang.Object
Implements: Consultingwerk.BusinessEntityDesigner.IBusinessEntityDesignerPlugin


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



Top Method Summary
Options Name Purpose
AddIndexSelectionRow (character, character, logical, logical, logical) Creates a ttIndexSelection record for the given index
DesignCanvasContextMenuOpeningHandler (Object, DesignCanvasContextMenuOpeningEventArgs) Event handler for the DesignCanvasContextMenuOpening event of the BusinessEntityDesignerForm
LOGICAL HasMissingIndexes (character) Returns if the first source database table of the given temp-table has indexes that are not yet part of the temp-table design
NewTempTableAddedHandler (Object, NewTempTableAddedEventArgs) Event handler for the NewTempTableAdded event of the BusinessEntityDatasetController
RunIndexSelection (character) Re-runs the index selection dialog for an existing temp-table of the design
Shutdown () Method called when the Business Entity Designer will get closed
Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager) Method called when the Business Entity Designer is starting and has loaded the plugin.
ToolClickHandler (Object, ToolClickEventArgs) Event handler for the ToolClick event of the UltraToolbarsManager of the Business Entity Designer


Method Detail
Top

AddIndexSelectionRow (character, character, logical, logical, logical)
Purpose: Creates a ttIndexSelection record for the given index
Notes: Builds the display name and image key for the index selection
dialog

Parameters:
pcIndexName CHARACTER
The name of the index
pcFieldNames CHARACTER
The comma-delimited list of the index field names
plPrimary LOGICAL
Logical value indicating if the index is the primary index
plUnique LOGICAL
Logical value indicating if the index is a unique index
plWordIndex LOGICAL
Logical value indicating if the index is a word index
Top

DesignCanvasContextMenuOpeningHandler (Object, DesignCanvasContextMenuOpeningEventArgs)
Purpose: Event handler for the DesignCanvasContextMenuOpening event of the
BusinessEntityDesignerForm
Notes: Enables the "Index Selection" context menu item when a single
temp-table is selected on the design canvas and the first source
database table has indexes that are not yet part of the
temp-table design

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.BusinessEntityDesigner.UI.DesignCanvasContextMenuOpeningEventArgs
The DesignCanvasContextMenuOpeningEventArgs with the data for this event
Top

LOGICAL HasMissingIndexes (character)
Purpose: Returns if the first source database table of the given
temp-table has indexes that are not yet part of the temp-table
design
Notes: Indexes are matched by their index name only

Parameters:
pcTempTableName CHARACTER
The name of the temp-table in the design
Returns LOGICAL
Logical value indicating if the first source database table has indexes that are missing from the temp-table design
Top

NewTempTableAddedHandler (Object, NewTempTableAddedEventArgs)
Purpose: Event handler for the NewTempTableAdded event of the BusinessEntityDatasetController
Notes:

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.BusinessEntityDesigner.Services.NewTempTableAddedEventArgs
The NewTempTableAddedEventArgs
Top

RunIndexSelection (character)
Purpose: Re-runs the index selection dialog for an existing temp-table
of the design
Notes: Offers only the indexes of the first source database table that
are not yet part of the temp-table design; the selected indexes
are added to the temp-table (SCL-5382)

Parameters:
pcTempTableName CHARACTER
The name of the temp-table in the design
Top

Shutdown ()
Purpose: Method called when the Business Entity Designer will get closed
Notes:

Top

Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager)
Purpose: Method called when the Business Entity Designer is starting and
has loaded the plugin.
Notes: Passes references to some key components of the Designer to
the plugin, use this to initialize the plugin, subscribe to events

Parameters:
dsBusinessEntity DATASET dsBusinessEntity
Business Entity with the Design dataset, called with the BIND keyword
poController Consultingwerk.BusinessEntityDesigner.Services.BusinessEntityDatasetController
The BusinessEntityDatasetController
poForm Consultingwerk.BusinessEntityDesigner.UI.BusinessEntityDesignerForm
The main Form of the BusinessEntityDesigner
poToolbar Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
The reference to the UltraToolbarsManager used by the BusinessEntityDesigner
Top

ToolClickHandler (Object, ToolClickEventArgs)
Purpose: Event handler for the ToolClick event of the UltraToolbarsManager
of the Business Entity Designer
Notes: Handles the click on the "Index Selection" context 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


ProDataset Detail

ProDataset dsBusinessEntity

Member tables: eBusinessEntity, eDataRelation, eDataRelationProperties, eTable, eField, eFieldProperties, eIndex, eIndexProperties, eTableProperties, eBusinessEntityProperties


Temp-Table Detail

Temp-Table eBusinessEntity

Defined in:

Temp-Table eBusinessEntityProperties

Defined in:

Temp-Table eDataRelation

Defined in:

Temp-Table eDataRelationProperties

Defined in:

Temp-Table eField

Defined in:

Temp-Table eFieldProperties

Defined in:

Temp-Table eIndex

Defined in:

Temp-Table eIndexProperties

Defined in:

Temp-Table eTable

Defined in:

Temp-Table eTableProperties

Defined in:


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       20.07.2026 16:01:25