Namespace: Consultingwerk.BusinessEntityDesigner.Services
Class 
BusinessEntityDatasetController Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implements: Consultingwerk.SmartComponents.Interfaces.IDatasetController

File:BusinessEntityDatasetController
Purpose:Dataset Controller for the Business Entity Dataset
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Oct 13 20:03:46 CEST 2010

Consultingwerk.BusinessEntityDesigner.Services.BusinessEntityBusinessEntity
Consultingwerk.BusinessEntityDesigner.Services.BusinessEntityBusinessEntity



Top Method Summary
Options Name Purpose
# AddChildTables (UltraTreeNode, character, character) Addes the child tables to the current UltraTreeNode
+ CHARACTER AddExistingField (rowid, character, character, logical) Add's am existing database Field to a Temp-Table
+ AddExistingField (TempTableShape, character, character, logical) Add's am existing database Field to a Temp-Table
+ AddExistingField (TempTableShape, character, character, logical, logical) Add's am existing database Field to a Temp-Table
+ CHARACTER AddNewField (TempTableShape) Add's a new Field to a Temp-Table
+ AddNewIndex (TempTableShape) Add's a new Index to a Temp-Table
+ AddSourceTable (handle, character, Model) Adds another source table to an existing temp-table
# AfterUpdateBusinessEntityRecordHandler (Object, AfterUpdateRecordEventArgs) Event handler for the AfterUpdateRecord event of the eBusinessEntity Data Adapter
# AfterUpdateDataRelationRecordHandler (Object, AfterUpdateRecordEventArgs) Event handler for the AfterUpdateRecord event of the eRelation Data Adapter
# AfterUpdateFieldRecordHandler (Object, AfterUpdateRecordEventArgs) Event handler for the AfterUpdateRecord event of the eField Data Adapter
# AfterUpdateIndexRecordHandler (Object, AfterUpdateRecordEventArgs) Event handler for the AfterUpdateRecord event of the eIndex Data Adapter
# AfterUpdateTableRecordHandler (Object, AfterUpdateRecordEventArgs) Event handler for the AfterUpdateRecord event of the eTable Data Adapter
+ AssignTempTablePath (character) Assigns a path and package to all temp-tables that do not have a path or package assigned yet
- BeforeAssignRecordDataRelationHandler (Object, BeforeAssignRecordEventArgs) Event handler for the BeforeAssignRecord event handler of the DataRelation Temp-Table Adapter
- BeforeAssignRecordTableHandler (Object, BeforeAssignRecordEventArgs) Event handler for the BeforeAssignRecord event handler of the Table Temp-Table Adapter
+ CHARACTER BeforeTableName (character) Builds the name of the before table for the given temp-table
# BeforeUpdateBusinessEntityRecordHandler (Object, BeforeUpdateRecordEventArgs) Event handler for the BeforeUpdateRecord event of the eBusinessEntity Data Adapter
# BeforeUpdateFieldRecordHandler (Object, BeforeUpdateRecordEventArgs) Event handler for the BeforeUpdateRecord evnet of the eField Data Adapter
# LOGICAL BufferNameExists (character) Checks if a Buffer is already used as a SourceBufferName
# BuildTreeView () Populates the Tree View of the DATA-RELATION's
# CHARACTER BuildUniqueBufferName (character) Returns a unique buffer name for a table
+ CHARACTER BuildUniqueFieldName (character, character) Returns a unique name for a temp-table field
+ CHARACTER BuildUniqueIndexName (character, character) Returns an unique name for an index
+ CHARACTER BuildUniqueTableName (character) Returns an unique name for a temp-table
# BusinessEntityDesignerSettingsSettingsChangedHandler (Object, EventArgs) Event handler for the SettingsChanged event of the BusinessEntityDesignerSettings object
+ LOGICAL CompileSource () Compiles the source of the generated business entity
+ CreateDataRelation (Model, character, character) Creates a Data-Relation on the model
+ CreateDataRelation (Model, character, character, logical) Creates a Data-Relation on the model
+ CHARACTER CreateIndex (character, character, logical, logical) Creates an index in the temp-table, ensures that all index fields are part of the temp-table
+ CHARACTER CreateTempTable (character) Creates a new unmapped temp-table
+ CHARACTER CreateTempTable (Model, integer, integer) Creates a new unmapped temp-table
+ CHARACTER CreateTempTable (handle, Model, integer, integer) Creates a new temp-table in the design
+ CHARACTER CreateTempTable (handle, Model, integer, integer, logical, logical) Creates a new temp-table in the design
# DataRelationConnectorSelectedChangedHandler (Object, EventArgs) Event handler for the SelectedChanged event of the data relation connector instances
+ DeregisterConsumer (Object) Invoked by SmartBusinessEntityAdapter and SmartDatasetChildAdapter instances when detaching from the Dataset of the DatasetController. Allows event unsubscription etc.
# DeselectShapes () Deselectes all Shapes
+ DrawShapes () (Re)draws the Model
+ DrawShapes (Diagram) (Re)draws the Model
+ DuplicateTable (TempTableShape) Duplicates the given table
+ EditFields (character) Invokes the Field Editor Form
# CHARACTER EnsureUniqueFieldName (character, character, character) Creates a unqiue field name in a temp-table
# FieldEditorForm_BeforeDeleteRecord (Object, BeforeDeleteRecordEventArgs) Handler for the FieldEditorForm BeforeDeleteRecord event
# CHARACTER FieldSerializeName (character, character, character) Returns the serialize-name for a temp-table field
+ FieldsReorder (TempTableShape) Shows a dialog that allows the user to reorder the fields of the temp-table
# FillCustomProperties (CustomPropertiesScopeEnum) Stores the ttCustomProperties records for the given scope
+ LOGICAL GenerateSource () Generates the actual source code.
+ Consultingwerk.Framework.Collections.CharacterList GetCustomPropertyNames (CustomPropertiesScopeEnum) Returns the list of the custom property names for the given scope
+ Consultingwerk.Framework.Collections.CharacterList GetCustomPropertyValues (CustomPropertiesScopeEnum, character, character) Returns the list of possible values for the given property
+ CHARACTER GetDefaultFileName () Builds the default file name to save the .bedgm file to
+ CHARACTER GetDefaultFolderName () Returns the name of the folder representing the Business Entity Package
+ CHARACTER GetEntityPackageNameForTable (character) Provides package information for the Entity Class of a temp-table
- CHARACTER GetFilePath (character, character) Returns the filepath to a class given as package and classname
# CHARACTER GetIndexDataTypes (character, character) Returns a comma delimited list of data types of the index fields
# CHARACTER GetSourceBufferName (character, character, character) Raises the GetSourceBufferName event and returns the Source Buffer Name for the current database table
+ Consultingwerk.BusinessEntityDesigner.UI.Shapes.TempTableShape GetTableByKey (character) Returns the TempTableShape with the given key
+ LOGICAL HasActiveParentRelation (character) Returns TRUE if the given temp-table has an active parent data relation
+ LOGICAL HasParentRelation (character) Returns TRUE if the given temp-table has a parent data relation
+ LOGICAL HasSourceTable (TempTableShape, character) Determines if the given temp-table contains the database table as a source table
+ LOGICAL HasTableWithKey (character) Returns TRUE if the model already contains a Table with the given key
+ ImportTableFromFile (character) Imports Table(s) from the given source code file
+ ImportTableFromLongChar (longchar) Imports a code block (clip-board) as a temp-table into the model
- CHARACTER InitializeExistingField (character, character, character, character, logical) Add's am existing database Field to a Temp-Table
+ LOGICAL IsExtentField (character) Returns TRUE when the field with the given Tag is an Extend field
- MoveFile (character, character) Moves a file from a path to another path
- MoveIncludeFile (character, character, character) Moves an include file
- MoveIncludeFile (character, character, character, table) Moves an include file
+ LOGICAL New () Creates a new Business Entity Design
+ LOGICAL New (Model) Creates a new Business Entity Design
# OnAfterCompileSource (EventArgs) Raises the AfterCompileSource event
# OnAfterFileNew (EventArgs) Raises the AfterFileNew event
# OnAfterFileOpen (FileEventArgs) Raises the AfterFileOpen event
# OnAfterFileSave (FileEventArgs) Raises the AfterFileSave event
# OnAfterGenerateSource (EventArgs) Raises the AfterGenerateSource event
# OnAfterRegenerateSource (EventArgs) Raises the AfterRegenerateSource event
# OnBeforeAddingFieldToNewTable (BeforeAddingFieldToNewTableEventArgs) Raises the BeforeAddingFieldToNewTable
# OnBeforeAddingIndexToNewTable (BeforeAddingIndexToNewTableEventArgs) Raises the BeforeAddingIndexToNewTable
# OnBeforeCompileSource (CancelableEventArgs) Raises the BeforeCompileSource event
# OnBeforeFileNew (CancelableEventArgs) Raises the BeforeFileNew event
# OnBeforeFileOpen (CancelableFileEventArgs) Raises the BeforeFileOpen event
# OnBeforeFileSave (CancelableFileEventArgs) Raises the BeforeFileSave event
# OnBeforeGenerateSource (CancelableEventArgs) Raises the BeforeGenerateSource event
# OnBeforeRegenerateSource (CancelableEventArgs) Raises the BeforeRegenerateSource event
# OnClassRenamedMoved (ClassRenamedMovedEventArgs) Raises the RenameMove event
# OnCustomPropertiesUpdated (CustomPropertiesUpdatedEventArgs) Raises the CustomPropertiesUpdated
# OnGetCustomPropertyNames (GetCustomPropertyNamesEventArgs) Raises the GetCustomPropertyNames
# OnGetCustomPropertyValues (GetCustomPropertyValuesEventArgs) Raises the GetCustomPropertyValues
# OnGetSourceBufferName (GetSourceBufferNameEventArgs) Raises the GetSourceBufferName event
# OnNewTempTableAdded (NewTempTableAddedEventArgs) Raises the NewTempTableAdded
# OnTableItemSelected (EventArgs) Raises the TableItemSelected
# OnUnsavedChangesChanged (EventArgs) Raises the UnsavedChangesChanged event
# OnValidateDesign (EventArgs) Raises the ValidateDesign
+ LOGICAL Open (character, Model) Opens an existing Business Entity Design
# PrepareCustomPropertiesScope (CustomPropertiesScopeEnum, handle, handle) Prepares the query for accessing the ttCustomProperties records for the given scope
+ Refresh () Refreshes the Model on the Screen
+ RefreshAllTempTablesFromInclude () Refreshes all Temp-Table definitions from the include file
+ CHARACTER RefreshTable (TempTableShape, DatabaseSchemaDatasetController) Updates a temp-table from the database schema
+ CHARACTER RefreshTableFromInclude (TempTableShape) Refreshes a Temp-Table definition from the include file
+ LOGICAL RegenerateSource () ReGenerates source code
+ RegisterConsumer (Object) Invoked by SmartBusinessEntityAdapter and SmartDatasetChildAdapter instances when attaching to the Dataset of the DatasetController. Allows event subscription etc.
# CHARACTER RemoveInvalidXmlCharacters (character) Converts a temp-table field name to an XML Field name
+ RemoveRelation (Model, DataRelationConnector) Removes a Data-Relation from the Design
# RemoveSelectedField (TempTableShape) Removes the currently selected field of the selected table
# RemoveSelectedIndex (TempTableShape) Removes the currently selected index of the selected table
+ RemoveTable (Model, TempTableShape) Removes a Table from the Model
+ RenameFieldInIndexes (character, character, character) Renames a field in any index
+ CHARACTER RenameMove () Shows a RenameMoveDialog and applies the chosen operations
+ RenameTable (character, character) Renames the temp-table
# ReorderFields (character) Reorders the fields in the named temp-table
# ReorderIndexes (character) Reorders the indexes in the named temp-table
# RestoreRecordPosition () Restored a previously saved record position
+ LOGICAL Save (character) Saves the current Business Entity Design
+ CHARACTER ShortTableName (character) Returns a shortened table name, without the DB part, when present
# ShowLog (character) Displays a string with log information
# SmartTableIOStateChangedHandler (Object, SmartTableIOStateChangedEventArgs) Event handler for the SmartTableIOStateChanged event of the five property viewers in the Business Entity Designer
+ SplitExtentField (character, character) Splits an Extent field into multiple individual fields
# StoreCustomProperties (CustomPropertiesScopeEnum) Stores the ttCustomProperties records for the given scope
# StoreRecordPosition () Stores the current record position
# StoreTablePosition () Stores the position on the design canvas for each table.
# TableSelectedItemChangedHandler (Object, EventArgs) Event handler for the SelectedItemChanged event of the TempTableShapes
# TableShapeSelectedChangedHandler (Object, EventArgs) Event handler for the SelectedChanged event of the TempTableShapes
+ UpdateCustomProperties (CustomPropertiesScopeEnum, character) Updates the custom properties for the currently selected object of the given scope
+ UpdateDataRelationFields () Uses DataRelationFieldPickerForm to update the fields of a DATA-RELATION
+ ValidateDesign () Validates the deisgn
+ LOGICAL VerifyModified (character) Verifies if the model has changes

