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

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

File:TempTableMetaInformationPlugin
Purpose:Includes temp-table meta-information in the generated include-file
Author(s):Sebastian Wandel / Consultingwerk Ltd.
Created:Mon Feb 13 11:19:37 CET 2023

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



Top Method Summary
Options Name Purpose
# LONGCHAR AddTempTableMetaInfo (longchar, JsonObject) Adds the temp-table meta-info to the given source
# Progress.Json.ObjectModel.JsonObject BuildFieldMetaInfoJson (handle) Builds a meta-info JsonObject for a field
# Progress.Json.ObjectModel.JsonObject BuildFieldsMetaInfoJson (character) Builds a JsonObject with meta-data for all fields of a temp-table
# Progress.Json.ObjectModel.JsonObject BuildIndexMetaInfoJson (handle) Builds a meta-info JsonObject for an index
# Progress.Json.ObjectModel.JsonObject BuildIndicesMetaInfoJson (character) Builds a JsonObject with meta-data about a temp-tables indices
# Progress.Json.ObjectModel.JsonObject BuildMetaInfo (character) Builds a JsonObject with meta-data of a table and its fields and indices
# Progress.Json.ObjectModel.JsonObject BuildTableMetaInfoJson (handle) Builds a meta-info JsonObject for the temp-table
# GenerateTempTableHandler (Object, GenerateTempTableEventArgs) Event handler for the GenerateTempTable event of the BusinessEntityGenerator
# LOGICAL IsPluginActive () Returns if the Plugin is active (not disabled)
+ 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.
# ToggleActive () Toggles the .Disabled property
# ToolClickHandler (Object, ToolClickEventArgs) Event handler the for the ToolClick event of the UltraToolbarsController


Method Detail
Top

PROTECTED LONGCHAR AddTempTableMetaInfo (longchar, JsonObject)
Purpose: Adds the temp-table meta-info to the given source
Notes:

Parameters:
plcSource LONGCHAR
Source-text of the temp-table
poMetaInfo Progress.Json.ObjectModel.JsonObject
Meta-Info of the temp-table
Returns LONGCHAR
The Source with added meta-info
Top

PROTECTED Progress.Json.ObjectModel.JsonObject BuildFieldMetaInfoJson (handle)
Purpose: Builds a meta-info JsonObject for a field
Notes:

Parameters:
phField HANDLE
Handle of the eField record
Returns Progress.Json.ObjectModel.JsonObject
JsonObject with the meta-info of the field
Top

PROTECTED Progress.Json.ObjectModel.JsonObject BuildFieldsMetaInfoJson (character)
Purpose: Builds a JsonObject with meta-data for all fields of a temp-table
Notes:

Parameters:
pcTableName CHARACTER
Name of the temp-table
Returns Progress.Json.ObjectModel.JsonObject
JsonObject with meta-data about the fields of the temp-table
Top

PROTECTED Progress.Json.ObjectModel.JsonObject BuildIndexMetaInfoJson (handle)
Purpose: Builds a meta-info JsonObject for an index
Notes:

Parameters:
phIndex HANDLE
Handle of the eIndex record
Returns Progress.Json.ObjectModel.JsonObject
JsonObject with the meta-info of the index
Top

PROTECTED Progress.Json.ObjectModel.JsonObject BuildIndicesMetaInfoJson (character)
Purpose: Builds a JsonObject with meta-data about a temp-tables indices
Notes:

Parameters:
pcTableName CHARACTER
The name of the temp-table
Returns Progress.Json.ObjectModel.JsonObject
JsonObject with meta-data about the indices of the temp-table
Top

PROTECTED Progress.Json.ObjectModel.JsonObject BuildMetaInfo (character)
Purpose: Builds a JsonObject with meta-data of a table and its fields and indices
Notes:

Parameters:
pcTableName CHARACTER
Name of the temp-table
Returns Progress.Json.ObjectModel.JsonObject
JsonObject with the tables meta-data
Top

PROTECTED Progress.Json.ObjectModel.JsonObject BuildTableMetaInfoJson (handle)
Purpose: Builds a meta-info JsonObject for the temp-table
Notes:

Parameters:
phTable HANDLE
Handle of the eTempTable record
Returns Progress.Json.ObjectModel.JsonObject
JsonObject with the meta-info of the temp-table
Top

PROTECTED GenerateTempTableHandler (Object, GenerateTempTableEventArgs)
Purpose: Event handler for the GenerateTempTable event of the BusinessEntityGenerator
Notes:

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

PROTECTED LOGICAL IsPluginActive ()
Purpose: Returns if the Plugin is active (not disabled)
Notes:

Returns LOGICAL
Logical value indicating if the Plugin is active (not disabled)
Top

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

Top

PUBLIC 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

PROTECTED ToggleActive ()
Purpose: Toggles the .Disabled property
Notes:

Top

PROTECTED ToolClickHandler (Object, ToolClickEventArgs)
Purpose: Event handler the for the ToolClick event of the UltraToolbarsController
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-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2024 18:35:08