Namespace: Consultingwerk.BusinessEntityDesigner.Plugins
Class 
SmartDataObjectImporterPlugin Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implements: Consultingwerk.BusinessEntityDesigner.IBusinessEntityDesignerPlugin

File:SmartDataObjectImporterPlugin
Purpose:Business Entity Designer Plugin that supports to import an
ADM2 SmartDataObject into the Business Entity.
Description:Creates an "Import SDO" button to the Ribbon of the
Business Entity Designer. Using this Button developers
can import an SDO onto the Design Canvas. The import process
imports the fields of the SDO and the Data Source information
(query, source tables).
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Fri Sep 21 20:38:49 CEST 2012



Top Method Summary
Options Name Purpose
# CreateUniqueIndex (character, character) Creates a unique index and ensures that all index fields are part of the Business Entity
# CHARACTER GetPreprocessorDefinition (character, longchar) Searches the source code for a preprocessor definition
# ImportSDO () Shows the Wizzard to import an ADM2 SmartDataObject
+ ImportSDO (character) Imports an ADM2 SmartDataObject into the model
# ParseFieldSpecs (character, character, longchar) Parses the _QUERY-BLOCK for the field details
# RemoveSdoSupportFields (character) Removes the SDO support fields and indexes from the design
+ Shutdown () Shuts down the plugin
+ Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager) Initializes the plugin
# ToolClickHandler (Object, ToolClickEventArgs) Handles the ToolClick event of the Business Entity Designer's UltraToolbarsManager

Top Constructor Summary
Options Name Purpose
+ SmartDataObjectImporterPlugin () Constructor for the SmartDataObjectImporterPlugin class

Top Property Summary
Options Name Purpose
+ Consultingwerk.BusinessEntityDesigner.Services.BusinessEntityDatasetController Controller
+ System.Windows.Forms.Form Form


Method Detail
Top

PROTECTED CreateUniqueIndex (character, character)

Purpose: Creates a unique index and ensures that all index fields are part
of the Business Entity
Notes:

Parameters:
pcTableName CHARACTER
The name of the temp-table
pcIndexFields CHARACTER
The list of index fields
Top

PROTECTED CHARACTER GetPreprocessorDefinition (character, longchar)

Purpose: Searches the source code for a preprocessor definition
Notes:

Parameters:
pcPreprocessorName CHARACTER
The preprocessor variable to search for
plcSourceCode LONGCHAR
The whole source code
Returns CHARACTER
The value of the preprocessor name
Top

PROTECTED ImportSDO ()

Purpose: Shows the Wizzard to import an ADM2 SmartDataObject
Notes:

Top

PUBLIC ImportSDO (character)

Purpose: Imports an ADM2 SmartDataObject into the model
Notes:

Parameters:
pcSDO CHARACTER
The name of the SmartDataObject to import
Top

PROTECTED ParseFieldSpecs (character, character, longchar)

Purpose: Parses the _QUERY-BLOCK for the field details
Notes:

Parameters:
pcTableName CHARACTER
The name of the temp-table
pcQueryName CHARACTER
The name of the Query
plcSourceCode LONGCHAR
The source code block
Top

PROTECTED RemoveSdoSupportFields (character)

Purpose: Removes the SDO support fields and indexes from the design
Notes:

Parameters:
pcTableName CHARACTER
The name of the imported temp-table
Top

PUBLIC Shutdown ()

Purpose: Shuts down the plugin
Notes:

Top

PUBLIC Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager)

Purpose: Initializes the plugin
Notes:

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

PROTECTED ToolClickHandler (Object, ToolClickEventArgs)

Purpose: Handles the ToolClick event of the Business Entity Designer's
UltraToolbarsManager
Notes:

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


Constructor Detail
Top

PUBLIC SmartDataObjectImporterPlugin ()

Purpose: Constructor for the SmartDataObjectImporterPlugin class
Notes:



Property Detail
Top

PUBLIC Consultingwerk.BusinessEntityDesigner.Services.BusinessEntityDatasetController Controller


Returns Consultingwerk.BusinessEntityDesigner.Services.BusinessEntityDatasetController
Top

PUBLIC System.Windows.Forms.Form Form


Returns System.Windows.Forms.Form


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-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       29.06.2022 12:38:23