Top Constructor Summary
Options Name Purpose
+ BusinessEntityDatasetController () Default Constructor of the BusinessEntityDatasetController class

Top Event Summary
Options Name Purpose
+ AfterCompileSource (Object, EventArgs) Event raised after the source code has been compiled
+ AfterFileNew (Object, EventArgs) Event raised after a new file is created
+ AfterFileOpen (Object, FileEventArgs) Event raised after a file is opened
+ AfterFileSave (Object, FileEventArgs) Event raised after a file is opened
+ AfterGenerateSource (Object, EventArgs) Event raised after the source code is generated
+ AfterRegenerateSource (Object, EventArgs) Event raised after the source code is re-generated
+ BeforeAddingFieldToNewTable (Object, BeforeAddingFieldToNewTableEventArgs) Raised for every field while adding a new Database Table to the design canvas
+ BeforeAddingIndexToNewTable (Object, BeforeAddingIndexToNewTableEventArgs) Raised for every Index while adding a new Database Table to the design canvas
+ BeforeCompileSource (Object, CancelableEventArgs) Event raised before the source code has been compiled
+ BeforeFileNew (Object, CancelableEventArgs) Event raised before a new file is created
+ BeforeFileOpen (Object, CancelableFileEventArgs) Event raised before a file is opened
+ BeforeFileSave (Object, CancelableFileEventArgs) Event raised before a file is opened
+ BeforeGenerateSource (Object, CancelableEventArgs) Event raised before the source code is generated
+ BeforeRegenerateSource (Object, CancelableEventArgs) Event raised before the source code is re-generated
+ ClassRenamedMoved (Object, ClassRenamedMovedEventArgs) Raised after a Rename/Move operation to allow plugins to make the same changes
+ CustomPropertiesUpdated (Object, CustomPropertiesUpdatedEventArgs) Raised when the custom properties have been updated
+ GetCustomPropertyNames (Object, GetCustomPropertyNamesEventArgs) Raised to allow plugins to return names of available custom property names
+ GetCustomPropertyValues (Object, GetCustomPropertyValuesEventArgs) Raised to allow plugins to return possible values for custom properties
+ GetSourceBufferName (Object, GetSourceBufferNameEventArgs) Raised to allow customization of the Source Buffer Name
+ NewTempTableAdded (Object, NewTempTableAddedEventArgs) Raised when a new temp-table is added to the design
+ TableItemSelected (Object, EventArgs) Raised an item in a Table Shape is selected
+ UnsavedChangesChanged (Object, EventArgs) Event raised when the UnsavedChanges property changes
+ ValidateDesign (Object, EventArgs) Raised to validate the current design

