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

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


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



Top Method Summary
Options Name Purpose
CHARACTER GetPackageNameFromFilePath (character) Returns the package name for a class file, derived from its folder relative to the source code base folder of the Business Entity Designer settings
ImportXmlDocument () Prompts for an XML document file and imports its data structure as temp-table definitions
ImportXmlDocument (character) Imports the data structure of the given XML document as temp-table definitions into the design
MergeImportedTables (XmlDocumentImporter, handle, character, character) Merges the tables and data-relations of the import result into the design
OfferReaderWriterGeneration (XmlDocumentImporter, character, character) Offers to generate an XML Reader/Writer class for the import result
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) Handles the ToolClick event of the Business Entity Designer's UltraToolbarsManager


Method Detail
Top

CHARACTER GetPackageNameFromFilePath (character)
Purpose: Returns the package name for a class file, derived from its
folder relative to the source code base folder of the
Business Entity Designer settings
Notes: Returns an empty character value when the file is not located
below the source code base folder (e.g. saved at the root of
another PROPATH entry, where a root package class is correct)

Parameters:
pcFileName CHARACTER
The fully qualified name of the class file
Returns CHARACTER
The package name
Top

ImportXmlDocument ()
Purpose: Prompts for an XML document file and imports its data structure
as temp-table definitions
Notes:

Top

ImportXmlDocument (character)
Purpose: Imports the data structure of the given XML document as
temp-table definitions into the design
Notes: The temp-tables derived by the XmlDocumentImporter are merged
into the design one by one through the CreateTempTable method
of the BusinessEntityDatasetController, followed by the
data-relations derived from the document structure

Parameters:
pcFileName CHARACTER
The name of the XML document file to import
Top

MergeImportedTables (XmlDocumentImporter, handle, character, character)
Purpose: Merges the tables and data-relations of the import result into
the design
Notes: Clears the design's table prefixes while merging, as the
imported table names already carry the prefix (following the
pattern of the TempTableImporter)

Parameters:
poImporter Consultingwerk.BusinessEntityDesigner.Services.XmlDocumentImporter
The XmlDocumentImporter holding the import result
phImportDataset HANDLE
The handle of the dsBusinessEntity dataset instance containing the import result
pcImportedNames CHARACTER
OUTPUT The comma-delimited list of the imported temp-table names
pcDesignNames CHARACTER
OUTPUT The comma-delimited list of the names the tables received in the design (? entries for cancelled tables)
Top

OfferReaderWriterGeneration (XmlDocumentImporter, character, character)
Purpose: Offers to generate an XML Reader/Writer class for the import
result
Notes: The generated class inherits XmlDocumentReaderWriter, reads
XML documents of the imported shape into the temp-tables and
writes them back into the original document shape. Reading
requires the generated class in both import modes, as the
native READ-XML method cannot re-establish the parent/child
association for documents that do not carry the key values

Parameters:
poImporter Consultingwerk.BusinessEntityDesigner.Services.XmlDocumentImporter
The XmlDocumentImporter holding the import result
pcImportedNames CHARACTER
The comma-delimited list of the imported temp-table names
pcDesignNames CHARACTER
The comma-delimited list of the names the tables received 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.UI.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: 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


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       19.09.2026 10:06:27