Namespace: Consultingwerk.Windows.Framework.Repository.Object
Class 
BaseObjectDesignerObjectTypePlugin Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Windows.Framework.Repository.Object.BaseObjectDesignerObjectTypePlugin

Inherits: Progress.Lang.Object
Implements: Consultingwerk.IAction, Consultingwerk.Windows.Framework.Repository.Object.ISmartObjectMasterFormPlugin
Inherited by: Consultingwerk.Windows.Framework.Repository.Object.FormDefaultComponentsPlugin Consultingwerk.Windows.Framework.Repository.Object.GenerateLogicObjectPlugin Consultingwerk.Windows.Framework.Repository.Object.GenerateServerSideEventHandlerPlugin Consultingwerk.Windows.Framework.Repository.Object.GenerateUiControlPlugin
ABSTRACT


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



Top Method Summary
Options Name Purpose
AddRibbonToolAfter (RibbonGroup, character, character) Adds a tool to a ribbon group, positioned after another tool
BeginUpdateStateHandler (Object, DataSourceUpdateStateEventArgs) Event handler for the BeginUpdateState event of the ObjectMaster BusinessEntityAdapter
EndUpdateStateHandler (Object, DataSourceUpdateStateEventArgs) Event handler for the EndUpdateState event of the ObjectMaster BusinessEntityAdapter
Execute () Calls ValidateButtonEnabled from the Sequencer
LOGICAL ExposesObjectMasterAttribute (character) Returns if the object type of the current Object Master exposes the given attribute
CHARACTER GetObjectInstanceAttributeValue (character) Returns the value of an attribute of the selected Object Instance
CHARACTER GetObjectMasterAttributeValue (character) Returns the character value of an attribute of the current Object Master
CHARACTER GetSelectedAttributeObjectType () Returns the object type name the currently selected attribute belongs to
LOGICAL IsSupportedObjectType () Returns if the current Object Master is of one of the object types of the plugin
ObjectMasterGuidChangedHandler (Object, EventArgs) Event handler for the ObjectMasterGuidChanged event of the SmartObjectMasterForm
ObjectMasterOpenedHandler (Object, EventArgs) Event handler for the ObjectMasterOpened event of the SmartObjectMasterForm
SelectedAttributeChangedHandler (Object, EventArgs) Event handler for the SelectedAttributeChanged event of the SmartObjectMasterForm
Shutdown () Method called when the SmartObjectMasterForm will get closed
Startup (SmartObjectMasterForm, SmartToolbarController, handle) Method called when then SmartObjectMasterForm is started
A ToolClickHandler (Object, ToolClickEventArgs) Event handler for the ToolClick Event of the ToolbarsController
A ValidateButtonEnabled () Validates the Enabled State of the Ribbon Button

Top Constructor Summary
Options Name Purpose
BaseObjectDesignerObjectTypePlugin (character) Default constructor for BaseObjectDesignerObjectTypePlugin

Top Property Summary
Options Name Purpose
Consultingwerk.Windows.Framework.Repository.Object.SmartObjectMasterForm Form
CHARACTER ObjectTypeList
Consultingwerk.SmartComponents.Implementation.SmartToolbarController Toolbar


Method Detail
Top

AddRibbonToolAfter (RibbonGroup, character, character)
Purpose: Adds a tool to a ribbon group, positioned after another tool
Notes: SCL-4372 - the buttons of the "Generate Code" group are contributed
by three different plugins but have a prescribed left-to-right
order, so a plugin cannot simply append. When the anchor tool is
not present - because the plugin owning it is not registered, or
is registered after this one - the tool is appended instead, so
an unexpected plugin order degrades the layout rather than failing

Parameters:
poGroup Infragistics.Win.UltraWinToolbars.RibbonGroup
The RibbonGroup to add the tool to
pcToolKey CHARACTER
The key of the tool to add
pcAfterToolKey CHARACTER
The key of the tool to position the new tool after
Top

BeginUpdateStateHandler (Object, DataSourceUpdateStateEventArgs)
Purpose: Event handler for the BeginUpdateState event of the ObjectMaster BusinessEntityAdapter
Notes:

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

EndUpdateStateHandler (Object, DataSourceUpdateStateEventArgs)
Purpose: Event handler for the EndUpdateState event of the ObjectMaster BusinessEntityAdapter
Notes:

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