Top Property Summary
Options Name Purpose
+ Consultingwerk.SmartComponents.Base.SmartViewerControl BusinessEntityViewerControl
+ Consultingwerk.SmartComponents.Base.SmartViewerControl DataRelationViewerControl
+ HANDLE DatasetHandle
+ Crainiate.Diagramming.Forms.Diagram Diagram
+ Infragistics.Win.UltraWinDock.UltraDockManager DockManager
+ Consultingwerk.SmartComponents.Base.SmartViewerControl FieldViewerControl
+ Consultingwerk.SmartComponents.Base.SmartViewerControl IndexViewerControl
+ Crainiate.Diagramming.Model Model
+ Consultingwerk.Framework.IServiceContainer ServiceContainer
+ LOGICAL SuppressQuestionAboutDefaultPackage
+ Consultingwerk.SmartComponents.Base.SmartViewerControl TableViewerControl
+ Infragistics.Win.UltraWinTree.UltraTree TreeView
+ LOGICAL UnsavedChanges


Method Detail
Top

PROTECTED AddChildTables (UltraTreeNode, character, character)

Purpose: Addes the child tables to the current UltraTreeNode
Notes:

Parameters:
poNode Infragistics.Win.UltraWinTree.UltraTreeNode
The UltraTreeNode to add the child tables to
pcBusinessEntityName CHARACTER
The name of the Business Entity
pcTableName CHARACTER
The name of the current temp-table
Top

PUBLIC CHARACTER AddExistingField (rowid, character, character, logical)

Purpose: Add's am existing database Field to a Temp-Table
Notes: Variant of this method without reference to the Business Entity Designer
UI and Model, usable in wizards

Parameters:
proTableRowid ROWID
The ROWID of the temp-table to add the field to
pcFieldName CHARACTER
The name of the field
pcFieldProperties CHARACTER
The CHR(1) delimited list of field properties
plKeepSourceInformation LOGICAL
Logical field indicating if the source information should be kept
Returns CHARACTER
The name of the field that was created
Top

PUBLIC AddExistingField (TempTableShape, character, character, logical)

Purpose: Add's am existing database Field to a Temp-Table
Notes: Defaults not to add the missing source table

Parameters:
poTable Consultingwerk.BusinessEntityDesigner.UI.Shapes.TempTableShape
The reference to the TempTableShape
pcFieldName CHARACTER
The name of the field
pcFieldProperties CHARACTER
The CHR(1) delimited list of field properties
plKeepSourceInformation LOGICAL
Logical field indicating if the source information should be kept
Top

PUBLIC AddExistingField (TempTableShape, character, character, logical, logical)

Purpose: Add's am existing database Field to a Temp-Table
Notes:

Parameters:
poTable Consultingwerk.BusinessEntityDesigner.UI.Shapes.TempTableShape
The reference to the TempTableShape
pcFieldName CHARACTER
The name of the field
pcFieldProperties CHARACTER
The CHR(1) delimited list of field properties
plKeepSourceInformation LOGICAL
Logical field indicating if the source information should be kept
plAddSourceTable LOGICAL
Logical value indicating if a missing source table shoudl be added to the temp-table
Top

PUBLIC CHARACTER AddNewField (TempTableShape)

Purpose: Add's a new Field to a Temp-Table
Notes:

Parameters:
poTable Consultingwerk.BusinessEntityDesigner.UI.Shapes.TempTableShape
The TempTableShape that is currently selected
Returns CHARACTER
The name of the new field
Top

PUBLIC AddNewIndex (TempTableShape)

Purpose: Add's a new Index to a Temp-Table
Notes:

Parameters:
poTable Consultingwerk.BusinessEntityDesigner.UI.Shapes.TempTableShape
The reference to the TempTableShape to add the Index to
Top

PUBLIC AddSourceTable (handle, character, Model)

Purpose: Adds another source table to an existing temp-table
Notes:

Parameters:
phDataset HANDLE
The HANDLE of the Dataset
pcTempTableKey CHARACTER
The key of the temp-table to add the source table to
poModel Crainiate.Diagramming.Model
The reference to the Crainiate Model component
Top

PROTECTED AfterUpdateBusinessEntityRecordHandler (Object, AfterUpdateRecordEventArgs)

Purpose: Event handler for the AfterUpdateRecord event of the eBusinessEntity
Data Adapter
Notes:

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

PROTECTED AfterUpdateDataRelationRecordHandler (Object, AfterUpdateRecordEventArgs)

Purpose: Event handler for the AfterUpdateRecord event of the eRelation
Data Adapter
Notes:

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

PROTECTED AfterUpdateFieldRecordHandler (Object, AfterUpdateRecordEventArgs)

Purpose: Event handler for the AfterUpdateRecord event of the eField Data Adapter
Notes:

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

PROTECTED AfterUpdateIndexRecordHandler (Object, AfterUpdateRecordEventArgs)

Purpose: Event handler for the AfterUpdateRecord event of the eIndex Data Adapter
Notes:

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

PROTECTED AfterUpdateTableRecordHandler (Object, AfterUpdateRecordEventArgs)

Purpose: Event handler for the AfterUpdateRecord event of the eTable Data Adapter
Notes:

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

PUBLIC AssignTempTablePath (character)

Purpose: Assigns a path and package to all temp-tables that do not have a
path or package assigned yet
Notes: Allows customers that implement their own packages to use the same
code that is executed at the "Use the default temp-table path for
all existing temp-tables that have no path?" prompt in the Visual
Designer

Parameters:
pcTempTablePath CHARACTER
The path to assign to all temp-tables that don't have a path
Top

PRIVATE BeforeAssignRecordDataRelationHandler (Object, BeforeAssignRecordEventArgs)

Purpose: Event handler for the BeforeAssignRecord event handler of the DataRelation
Temp-Table Adapter
Notes:

Parameters:
sender System.Object
The object that raised the BeforeAssignRecord event
e Consultingwerk.SmartComponents.Implementation.BeforeAssignRecordEventArgs
The BeforeAssignRecordEventArgs with the data for the event
Top

PRIVATE BeforeAssignRecordTableHandler (Object, BeforeAssignRecordEventArgs)

Purpose: Event handler for the BeforeAssignRecord event handler of the Table
Temp-Table Adapter
Notes:

Parameters:
sender System.Object
The object that raised the BeforeAssignRecord event
e Consultingwerk.SmartComponents.Implementation.BeforeAssignRecordEventArgs
The BeforeAssignRecordEventArgs with the data for the event
Top

PUBLIC CHARACTER BeforeTableName (character)

Purpose: Builds the name of the before table for the given temp-table
Notes:

Parameters:
pcTableName CHARACTER
Builds the Before Table Name from the Temp Table Name
Returns CHARACTER
The before table name
Top

PROTECTED BeforeUpdateBusinessEntityRecordHandler (Object, BeforeUpdateRecordEventArgs)

Purpose: Event handler for the BeforeUpdateRecord event of the eBusinessEntity
Data Adapter
Notes:

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

PROTECTED BeforeUpdateFieldRecordHandler (Object, BeforeUpdateRecordEventArgs)

