Namespace: Consultingwerk.BusinessEntityDesigner
Class 
BusinessEntityDesignerSettings Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object

File:BusinessEntityDesignerSettings
Purpose:Maintains the settings (Options Dialog) of the
Business Entity Designer
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Oct 17 22:37:44 CEST 2010



Top Method Summary
Options Name Purpose
+ BeginChangeSettings () Used to flag that a series of settings is being saved
+ EndChangeSettings () Used to flag that a series of settings has been saved
# OnSettingsChanged (EventArgs) Raises the SettingsChanged event
+ SaveSettings () Saves settings to the file .BusinessEntityDesignerSettings.xml

Top Constructor Summary
Options Name Purpose
BusinessEntityDesignerSettings () Constructor for the BusinessEntityDesignerSettings class

Top Event Summary
Options Name Purpose
+ SettingsChanged (Object, EventArgs) Raised then the settings have changed

Top Property Summary
Options Name Purpose
+ CHARACTER ApacheAntCommandLine The name of the executable of Apache ANT. Add the directory, if ant.bat is not available in the system PATH
+ CHARACTER BusinessEntityDesignerPlugins The names of the plugin classes used by the business entity designer, Seperated with the pipe character (|).
+ CHARACTER BusinessEntityGenerator The name of the class used to generate the actual source code
+ LOGICAL CompileDatasetController Controls of the Business Entity Generator is supposed to compile the DatasetController class
+ CHARACTER CustomServices Gets and sets a custom services file to be used by the Business Entity Designer
+ CHARACTER DataRelationFieldsService The name of the class used to generate data-relation field names for new data-relations dragged to the design canvas
+ CHARACTER DefaultBeforeTablePrefix The default prefix used for before table names generated for db tables dragged to the design canvas
+ CHARACTER DefaultBeforeTableSuffix The default suffix used for before table names generated for db tables dragged to the design canvas
+ CHARACTER DefaultTablePrefix The default prefix used for temp-table names generated for db tables dragged to the design canvas
+ CHARACTER DefaultTableSuffix The default suffix used for temp-table names generated for db tables dragged to the design canvas
+ LOGICAL DistinctTempTableIncludeFiles The default for the DistinctTempTableIncludeFiles property of business entities (generate seperate include files per temp-table)
+ CHARACTER FieldNameGeneratorService The name of the class used to generate temp table field names for fields of db tables dragged to the design canvas
+ LOGICAL GenerateDatasetController Value for the GenerateDatasetController flag for new Business Entities
+ CHARACTER IncludeFilesBaseFolder The sourcecode directory for include files
+ CHARACTER KeywordCasing Gets and sets if Keywords generated by the code generators should get generated in upper or lower case
+ CHARACTER LauncherCommandLine The command line used by the Business Entity Designer Launcher
+ CHARACTER LauncherProversion The Progress installation version used by the Business Entity Designer Launcher
+ LOGICAL OpenFilesInIDE Open generated files in OpenEdge IDE after generating
+ LOGICAL PromptForSaveBeforeGenerate Prompt for Save Changes before generating code
+ CHARACTER RCodeBaseFolder The r-code directory
+ CHARACTER RCodeBaseFolderGui The r-code directory for GUI objects
+ CHARACTER RelationNameSubstitute The name pattern used by the business entity designer when generating names for DATA-RELATION objects, i.e. "&1&2Relation"
+ LOGICAL ReplaceHyphenInTableName Option to replace hyphens in database table names with proper CamelCase when dragging a database table onto the design cansas
+ LOGICAL ReplaceUnderScoreInTableName Option to replace underscores in database table names with proper CamelCase when dragging a database table onto the design cansas
+ CHARACTER SettingsFile Returns the name of the Settings File that settings were loaded from
+ LOGICAL SettingsFileLoaded Returns if a settings file was found when starting the Business Entity Designerthe
+ CHARACTER SourceCodeBaseFolder The sourcecode directory
+ CHARACTER SourceCodeBaseFolderGui The sourcecode directory for GUI objects
+ LOGICAL SplitArrayFields Split Array Fields into seperate fields when dragging database tables on the design canvas
+ LOGICAL SynchronizeTempTablesOnOpen Synchronize temp-tables when opening .bedgm file
+ CHARACTER TableNameGeneratorService The tablename generator
+ CHARACTER TemplateFolder The folder containing the template files used by the code generator
+ LOGICAL UseLocalFileHistory Use a local LRU .bedgm file history - one per .BusinessEntityDesignerSettings
+ LOGICAL ViewUnderscoreTables Controls if underscore tables (meta schema and VST's) should be shown in the settings


Method Detail
Top

PUBLIC BeginChangeSettings ()

Purpose: Used to flag that a series of settings is being saved
Notes: Used by the options dialog when setting properties of this class
to prevent saving of settings after each single property setter

Top

PUBLIC EndChangeSettings ()

Purpose: Used to flag that a series of settings has been saved
Notes: Used by the options dialog when setting properties of this class
to prevent saving of settings after each single property setter

Top

PROTECTED OnSettingsChanged (EventArgs)

Purpose: Raises the SettingsChanged event
Notes:

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

PUBLIC SaveSettings ()

Purpose: Saves settings to the file .BusinessEntityDesignerSettings.xml
Notes:



Constructor Detail
Top

STATIC BusinessEntityDesignerSettings ()

Purpose: Constructor for the BusinessEntityDesignerSettings class
Notes: Loads settings from the file .BusinessEntityDesignerSettings.xml



Event Detail
Top

PUBLIC SettingsChanged (Object, EventArgs)

Purpose: Raised then the settings have changed
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


Property Detail
Top

PUBLIC CHARACTER ApacheAntCommandLine

Purpose: The name of the executable of Apache ANT. Add the directory, if ant.bat
is not available in the system PATH
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER BusinessEntityDesignerPlugins

Purpose: The names of the plugin classes used by the business entity designer,
Seperated with the pipe character (|).
Notes: Class should implement
Consultingwerk.BusinessEntityDesigner.IBusinessEntityDesignerPlugin

Returns CHARACTER
Top

PUBLIC CHARACTER BusinessEntityGenerator

Purpose: The name of the class used to generate the actual source code
Notes: Class should implement
Consultingwerk.BusinessEntityDesigner.Generator.IBusinessEntityGenerator

Returns CHARACTER
Top

PUBLIC LOGICAL CompileDatasetController

Purpose: Controls of the Business Entity Generator is supposed to compile
the DatasetController class
Notes: Useful in situation with mixed OpenEdge Releases (OE10 backend, OE11
GUI)

Returns LOGICAL
Top

PUBLIC CHARACTER CustomServices

Purpose: Gets and sets a custom services file to be used by the Business Entity
Designer
Notes: Custom services will be registered in the default ServiceContainer
and allow customization as an alternative to plugins

Returns CHARACTER
Top

PUBLIC CHARACTER DataRelationFieldsService

Purpose: The name of the class used to generate data-relation field names for
new data-relations dragged to the design canvas
Notes: Class should implement
Consultingwerk.BusinessEntityDesigner.Services.IDataRelationFieldsService

Returns CHARACTER
Top

PUBLIC CHARACTER DefaultBeforeTablePrefix

Purpose: The default prefix used for before table names generated for
db tables dragged to the design canvas
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER DefaultBeforeTableSuffix

Purpose: The default suffix used for before table names generated for
db tables dragged to the design canvas
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER DefaultTablePrefix

Purpose: The default prefix used for temp-table names generated for
db tables dragged to the design canvas
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER DefaultTableSuffix

Purpose: The default suffix used for temp-table names generated for
db tables dragged to the design canvas
Notes:

Returns CHARACTER
Top

PUBLIC LOGICAL DistinctTempTableIncludeFiles

Purpose: The default for the DistinctTempTableIncludeFiles property of
business entities (generate seperate include files per temp-table)
Notes:

Returns LOGICAL
Top

PUBLIC CHARACTER FieldNameGeneratorService

Purpose: The name of the class used to generate temp table field names for
fields of db tables dragged to the design canvas
Notes: Class should implement
Consultingwerk.BusinessEntityDesigner.Services.IFieldNameGeneratorService

Returns CHARACTER
Top

PUBLIC LOGICAL GenerateDatasetController

Purpose: Value for the GenerateDatasetController flag for new Business Entities
Notes:

Returns LOGICAL
Top

PUBLIC CHARACTER IncludeFilesBaseFolder

Purpose: The sourcecode directory for include files
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER KeywordCasing

Purpose: Gets and sets if Keywords generated by the code generators should
get generated in upper or lower case
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LauncherCommandLine

Purpose: The command line used by the Business Entity Designer Launcher
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LauncherProversion

Purpose: The Progress installation version used by the Business Entity
Designer Launcher
Notes:

Returns CHARACTER
Top

PUBLIC LOGICAL OpenFilesInIDE

Purpose: Open generated files in OpenEdge IDE after generating
Notes:

Returns LOGICAL
Top

PUBLIC LOGICAL PromptForSaveBeforeGenerate

Purpose: Prompt for Save Changes before generating code
Notes:

Returns LOGICAL
Top

PUBLIC CHARACTER RCodeBaseFolder

Purpose: The r-code directory
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER RCodeBaseFolderGui

Purpose: The r-code directory for GUI objects
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER RelationNameSubstitute

Purpose: The name pattern used by the business entity designer when
generating names for DATA-RELATION objects, i.e. "&1&2Relation"
Notes: Use &1 for the source table name and &2 for the target table name

Returns CHARACTER
Top

PUBLIC LOGICAL ReplaceHyphenInTableName

Purpose: Option to replace hyphens in database table names with proper
CamelCase when dragging a database table onto the design cansas
Notes:

Returns LOGICAL
Top

PUBLIC LOGICAL ReplaceUnderScoreInTableName

Purpose: Option to replace underscores in database table names with proper
CamelCase when dragging a database table onto the design cansas
Notes:

Returns LOGICAL
Top

PUBLIC CHARACTER SettingsFile

Purpose: Returns the name of the Settings File that settings were loaded from
Notes: May return "<no settings file>" in a fresh environment

Returns CHARACTER
Top

PUBLIC LOGICAL SettingsFileLoaded

Purpose: Returns if a settings file was found when starting the Business
Entity Designerthe
Notes:

Returns LOGICAL
Top

PUBLIC CHARACTER SourceCodeBaseFolder

Purpose: The sourcecode directory
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER SourceCodeBaseFolderGui

Purpose: The sourcecode directory for GUI objects
Notes:

Returns CHARACTER
Top

PUBLIC LOGICAL SplitArrayFields

Purpose: Split Array Fields into seperate fields when dragging database
tables on the design canvas
Notes:

Returns LOGICAL
Top

PUBLIC LOGICAL SynchronizeTempTablesOnOpen

Purpose: Synchronize temp-tables when opening .bedgm file
Notes:

Returns LOGICAL
Top

PUBLIC CHARACTER TableNameGeneratorService

Purpose: The tablename generator
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER TemplateFolder

Purpose: The folder containing the template files used by the code
generator
Notes:

Returns CHARACTER
Top

PUBLIC LOGICAL UseLocalFileHistory

Purpose: Use a local LRU .bedgm file history - one per .BusinessEntityDesignerSettings
Notes: LRU will be stored in the Windows registry under a local path

Returns LOGICAL
Top

PUBLIC LOGICAL ViewUnderscoreTables

Purpose: Controls if underscore tables (meta schema and VST's) should be
shown in the settings
Notes:

Returns LOGICAL


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:25:42