Execute ()
Purpose: Calls ValidateButtonEnabled from the Sequencer
Notes:

Top

LOGICAL ExposesObjectMasterAttribute (character)
Purpose: Returns if the object type of the current Object Master exposes the given attribute
Notes: SCL-4372

Parameters:
pcAttributeLabel CHARACTER
The label of the attribute to test
Returns LOGICAL
Logical value indicating if the object type exposes the attribute
Top

CHARACTER GetObjectInstanceAttributeValue (character)
Purpose: Returns the value of an attribute of the selected Object Instance
Notes: SCL-5669 - the object instance counterpart of
GetObjectMasterAttributeValue. Returns the empty string when no
object instance is selected or when the object type of the
instance does not expose the attribute

Parameters:
pcAttributeLabel CHARACTER
The label of the attribute to read
Returns CHARACTER
The character value of the attribute, or the empty string
Top

CHARACTER GetObjectMasterAttributeValue (character)
Purpose: Returns the character value of an attribute of the current Object Master
Notes: SCL-4372 - returns the empty string when the object type does not
expose the attribute at all, so callers can treat "not exposed"
and "not set" alike when that is what they need

Parameters:
pcAttributeLabel CHARACTER
The label of the attribute to read
Returns CHARACTER
The character value of the attribute, or the empty string
Top

CHARACTER GetSelectedAttributeObjectType ()
Purpose: Returns the object type name the currently selected attribute belongs to
Notes: SCL-4372 - the object type of the selected object instance for an
instance level attribute, the object type of the object master otherwise

Returns CHARACTER
The name of the repository object type, or the empty string
Top

LOGICAL IsSupportedObjectType ()
Purpose: Returns if the current Object Master is of one of the object types of the plugin
Notes: SCL-4372

Returns LOGICAL
Logical value indicating if the plugin is active for the current Object Master
Top

ObjectMasterGuidChangedHandler (Object, EventArgs)
Purpose: Event handler for the ObjectMasterGuidChanged event of the SmartObjectMasterForm
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

ObjectMasterOpenedHandler (Object, EventArgs)
Purpose: Event handler for the ObjectMasterOpened event of the SmartObjectMasterForm
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

SelectedAttributeChangedHandler (Object, EventArgs)
Purpose: Event handler for the SelectedAttributeChanged event of the SmartObjectMasterForm
Notes: SCL-4372 - the event handler generation buttons depend on the
attribute selected in one of the two attribute grids

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

Shutdown ()
Purpose: Method called when the SmartObjectMasterForm will get closed
Notes:

Top

Startup (SmartObjectMasterForm, SmartToolbarController, handle)
Purpose: Method called when then SmartObjectMasterForm is started
Notes:

Parameters:
poForm Consultingwerk.Windows.Framework.Repository.Object.SmartObjectMasterForm
The reference to the SmartObjectMasterForm instance
poToolbar Consultingwerk.SmartComponents.Implementation.SmartToolbarController
The reference to the SmartToolbarController instance
phDataset HANDLE
The handle of the dsObjectMaster dataset
Top

ToolClickHandler (Object, ToolClickEventArgs)
Purpose: Event handler for the ToolClick Event of the ToolbarsController
Notes:

Parameters:
sender System.Object
The reference to the object that raise the event
e Infragistics.Win.UltraWinToolbars.ToolClickEventArgs
The ToolClickEventArgs with the data for this event
Top

ValidateButtonEnabled ()
Purpose: Validates the Enabled State of the Ribbon Button
Notes:



Constructor Detail
Top

BaseObjectDesignerObjectTypePlugin (character)
Purpose: Default constructor for BaseObjectDesignerObjectTypePlugin
Notes:

Parameters:
pcObjectTypeList CHARACTER
The list of Object Types the plugin is active for


Property Detail
Top

Consultingwerk.Windows.Framework.Repository.Object.SmartObjectMasterForm Form

Returns Consultingwerk.Windows.Framework.Repository.Object.SmartObjectMasterForm
Top

CHARACTER ObjectTypeList

Returns CHARACTER
Top

Consultingwerk.SmartComponents.Implementation.SmartToolbarController Toolbar

Returns Consultingwerk.SmartComponents.Implementation.SmartToolbarController


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:22:11