Purpose: Event handler for the BeforeUpdateRecord evnet of the eField Data Adapter
Notes:

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

PROTECTED LOGICAL BufferNameExists (character)

Purpose: Checks if a Buffer is already used as a SourceBufferName
Notes: Used by BuildUniqueBufferName

Parameters:
pcBufferName CHARACTER
The buffer name to test
Returns LOGICAL
Logical value indicating if the buffer name does already exist
Top

PROTECTED BuildTreeView ()

Purpose: Populates the Tree View of the DATA-RELATION's
Notes:

Top

PROTECTED CHARACTER BuildUniqueBufferName (character)

Purpose: Returns a unique buffer name for a table
Notes: Returns either the default buffer name (EQ table name)
of a buffer name in the form of bn_tablename where n
starts at 1

Parameters:
pcSourceTableName CHARACTER
The name of the source table
Returns CHARACTER
The unique buffer name
Top

PUBLIC CHARACTER BuildUniqueFieldName (character, character)

Purpose: Returns a unique name for a temp-table field
Notes:

Parameters:
pcTableName CHARACTER
The name of the temp-table
pcFieldName CHARACTER
The name of the field
Returns CHARACTER
The unique name for the temp-table field
Top

PUBLIC CHARACTER BuildUniqueIndexName (character, character)

Purpose: Returns an unique name for an index
Notes:

Parameters:
pcTableName CHARACTER
The name of the temp-table
pcIndexName CHARACTER
The proposed name of the index
Returns CHARACTER
The unique index name
Top

PUBLIC CHARACTER BuildUniqueTableName (character)

Purpose: Returns an unique name for a temp-table
Notes:

Parameters:
pcTableName CHARACTER
The proposed name of the temp-table
Returns CHARACTER
The unique name of the temp-table
Top

PROTECTED BusinessEntityDesignerSettingsSettingsChangedHandler (Object, EventArgs)

Purpose: Event handler for the SettingsChanged event of the BusinessEntityDesignerSettings
object
Notes:

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

PUBLIC LOGICAL CompileSource ()

Purpose: Compiles the source of the generated business entity
Notes:

Returns LOGICAL
Logical value indicating if the compilation was successful
Top

PUBLIC CreateDataRelation (Model, character, character)

Purpose: Creates a Data-Relation on the model
Notes:

Parameters:
poModel Crainiate.Diagramming.Model
The reference to the Crainiate ERM4 Model
pcParentTable CHARACTER
The name of the parent temp-table
pcChildTable CHARACTER
The name of the child temp-table
Top

PUBLIC CreateDataRelation (Model, character, character, logical)

Purpose: Creates a Data-Relation on the model
Notes:

Parameters:
poModel Crainiate.Diagramming.Model
The reference to the Crainiate ERM4 Model
pcParentTable CHARACTER
The name of the parent temp-table
pcChildTable CHARACTER
The name of the child temp-table
plActive LOGICAL
ACTIVE Flag of the new data-relation
Top

PUBLIC CHARACTER CreateIndex (character, character, logical, logical)

Purpose: Creates an index in the temp-table, ensures that all index fields
are part of the temp-table
Notes: When fields are provided as table.field the field will be interpreted
as a DB field and a temp-table field will be added when the field is not
yet part of the temp-table

Parameters:
pcTempTableName CHARACTER
The name of the temp-table to add the index
pcFieldNames CHARACTER
The names of the fields to add the index
plUnique LOGICAL
Create the index as unique
plPrimary LOGICAL
Create the index as primary
Returns CHARACTER
The name of the created index
Top

PUBLIC CHARACTER CreateTempTable (character)

Purpose: Creates a new unmapped temp-table
Notes: Used for custom wizards

Parameters:
pcTableName CHARACTER
The name of the temp-table to create
Returns CHARACTER
The generated temp-table name
Top

PUBLIC CHARACTER CreateTempTable (Model, integer, integer)

Purpose: Creates a new unmapped temp-table
Notes: Custom -> TempTable from the Designer Toolbox

Parameters:
poModel Crainiate.Diagramming.Model
The reference to the Crainiate ERM4 Model control
piX INTEGER
The X location of the new table on the design canvas
piY INTEGER
The Y location of the new table on the design canvas
Returns CHARACTER
The generated temp-table name
Top

PUBLIC CHARACTER CreateTempTable (handle, Model, integer, integer)

Purpose: Creates a new temp-table in the design
Notes: phDataset contains a Dataset containing the source table schema

Parameters:
phDataset HANDLE
An instance of the dsBusinessEntity Dataset that contains the new table to be created
poModel Crainiate.Diagramming.Model
The reference to the Crainiate ERM4 Model control
piX INTEGER
The X location of the new table on the design canvas
piY INTEGER
The Y location of the new table on the design canvas
Returns CHARACTER
The generated temp-table name
Top

PUBLIC CHARACTER CreateTempTable (handle, Model, integer, integer, logical, logical)

Purpose: Creates a new temp-table in the design
Notes: phDataset contains a Dataset containing the source table schema

Parameters:
phDataset HANDLE
An instance of the dsBusinessEntity Dataset that contains the new table to be created
poModel Crainiate.Diagramming.Model
The reference to the Crainiate ERM4 Model control
piX INTEGER
The X location of the new table on the design canvas
piY INTEGER
The Y location of the new table on the design canvas
plUseFieldNameService LOGICAL
Logical value indicating if the IFieldNameGeneratorService should be used for naming fields
plBuildSourceFieldName LOGICAL
Logical value indicating if the source field name should be built/assigned
Returns CHARACTER
The generated temp-table name
Top

PROTECTED DataRelationConnectorSelectedChangedHandler (Object, EventArgs)

Purpose: Event handler for the SelectedChanged event of the data relation
connector instances
Notes:

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

PUBLIC DeregisterConsumer (Object)

Purpose: Invoked by SmartBusinessEntityAdapter and SmartDatasetChildAdapter
instances when detaching from the Dataset of the DatasetController.
Allows event unsubscription etc.
Notes: Interface IDatasetController member

Parameters:
poConsumer Progress.Lang.Object
The reference of the Object detaching from the Dataset Controller
Top

PROTECTED DeselectShapes ()

Purpose: Deselectes all Shapes
Notes:

Top

PUBLIC DrawShapes ()

Purpose: (Re)draws the Model
Notes:

Top

PUBLIC DrawShapes (Diagram)

Purpose: (Re)draws the Model
Notes:

Parameters:
poDiagram Crainiate.Diagramming.Forms.Diagram
The reference to the Crainiate diagram instance
Top

PUBLIC DuplicateTable (TempTableShape)

Purpose: Duplicates the given table
Notes:

Parameters:
poTable Consultingwerk.BusinessEntityDesigner.UI.Shapes.TempTableShape
as TempTableShape
Top

PUBLIC EditFields (character)

Purpose: Invokes the Field Editor Form
Notes:

Parameters:
pcTableName CHARACTER
The name of the selected table
Top

PROTECTED CHARACTER EnsureUniqueFieldName (character, character, character)

Purpose: Creates a unqiue field name in a temp-table
Notes:

Parameters:
pcBusinessEntityName CHARACTER
The name of the Business Entity
pcTempTableName CHARACTER
The name of the Temp Table
pcFieldName CHARACTER
The base name of the Field
Returns CHARACTER
The Unique field name
Top

PROTECTED FieldEditorForm_BeforeDeleteRecord (Object, BeforeDeleteRecordEventArgs)

Purpose: Handler for the FieldEditorForm BeforeDeleteRecord event
Notes:

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

PROTECTED CHARACTER FieldSerializeName (character, character, character)

Purpose: Returns the serialize-name for a temp-table field
Notes:

Parameters:
pcDatabaseTableName CHARACTER
The name of the database table
pcDatabaseFieldName CHARACTER
The name of the field
pcTempTableName CHARACTER
The name of the temp-table the field is added to
Returns CHARACTER
The serialize-name for the temp-table field
Top

PUBLIC FieldsReorder (TempTableShape)

Purpose: Shows a dialog that allows the user to reorder the fields of the
temp-table
Notes:

Parameters:
poTable Consultingwerk.BusinessEntityDesigner.UI.Shapes.TempTableShape
The TempTableShape representing the TempTable
Top

PROTECTED FillCustomProperties (CustomPropertiesScopeEnum)

Purpose: Stores the ttCustomProperties records for the given scope
Notes:

Parameters:
poCustomPropertiesScope Consultingwerk.BusinessEntityDesigner.Services.CustomPropertiesScopeEnum
The property scope to edit the custom properties for
Top

PUBLIC LOGICAL GenerateSource ()

Purpose: Generates the actual source code.
Notes:

Returns LOGICAL
Logical value indicating if the code generation was successful
Top

PUBLIC Consultingwerk.Framework.Collections.CharacterList GetCustomPropertyNames (CustomPropertiesScopeEnum)

Purpose: Returns the list of the custom property names for the given scope
Notes:

Parameters:
poCustomPropertiesScope Consultingwerk.BusinessEntityDesigner.Services.CustomPropertiesScopeEnum
The property scope to edit the custom properties for
Returns Consultingwerk.Framework.Collections.CharacterList
The CharacterList with the custom property names
Top

PUBLIC Consultingwerk.Framework.Collections.CharacterList GetCustomPropertyValues (CustomPropertiesScopeEnum, character, character)

Purpose: Returns the list of possible values for the given property
Notes:

Parameters:
poCustomPropertiesScope Consultingwerk.BusinessEntityDesigner.Services.CustomPropertiesScopeEnum
The property scope to edit the custom properties for
pcCustomPropertiesScopeName CHARACTER
The name of the custom properties scope
pcPropertyName CHARACTER
The name of the property to return possible values for
Returns Consultingwerk.Framework.Collections.CharacterList
The CharacterList with the custom property names
Top

PUBLIC CHARACTER GetDefaultFileName ()

Purpose: Builds the default file name to save the .bedgm file to
Notes:

Returns CHARACTER
The default file name for the .bedgm file
Top

PUBLIC CHARACTER GetDefaultFolderName ()

Purpose: Returns the name of the folder representing the Business Entity Package
Notes:

Returns CHARACTER
The name the the folder
Top

PUBLIC CHARACTER GetEntityPackageNameForTable (character)

Purpose: Provides package information for the Entity Class of a temp-table
Notes: Calls into the current Consultingwerk.BusinessEntityDesigner.Plugins.CustomServices.IEntityPackageNameProvider
service or returns the Business Entity Package

Parameters:
pcTempTableName CHARACTER
The name of the new temp-table
Returns CHARACTER
The Entity Package name
Top

PRIVATE CHARACTER GetFilePath (character, character)

Purpose: Returns the filepath to a class given as package and classname
Notes:

Parameters:
pcPackage CHARACTER
The class' package
pcClass CHARACTER
The class' name
Returns CHARACTER
The class' filepath
Top

PROTECTED CHARACTER GetIndexDataTypes (character, character)

Purpose: Returns a comma delimited list of data types of the index fields
Notes:

Parameters:
pcTableName CHARACTER
The name of the temp-table
pcIndexFields CHARACTER
The comma delimited list of field names
Returns CHARACTER
The comma delimited list of data types
Top

PROTECTED CHARACTER GetSourceBufferName (character, character, character)

Purpose: Raises the GetSourceBufferName event and returns the Source Buffer Name for the current database table
Notes:

Parameters:
pcDatabaseTableName CHARACTER
The name of the database table
pcTempTableName CHARACTER
The name of the temp-table
pcSourceBufferName CHARACTER
The name of the source buffer
Returns CHARACTER
The Source Buffer Name
Top

PUBLIC Consultingwerk.BusinessEntityDesigner.UI.Shapes.TempTableShape GetTableByKey (character)

Purpose: Returns the TempTableShape with the given key
Notes:

Parameters:
pcKey CHARACTER
The key (eTable ROWID) to locate
Returns Consultingwerk.BusinessEntityDesigner.UI.Shapes.TempTableShape
The TempTableShape with the given key
Top

PUBLIC LOGICAL HasActiveParentRelation (character)

Purpose: Returns TRUE if the given temp-table has an active parent data relation
Notes: Used for validation when adding a new parent relation to a temp-table
(timer1_Tick in BusinessEntityDesignerForm)

Parameters:
pcTempTable CHARACTER
The Name of the Temp-Table to check for parent relations
Returns LOGICAL
Logical value indicating if the temp-table has an active parent relation
Top

PUBLIC LOGICAL HasParentRelation (character)

Purpose: Returns TRUE if the given temp-table has a parent data relation
Notes: Used for validation when adding a new parent relation to a temp-table
(timer1_Tick in BusinessEntityDesignerForm)

Parameters:
pcTempTable CHARACTER
The Name of the Temp-Table to check for parent relations
Returns LOGICAL
Logical value indicating if the temp-table has a parent relation
Top

PUBLIC LOGICAL HasSourceTable (TempTableShape, character)

Purpose: Determines if the given temp-table contains the
database table as a source table
Notes:

Parameters:
poTable Consultingwerk.BusinessEntityDesigner.UI.Shapes.TempTableShape
The reference to the TempTableShape
pcSourceTable CHARACTER
The source table to test for
Returns LOGICAL
Logical value indicating if the temp-table contains the given database table as a source table
Top

PUBLIC LOGICAL HasTableWithKey (character)

Purpose: Returns TRUE if the model already contains a Table with the given key
Notes:

Parameters:
pcKey CHARACTER
The key (eTable ROWID) to locate
Returns LOGICAL
LOGICAL value indicating if the Model already has a table with the given key
Top

PUBLIC ImportTableFromFile (character)

Purpose: Imports Table(s) from the given source code file
Notes:

Parameters:
pcFileName CHARACTER
The file name to import
Top

PUBLIC ImportTableFromLongChar (longchar)

Purpose: Imports a code block (clip-board) as a temp-table into the model
Notes:

Parameters:
plcCodeBlock LONGCHAR
The Code Block to import
Top

PRIVATE CHARACTER InitializeExistingField (character, character, character, character, logical)

Purpose: Add's am existing database Field to a Temp-Table
Notes: Used by AddExistingField

Parameters:
pcBusinessEntityName CHARACTER
The name of the Business Entity
pcTempTableName CHARACTER
The name of the temp table
pcFieldName CHARACTER
The name of the field
pcFieldProperties CHARACTER
The CHR(1) delimited list of field properties
plKeepSourceInformation LOGICAL
Logical field indicating if the source information should be kept
Returns CHARACTER
The name of the new field
Top

PUBLIC LOGICAL IsExtentField (character)

Purpose: Returns TRUE when the field with the given Tag is an Extend field
Notes: If the field cannot be found, no error is trown and FALSE is returned

Parameters:
pcFieldKey CHARACTER
The field's Tag
Returns LOGICAL
Logical value indicating if the field is an array field
Top

PRIVATE MoveFile (character, character)

Purpose: Moves a file from a path to another path
Notes:

Parameters:
pcOldFilepath CHARACTER
The files old path
pcNewFilepath CHARACTER
The files new path
Top

PRIVATE MoveIncludeFile (character, character, character)

Purpose: Moves an include file
Notes:

Parameters:
pcOldPath CHARACTER
The old path to the file
pcNewPath CHARACTER
The new path to the file
pcFilename CHARACTER
The files name without extension
Top

PRIVATE MoveIncludeFile (character, character, character, table)

Purpose: Moves an include file
Notes:

Parameters:
pcOldPath CHARACTER
The old path to the file
pcNewPath CHARACTER
The new path to the file
pcFilename CHARACTER
The files name without extension
ttFileMovement TEMP-TABLE ttFileMovement
Temp-Table to add the movemeni to
Top

PUBLIC LOGICAL New ()

Purpose: Creates a new Business Entity Design
Notes: Variant for use in wizards outside of the Business Entity Designer

Returns LOGICAL
Logical value indicating if a new design was created
Top

PUBLIC LOGICAL New (Model)

Purpose: Creates a new Business Entity Design
Notes:

Parameters:
poModel Crainiate.Diagramming.Model
The reference to the Crainiate ERM4 Model
Returns LOGICAL
Logical value indicating if a new design was created
Top

PROTECTED OnAfterCompileSource (EventArgs)

Purpose: Raises the AfterCompileSource event
Notes:

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

PROTECTED OnAfterFileNew (EventArgs)

Purpose: Raises the AfterFileNew event
Notes:

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

PROTECTED OnAfterFileOpen (FileEventArgs)

Purpose: Raises the AfterFileOpen event
Notes:

Parameters:
e Consultingwerk.BusinessEntityDesigner.Services.FileEventArgs
The FileEventArgs with the data for this event
Top

PROTECTED OnAfterFileSave (FileEventArgs)

Purpose: Raises the AfterFileSave event
Notes:

Parameters:
e Consultingwerk.BusinessEntityDesigner.Services.FileEventArgs
The FileEventArgs with the data for this event
Top

PROTECTED OnAfterGenerateSource (EventArgs)

Purpose: Raises the AfterGenerateSource event
Notes:

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

PROTECTED OnAfterRegenerateSource (EventArgs)

Purpose: Raises the AfterRegenerateSource event
Notes:

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

PROTECTED OnBeforeAddingFieldToNewTable (BeforeAddingFieldToNewTableEventArgs)

Purpose: Raises the BeforeAddingFieldToNewTable
Notes:

Parameters:
e Consultingwerk.BusinessEntityDesigner.BeforeAddingFieldToNewTableEventArgs
The BeforeAddingFieldToNewTableEventArgs with the data for the event
Top

PROTECTED OnBeforeAddingIndexToNewTable (BeforeAddingIndexToNewTableEventArgs)

Purpose: Raises the BeforeAddingIndexToNewTable
Notes:

Parameters:
e Consultingwerk.BusinessEntityDesigner.BeforeAddingIndexToNewTableEventArgs
The BeforeAddingIndexToNewTableEventArgs with the data for the event
Top

PROTECTED OnBeforeCompileSource (CancelableEventArgs)

Purpose: Raises the BeforeCompileSource event
Notes:

Parameters:
e Consultingwerk.CancelableEventArgs
The Consultingwerk.CancelableEventArgs with the data for this event
Top

PROTECTED OnBeforeFileNew (CancelableEventArgs)

Purpose: Raises the BeforeFileNew event
Notes:

Parameters:
e Consultingwerk.CancelableEventArgs
The Consultingwerk.CancelableEventArgs with the data for this event
Top

PROTECTED OnBeforeFileOpen (CancelableFileEventArgs)

Purpose: Raises the BeforeFileOpen event
Notes:

Parameters:
e Consultingwerk.BusinessEntityDesigner.Services.CancelableFileEventArgs
The Consultingwerk.CancelableEventArgs with the data for this event
Top

PROTECTED OnBeforeFileSave (CancelableFileEventArgs)

Purpose: Raises the BeforeFileSave event
Notes:

Parameters:
e Consultingwerk.BusinessEntityDesigner.Services.CancelableFileEventArgs
The Consultingwerk.CancelableEventArgs with the data for this event
Top

PROTECTED OnBeforeGenerateSource (CancelableEventArgs)

Purpose: Raises the BeforeGenerateSource event
Notes:

Parameters:
e Consultingwerk.CancelableEventArgs
The Consultingwerk.CancelableEventArgs with the data for this event
Top

PROTECTED OnBeforeRegenerateSource (CancelableEventArgs)

Purpose: Raises the BeforeRegenerateSource event
Notes:

Parameters:
e Consultingwerk.CancelableEventArgs
The Consultingwerk.CancelableEventArgs with the data for this event
Top

PROTECTED OnClassRenamedMoved (ClassRenamedMovedEventArgs)

Purpose: Raises the RenameMove event
Notes:

Parameters:
e Consultingwerk.BusinessEntityDesigner.Services.ClassRenamedMovedEventArgs
The ClassRenamedMovedEventArgs with the data for the event
Top

PROTECTED OnCustomPropertiesUpdated (CustomPropertiesUpdatedEventArgs)

Purpose: Raises the CustomPropertiesUpdated
Notes:

Parameters:
e Consultingwerk.BusinessEntityDesigner.Services.CustomPropertiesUpdatedEventArgs
The CustomPropertiesUpdatedEventArgs with the data for the event
Top

PROTECTED OnGetCustomPropertyNames (GetCustomPropertyNamesEventArgs)

Purpose: Raises the GetCustomPropertyNames
Notes:

Parameters:
e Consultingwerk.BusinessEntityDesigner.Services.GetCustomPropertyNamesEventArgs
The GetCustomPropertyNamesEventArgs with the data for the event
Top

PROTECTED OnGetCustomPropertyValues (GetCustomPropertyValuesEventArgs)

Purpose: Raises the GetCustomPropertyValues
Notes:

Parameters:
e Consultingwerk.BusinessEntityDesigner.Services.GetCustomPropertyValuesEventArgs
The GetCustomPropertyValuesEventArgs with the data for the event
Top

PROTECTED OnGetSourceBufferName (GetSourceBufferNameEventArgs)

Purpose: Raises the GetSourceBufferName event
Notes:

Parameters:
e Consultingwerk.BusinessEntityDesigner.Services.GetSourceBufferNameEventArgs
The GetSourceBufferNameEventArgs with the data for the event
Top

PROTECTED OnNewTempTableAdded (NewTempTableAddedEventArgs)

Purpose: Raises the NewTempTableAdded
Notes:

Parameters:
e Consultingwerk.BusinessEntityDesigner.Services.NewTempTableAddedEventArgs
The NewTempTableAddedEventArgs with the data for the event
Top

PROTECTED OnTableItemSelected (EventArgs)

Purpose: Raises the TableItemSelected
Notes:

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

PROTECTED OnUnsavedChangesChanged (EventArgs)

Purpose: Raises the UnsavedChangesChanged event
Notes:

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

PROTECTED OnValidateDesign (EventArgs)

Purpose: Raises the ValidateDesign
Notes:

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

PUBLIC LOGICAL Open (character, Model)

Purpose: Opens an existing Business Entity Design
Notes:

Parameters:
pcFileName CHARACTER
The file name to open
poModel Crainiate.Diagramming.Model
The reference to the Crainiate ERM4 Model
Returns LOGICAL
Logical value indicating if a file has been opened
Top

PROTECTED PrepareCustomPropertiesScope (CustomPropertiesScopeEnum, handle, handle)

Purpose: Prepares the query for accessing the ttCustomProperties records
for the given scope
Notes:

Parameters:
poCustomPropertiesScope Consultingwerk.BusinessEntityDesigner.Services.CustomPropertiesScopeEnum
The property scope to edit the custom properties for
phBuffer HANDLE
OUTPUT The buffer handle of the custom properties source buffer
phQuery HANDLE
OUTPUT The query handle to access the custom properties records
Top

PUBLIC Refresh ()

Purpose: Refreshes the Model on the Screen
Notes:

Top

PUBLIC RefreshAllTempTablesFromInclude ()

Purpose: Refreshes all Temp-Table definitions from the include file
Notes:

Top

PUBLIC CHARACTER RefreshTable (TempTableShape, DatabaseSchemaDatasetController)

Purpose: Updates a temp-table from the database schema
Notes:

Parameters:
poTable Consultingwerk.BusinessEntityDesigner.UI.Shapes.TempTableShape
The reference to the TempTableShape to update
poDatabaseSchema Consultingwerk.BusinessEntityDesigner.Services.DatabaseSchemaDatasetController
The reference to the DatabaseSchemaDatasetController to update from
Returns CHARACTER
The message to be shown to the user
Top

PUBLIC CHARACTER RefreshTableFromInclude (TempTableShape)

Purpose: Refreshes a Temp-Table definition from the include file
Notes:

Parameters:
poTable Consultingwerk.BusinessEntityDesigner.UI.Shapes.TempTableShape
The TempTableShape to update from the include file
Returns CHARACTER
The message from this function
Top

PUBLIC LOGICAL RegenerateSource ()

Purpose: ReGenerates source code
Notes:

Returns LOGICAL
Logical value indicating if the source was regenerated
Top

PUBLIC RegisterConsumer (Object)

Purpose: Invoked by SmartBusinessEntityAdapter and SmartDatasetChildAdapter
instances when attaching to the Dataset of the DatasetController.
Allows event subscription etc.
Notes: Interface IDatasetController member

Parameters:
poConsumer Progress.Lang.Object
The reference of the Object attaching to the Dataset Controller
Top

PROTECTED CHARACTER RemoveInvalidXmlCharacters (character)

Purpose: Converts a temp-table field name to an XML Field name
Notes: Replaces # and % with _

Parameters:
pcFieldName CHARACTER
The temp-table field name to cleanup
Returns CHARACTER
The XML field name
Top

PUBLIC RemoveRelation (Model, DataRelationConnector)

Purpose: Removes a Data-Relation from the Design
Notes:

Parameters:
poModel Crainiate.Diagramming.Model
The Crainitate ERM4 Model to delete from
poRelation Consultingwerk.BusinessEntityDesigner.UI.Shapes.DataRelationConnector
The DataRelationConnector to be deleted from the Model and the Business Entity Schema
Top

PROTECTED RemoveSelectedField (TempTableShape)

Purpose: Removes the currently selected field of the selected table
Notes:

Parameters:
poTable Consultingwerk.BusinessEntityDesigner.UI.Shapes.TempTableShape
The reference to the TempTableShape to remove a field from
Top

PROTECTED RemoveSelectedIndex (TempTableShape)

Purpose: Removes the currently selected index of the selected table
Notes:

Parameters:
poTable Consultingwerk.BusinessEntityDesigner.UI.Shapes.TempTableShape
The reference to the TempTableShape to remove a field from
Top

PUBLIC RemoveTable (Model, TempTableShape)

Purpose: Removes a Table from the Model
Notes: Removes all connectors to/from the Table as well

Parameters:
poModel Crainiate.Diagramming.Model
The Model to delete the Table from
poTable Consultingwerk.BusinessEntityDesigner.UI.Shapes.TempTableShape
The TempTableShape to delete from the Model
Top

PUBLIC RenameFieldInIndexes (character, character, character)

Purpose: Renames a field in any index
Notes:

Parameters:
pcTempTableName CHARACTER
The temp-table name
pcFieldNameBefore CHARACTER
The name of the field prior to renaming it
pcFieldNameAfter CHARACTER
The name of the field after renaming it
Top

PUBLIC CHARACTER RenameMove ()

Purpose: Shows a RenameMoveDialog and applies the chosen operations
Notes:

Returns CHARACTER
The Name of the new BEDGM File
Top

PUBLIC RenameTable (character, character)

Purpose: Renames the temp-table
Notes:

Parameters:
pcOldName CHARACTER
The old temp-table name
pcNewName CHARACTER
The new temp-table name
Top

PROTECTED ReorderFields (character)

Purpose: Reorders the fields in the named temp-table
Notes: Ensures the FieldOrder starts with 1 and provides no gaps

Parameters:
pcTable CHARACTER
The name of the temp-table to reorder
Top

PROTECTED ReorderIndexes (character)

Purpose: Reorders the indexes in the named temp-table
Notes: Ensures the IndexOrder starts with 1 and provides no gaps

Parameters:
pcTable CHARACTER
The name of the temp-table to reorder
Top

PROTECTED RestoreRecordPosition ()

Purpose: Restored a previously saved record position
Notes:

Top

PUBLIC LOGICAL Save (character)

Purpose: Saves the current Business Entity Design
Notes:

Parameters:
pcFileName CHARACTER
The name of the .bedgm file to save to
Returns LOGICAL
Logical value indicating if the design has been saved
Top

PUBLIC CHARACTER ShortTableName (character)

Purpose: Returns a shortened table name, without the DB part, when present
Notes:

Parameters:
pcTempTableName CHARACTER
The input table name
Returns CHARACTER
The shortened temp-table name
Top

PROTECTED ShowLog (character)

Purpose: Displays a string with log information
Notes:

Parameters:
pcLogString CHARACTER
The string to display
Top

PROTECTED SmartTableIOStateChangedHandler (Object, SmartTableIOStateChangedEventArgs)

Purpose: Event handler for the SmartTableIOStateChanged event of the five
property viewers in the Business Entity Designer
Notes:

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

PUBLIC SplitExtentField (character, character)

Purpose: Splits an Extent field into multiple individual fields
Notes: Raises an error, when the field cannot be found

Parameters:
pcTempTableName CHARACTER
The name of the Temp-Table
pcFieldName CHARACTER
The name of the Temp-Table field
Top

PROTECTED StoreCustomProperties (CustomPropertiesScopeEnum)

Purpose: Stores the ttCustomProperties records for the given scope
Notes:

Parameters:
poCustomPropertiesScope Consultingwerk.BusinessEntityDesigner.Services.CustomPropertiesScopeEnum
The property scope to edit the custom properties for
Top

PROTECTED StoreRecordPosition ()

Purpose: Stores the current record position
Notes:

Top

PROTECTED StoreTablePosition ()

Purpose: Stores the position on the design canvas for each table.
Notes:

Top

PROTECTED TableSelectedItemChangedHandler (Object, EventArgs)

Purpose: Event handler for the SelectedItemChanged event of the TempTableShapes
Notes:

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

PROTECTED TableShapeSelectedChangedHandler (Object, EventArgs)

Purpose: Event handler for the SelectedChanged event of the TempTableShapes
Notes:

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

PUBLIC UpdateCustomProperties (CustomPropertiesScopeEnum, character)

Purpose: Updates the custom properties for the currently selected object of
the given scope
Notes:

Parameters:
poCustomPropertiesScope Consultingwerk.BusinessEntityDesigner.Services.CustomPropertiesScopeEnum
The property scope to edit the custom properties for
pcCustomPropertiesScopeName CHARACTER
The name of the custom properties scope
Top

PUBLIC UpdateDataRelationFields ()

Purpose: Uses DataRelationFieldPickerForm to update the fields of a DATA-RELATION
Notes:

Top

PUBLIC ValidateDesign ()

Purpose: Validates the deisgn
Notes:

Top

PUBLIC LOGICAL VerifyModified (character)

Purpose: Verifies if the model has changes
Notes: Compares the .bedgm file with the current dsBusinessEntity contents
Sets the UnsavedChanges property accordingly

Parameters:
pcFileName CHARACTER
The name of the file to compare with the current model contents
Returns LOGICAL
Logical value indicating the modifed status


Constructor Detail
Top

PUBLIC BusinessEntityDatasetController ()

Purpose: Default Constructor of the BusinessEntityDatasetController class
Notes:



Event Detail
Top

PUBLIC AfterCompileSource (Object, EventArgs)

Purpose: Event raised after the source code has been compiled
Notes:

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

PUBLIC AfterFileNew (Object, EventArgs)

Purpose: Event raised after a new file is created
Notes:

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

PUBLIC AfterFileOpen (Object, FileEventArgs)

Purpose: Event raised after a file is opened
Notes:

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

PUBLIC AfterFileSave (Object, FileEventArgs)

Purpose: Event raised after a file is opened
Notes:

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

PUBLIC AfterGenerateSource (Object, EventArgs)

Purpose: Event raised after the source code is generated
Notes:

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

PUBLIC AfterRegenerateSource (Object, EventArgs)

Purpose: Event raised after the source code is re-generated
Notes:

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

PUBLIC BeforeAddingFieldToNewTable (Object, BeforeAddingFieldToNewTableEventArgs)

Purpose: Raised for every field while adding a new Database Table to the design
canvas
Notes: Cancelable event, cancelling does not add the field to the new table

Parameters:
sender Progress.Lang.Object
The object that raised the BeforeAddingFieldToNewTable event
e Consultingwerk.BusinessEntityDesigner.BeforeAddingFieldToNewTableEventArgs
The BeforeAddingFieldToNewTableEventArgs with the data for the event
Top

PUBLIC BeforeAddingIndexToNewTable (Object, BeforeAddingIndexToNewTableEventArgs)

Purpose: Raised for every Index while adding a new Database Table to the design
canvas
Notes: Cancelable event, cancelling does not add the Index to the new table

Parameters:
sender Progress.Lang.Object
The object that raised the BeforeAddingIndexToNewTable event
e Consultingwerk.BusinessEntityDesigner.BeforeAddingIndexToNewTableEventArgs
The BeforeAddingIndexToNewTableEventArgs with the data for the event
Top

PUBLIC BeforeCompileSource (Object, CancelableEventArgs)

Purpose: Event raised before the source code has been compiled
Notes:

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

PUBLIC BeforeFileNew (Object, CancelableEventArgs)

Purpose: Event raised before a new file is created
Notes:

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

PUBLIC BeforeFileOpen (Object, CancelableFileEventArgs)

Purpose: Event raised before a file is opened
Notes:

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

PUBLIC BeforeFileSave (Object, CancelableFileEventArgs)

Purpose: Event raised before a file is opened
Notes:

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

PUBLIC BeforeGenerateSource (Object, CancelableEventArgs)

Purpose: Event raised before the source code is generated
Notes:

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

PUBLIC BeforeRegenerateSource (Object, CancelableEventArgs)

Purpose: Event raised before the source code is re-generated
Notes:

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

PUBLIC ClassRenamedMoved (Object, ClassRenamedMovedEventArgs)

Purpose: Raised after a Rename/Move operation to allow plugins to make the same changes
Notes:

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

PUBLIC CustomPropertiesUpdated (Object, CustomPropertiesUpdatedEventArgs)

Purpose: Raised when the custom properties have been updated
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the CustomPropertiesUpdated event
e Consultingwerk.BusinessEntityDesigner.Services.CustomPropertiesUpdatedEventArgs
The CustomPropertiesUpdatedEventArgs with the data for the event
Top

PUBLIC GetCustomPropertyNames (Object, GetCustomPropertyNamesEventArgs)

Purpose: Raised to allow plugins to return names of available custom property
names
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the GetCustomPropertyNames event
e Consultingwerk.BusinessEntityDesigner.Services.GetCustomPropertyNamesEventArgs
The GetCustomPropertyNamesEventArgs with the data for the event
Top

PUBLIC GetCustomPropertyValues (Object, GetCustomPropertyValuesEventArgs)

Purpose: Raised to allow plugins to return possible values for custom properties
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the GetCustomPropertyValues event
e Consultingwerk.BusinessEntityDesigner.Services.GetCustomPropertyValuesEventArgs
The GetCustomPropertyValuesEventArgs with the data for the event
Top

PUBLIC GetSourceBufferName (Object, GetSourceBufferNameEventArgs)

Purpose: Raised to allow customization of the Source Buffer Name
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the GetSourceBufferName event
e Consultingwerk.BusinessEntityDesigner.Services.GetSourceBufferNameEventArgs
The GetSourceBufferNameEventArgs with the data for the event
Top

PUBLIC NewTempTableAdded (Object, NewTempTableAddedEventArgs)

Purpose: Raised when a new temp-table is added to the design
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the NewTempTableAdded event
e Consultingwerk.BusinessEntityDesigner.Services.NewTempTableAddedEventArgs
The NewTempTableAddedEventArgs with the data for the event
Top

PUBLIC TableItemSelected (Object, EventArgs)

Purpose: Raised an item in a Table Shape is selected
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the TableItemSelected event
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for the event
Top

PUBLIC UnsavedChangesChanged (Object, EventArgs)

Purpose: Event raised when the UnsavedChanges property changes
Notes:

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

PUBLIC ValidateDesign (Object, EventArgs)

Purpose: Raised to validate the current design
Notes: Plusins are supposed to THROW errors on validation issues

Parameters:
sender Progress.Lang.Object
The object that raised the ValidateDesign event
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for the event


Property Detail
Top

PUBLIC Consultingwerk.SmartComponents.Base.SmartViewerControl BusinessEntityViewerControl


Returns Consultingwerk.SmartComponents.Base.SmartViewerControl
Top

PUBLIC Consultingwerk.SmartComponents.Base.SmartViewerControl DataRelationViewerControl


Returns Consultingwerk.SmartComponents.Base.SmartViewerControl
Top

PUBLIC HANDLE DatasetHandle


Returns HANDLE
Top

PUBLIC Crainiate.Diagramming.Forms.Diagram Diagram


Returns Crainiate.Diagramming.Forms.Diagram
Top

PUBLIC Infragistics.Win.UltraWinDock.UltraDockManager DockManager


Returns Infragistics.Win.UltraWinDock.UltraDockManager
Top

PUBLIC Consultingwerk.SmartComponents.Base.SmartViewerControl FieldViewerControl


Returns Consultingwerk.SmartComponents.Base.SmartViewerControl
Top

PUBLIC Consultingwerk.SmartComponents.Base.SmartViewerControl IndexViewerControl


Returns Consultingwerk.SmartComponents.Base.SmartViewerControl
Top

PUBLIC Crainiate.Diagramming.Model Model


Returns Crainiate.Diagramming.Model
Top

PUBLIC Consultingwerk.Framework.IServiceContainer ServiceContainer


Returns Consultingwerk.Framework.IServiceContainer
Top

PUBLIC LOGICAL SuppressQuestionAboutDefaultPackage


Returns LOGICAL
Top

PUBLIC Consultingwerk.SmartComponents.Base.SmartViewerControl TableViewerControl


Returns Consultingwerk.SmartComponents.Base.SmartViewerControl
Top

PUBLIC Infragistics.Win.UltraWinTree.UltraTree TreeView


Returns Infragistics.Win.UltraWinTree.UltraTree
Top

PUBLIC LOGICAL UnsavedChanges


Returns LOGICAL


Temp-Table Detail

Temp-Table ttFileMovement

Defined in:


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       29.06.2022 12:38:47