Top Method Summary
Options Name Purpose
+ Activate () Invoked when the Designer is activated
+ AddOutlineNodes (UltraTreeNode, character) Adds notes to the outline view
# AssignPropertyValue (handle, Object) Assigns a value to the current property record
Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl
+ BindDesignerData (dataset, dataset) Binds to the Designer Temp-Tables
# CHARACTER BoundFieldName (character) Returns the name of the field the given field is bound field to
# BuildRibbonPalette (RibbonTab) Builds Ribbon Tools for Palette items
# ComponentMovedHandler (Object, EventArgs) Event handler for the Move event of the components on the design canvas
# ComponentParentChangedHandler (Object, EventArgs) Event handler for the ParentChanged event of the components on the design canvas
# ComponentResizedHandler (Object, EventArgs) Event handler for the Move event of the components on the design canvas
+ System.Drawing.Point ControlLocation (character) Returns the Control's Location
+ System.Drawing.Size ControlSize (character) Returns the Control's Size
# Consultingwerk.Windows.Framework.Repository.Object.ComponentDesigner.IComponentDesigner CreateComponentDesigner (character) Creates the component designer instance
# CreateConditionalRibbonTab () Creates the Conditional Ribbon Tab for this designer
# CreateSecurityField () Creates security fields for the selected viewer field
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ LOGICAL Deactivating () Invoked when the Designer is about to be deactivated
Overrides Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl:Deactivating ()
# DeleteInstance () Deletes the selected instance
# DestroyContextualRibbonTab () Destroys the Contextual Ribbon Tab in the Form's UltraToolbarsManager
+ DestroyDesigner () Allows the Container Designer Control to destroy resources
# DestroyDesignerComponents (Control) Recursively destroys components on the Designer
+ System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents () Returns a List of all Components in the Form
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# INTEGER GetHighestY () Returns the highest X value
- InitializeComponent () Initializes the Visual Design
# InsertDatabaseField () Inserts a list of database fields to the viewer
# InsertDataField () Inserts a Data Field
# InsertDataFieldInstance (character, character, ISmartRepositoryService) Inserts an instance for this given data field
# InsertFromPalette (character) Inserts a component on the design
# InsertInstance () Inserts a new instance to the design canvas
# InsertInstanceForMaster (character, character) Inserts a new instance of the given object master on the design canvas
# LOGICAL IsBoundField (character) Returns if the given field is a bound field
# LayoutHeight () Sets the height of the selected controls
# LayoutLeftAlign () Left aligns the selected controls
# LayoutVerticalDistance () Sets the vertical distance of the selected Controls
# LayoutWidth () Sets the height of the selected controls
# INTEGER NextObjectSequence (character, character) Returns the next available ObjectSequence number for the given container
Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl
# OnLoad (EventArgs) Raises the Load event
Overrides Consultingwerk.SmartComponents.Base.SmartUserControl:OnLoad (EventArgs)
# OnModifiedChanged (EventArgs) Raises the ModifiedChanged event
Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl
# OnSaveChangesRequested (EventArgs) Raises the SaveChangesRequested
Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# PaintHandler (Object, PaintEventArgs) Raises the Paint event
# ParentFormDestroyedHandler (Object, EventArgs) Event handler for the FormDestroyed event of the owning Form
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# PropertyValueChangedHandler (Object, PropertyValueChangedEventArgs) Event handler for the PropertyValueChanged event of the Property Grid Control
+ RefreshDesigner () Refreshes the Designer
Overrides Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl:RefreshDesigner ()
# System.Windows.Forms.Control RenderDesignInstance (Control, character) Renders a Control on the Design Surface
# RenderDesignSurface () Renders the Visual Design
# RenderDesignSurface (character, Control) Renders the Visual Design for one container level
+ Save () Saves the current layout
Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl
# SecurityFieldItemMaintenance () Creates security fields for the selected viewer field
# SelectionChangedHandler (Object, EventArgs) Event handler for the SelectionChanged event of the SelectionService
+ SubscribeParentFormDestroyed () Subscribes the ParentFormDestroyed event
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# SubscribeUserControlEvents () Allows for custom event subscriptions during OnLoad()
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# ToolClickHandler (Object, ToolClickEventArgs) Event handler for the ToolClick event of the owning Form's ToolbarsManager
- ultraTree1_MouseClick (Object, MouseEventArgs) Event handler for the MouseClick event of the tree
- ultraTree1_MouseDoubleClick (Object, MouseEventArgs) Event handler for the MouseDoubleClick event of the tree
- ultraTree1_VisibleChanged (Object, EventArgs) Event handler for the VisibleChanged event of the tree
# CHARACTER UniqueInstanceName (character) Returns a unique object instance name based on the provided object name
Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl
# ViewerAutofit () Auto fits the viewer

Top Constructor Summary
Options Name Purpose
+ ViewerDesignerControl () Constructor for the ViewerDesignerControl class

Top Event Summary
Options Name Purpose
+ ModifiedChanged (Object, EventArgs) Raised when the designer's Modified property changes
Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl
+ SaveChangesRequested (Object, EventArgs) Raised when SaveChanges is requested
Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl

Top Property Summary
Options Name Purpose
# CHARACTER DesignerVerbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ LOGICAL DesignTime
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# CHARACTER HiddenProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ CHARACTER MessageBoxTitle
Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl
+ LOGICAL Modified
Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl
# CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# LOGICAL ParentFormDestroyedSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ Consultingwerk.Windows.Framework.Repository.Object.SmartPropertyGridControl PropertyGrid
+ Infragistics.Win.UltraWinToolbars.UltraToolbarsManager ToolbarsManager
# LOGICAL UserControlEventsSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl


Method Detail
Top

PUBLIC Activate ()

Purpose: Invoked when the Designer is activated
Notes: Typically invoked when the designer tab is shown again

Top

PUBLIC AddOutlineNodes (UltraTreeNode, character)

Purpose: Adds notes to the outline view
Notes:

Parameters:
poParentNode Infragistics.Win.UltraWinTree.UltraTreeNode
The parent tree node to add instances to
pcParentInstanceGuid CHARACTER
The parent instance guid
Top

PROTECTED AssignPropertyValue (handle, Object)

Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl
Purpose: Assigns a value to the current property record
Notes:

Parameters:
phBuffer HANDLE
Then handle of the buffer to assign the property in
poValue System.Object
The new property value
Top

PUBLIC BindDesignerData (dataset, dataset)

Purpose: Binds to the Designer Temp-Tables
Notes:

Parameters:
dsObjectMaster DATASET dsObjectMaster
DATASET BIND from Consultingwerk/SmartFramework/Repository/Object/dsObjectMaster.i
dsDesignAttributeValue DATASET dsDesignAttributeValue
DATASET BIND from Consultingwerk/SmartFramework/Repository/Class/dsDesignAttributeValue.i
Top

PROTECTED CHARACTER BoundFieldName (character)

Purpose: Returns the name of the field the given field is bound field to
Notes:

Parameters:
pcFieldName CHARACTER
The name of the field
Returns CHARACTER
The name of the bound field
Top

PROTECTED BuildRibbonPalette (RibbonTab)

Purpose: Builds Ribbon Tools for Palette items
Notes:

Parameters:
poRibbonTab Infragistics.Win.UltraWinToolbars.RibbonTab
The RibbonTab to add the Palette items to
Top

PROTECTED ComponentMovedHandler (Object, EventArgs)

Purpose: Event handler for the Move event of the components on the design canvas
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

PROTECTED ComponentParentChangedHandler (Object, EventArgs)

Purpose: Event handler for the ParentChanged event of the components on the design canvas
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

PROTECTED ComponentResizedHandler (Object, EventArgs)

Purpose: Event handler for the Move event of the components on the design canvas
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 System.Drawing.Point ControlLocation (character)

Purpose: Returns the Control's Location
Notes: Based on a Pixel Layout on the canvas

Parameters:
pcObjectInstanceGuid CHARACTER
The GUID of the Object instance
Returns System.Drawing.Point
The Location as a System.Drawing.Point
Top

PUBLIC System.Drawing.Size ControlSize (character)

Purpose: Returns the Control's Size
Notes: Based on a Pixel Layout on the canvas

Parameters:
pcObjectInstanceGuid CHARACTER
The GUID of the Object instance
Returns System.Drawing.Size
The Size as a System.Drawing.Size
Top

PROTECTED Consultingwerk.Windows.Framework.Repository.Object.ComponentDesigner.IComponentDesigner CreateComponentDesigner (character)

Purpose: Creates the component designer instance
Notes:

Parameters:
pcObjectInstanceGuid CHARACTER
The GUID of the object instance to create the designer for
Returns Consultingwerk.Windows.Framework.Repository.Object.ComponentDesigner.IComponentDesigner
The IComponentDesigner instance
Top

PROTECTED CreateConditionalRibbonTab ()

Purpose: Creates the Conditional Ribbon Tab for this
designer
Notes:

Top

PROTECTED CreateSecurityField ()

Purpose: Creates security fields for the selected viewer field
Notes:

Top

PROTECTED CreateVerbs ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Creates Designer Verbs based on the DesignerVerbs property
Notes:

Top

PUBLIC LOGICAL Deactivating ()

Overrides Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl:Deactivating ()
Purpose: Invoked when the Designer is about to be deactivated
Notes: Typically invoked when the designer tab hidden; allows cancelling
of the deactivation

Returns LOGICAL
Logical value indicating if the deactivation should not be cancelled (FALSE = cancelled)
Top

PROTECTED DeleteInstance ()

Purpose: Deletes the selected instance
Notes:

Top

PROTECTED DestroyContextualRibbonTab ()

Purpose: Destroys the Contextual Ribbon Tab in the Form's UltraToolbarsManager
Notes:

Top

PUBLIC DestroyDesigner ()

Purpose: Allows the Container Designer Control to destroy resources
Notes: Typically used to clean up Ribbon Tabs etc.

Top

PROTECTED DestroyDesignerComponents (Control)

Purpose: Recursively destroys components on the Designer
Notes:

Parameters:
poRootControl System.Windows.Forms.Control
The Root Component
Top

PUBLIC System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Returns a List of all Components in the Form
Notes: Supported on OpenEdge 11 only, due to dependency to the ComponentsCollection
list not available on 10.2B

Returns System.Collections.Generic.List <System.ComponentModel.Component>
The List of Components in the Form
Top

PROTECTED INTEGER GetHighestY ()

Purpose: Returns the highest X value
Notes:

Returns INTEGER
The hightest Y value
Top

PRIVATE InitializeComponent ()

Purpose: Initializes the Visual Design
Notes:

Top

PROTECTED InsertDatabaseField ()

Purpose: Inserts a list of database fields to the viewer
Notes:

Top

PROTECTED InsertDataField ()

Purpose: Inserts a Data Field
Notes:

Top

PROTECTED InsertDataFieldInstance (character, character, ISmartRepositoryService)

Purpose: Inserts an instance for this given data field
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
pcGuid CHARACTER
The GUID of the data field
poRepository Consultingwerk.SmartFramework.Repository.ISmartRepositoryService
The ISmartRepositoryService reference
Top

PROTECTED InsertFromPalette (character)

Purpose: Inserts a component on the design
Notes:

Parameters:
pcComponentName CHARACTER
The name of the component to insert
Top

PROTECTED InsertInstance ()

Purpose: Inserts a new instance to the design canvas
Notes:

Top

PROTECTED InsertInstanceForMaster (character, character)

Purpose: Inserts a new instance of the given object master on the design canvas
Notes:

Parameters:
pcObjectMasterGuid CHARACTER
The GUID of the Object Master to create an instance of
pcFieldName CHARACTER
The name of the entity field to map to, ? for using the object name
Top

PROTECTED LOGICAL IsBoundField (character)

Purpose: Returns if the given field is a bound field
Notes:

Parameters:
pcFieldName CHARACTER
The name of the field
Returns LOGICAL
Logical value indicating if the field is bound
Top

PROTECTED LayoutHeight ()

Purpose: Sets the height of the selected controls
Notes:

Top

PROTECTED LayoutLeftAlign ()

Purpose: Left aligns the selected controls
Notes:

Top

PROTECTED LayoutVerticalDistance ()

Purpose: Sets the vertical distance of the selected Controls
Notes:

Top

PROTECTED LayoutWidth ()

Purpose: Sets the height of the selected controls
Notes:

Top

PROTECTED INTEGER NextObjectSequence (character, character)

Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl
Purpose: Returns the next available ObjectSequence number for the
given container
Notes:

Parameters:
pcContainerObjectMasterGuid CHARACTER
The GUID of the object master
pcParentInstanceGuid CHARACTER
The GUID of the parent control
Returns INTEGER
INTEGER
Top

PROTECTED OnLoad (EventArgs)

Overrides Consultingwerk.SmartComponents.Base.SmartUserControl:OnLoad (EventArgs)
Purpose: Raises the Load event
Notes:

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

PROTECTED OnModifiedChanged (EventArgs)

Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl
Purpose: Raises the ModifiedChanged event
Notes:

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

PROTECTED OnSaveChangesRequested (EventArgs)

Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl
Purpose: Raises the SaveChangesRequested
Notes:

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

PUBLIC OnVerbClicked (character)

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Event Handler method for Designer Verbs
Notes: This method is intended to be overridden

Parameters:
pcDesignerVerb CHARACTER
The name (Label) of the Designer Verb that was invoked
Top

PROTECTED PaintHandler (Object, PaintEventArgs)

Purpose: Raises the Paint event
Notes:

Parameters:
sender System.Object
The reference to the control that raised the event
e System.Windows.Forms.PaintEventArgs
The PaintEventArgs with the data for this event
Top

PROTECTED ParentFormDestroyedHandler (Object, EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Event handler for the FormDestroyed event of the owning Form
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

PROTECTED PropertyValueChangedHandler (Object, PropertyValueChangedEventArgs)

Purpose: Event handler for the PropertyValueChanged event of the
Property Grid Control
Notes:

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

PUBLIC RefreshDesigner ()

Overrides Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl:RefreshDesigner ()
Purpose: Refreshes the Designer
Notes:

Top

PROTECTED System.Windows.Forms.Control RenderDesignInstance (Control, character)

Purpose: Renders a Control on the Design Surface
Notes: Does not set the LicenseContext to Design - so that when it's
executed in a loop (RenderDesignSurface) there is only one
switch of the license context

Parameters:
poRootControl System.Windows.Forms.Control
The Designer Root Control (Viewer)
pcObjectInstanceGuid CHARACTER
The object instance guid
Returns System.Windows.Forms.Control
The reference to the rendered control instance
Top

PROTECTED RenderDesignSurface ()

Purpose: Renders the Visual Design
Notes:

Top

PROTECTED RenderDesignSurface (character, Control)

Purpose: Renders the Visual Design for one container level
Notes:

Parameters:
pcParentInstanceGuid CHARACTER
The ObjectInstanceGuid of the parent container
poParent System.Windows.Forms.Control
The control instance rendered for the parent
Top

PUBLIC Save ()

Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl
Purpose: Saves the current layout
Notes:

Top

PROTECTED SecurityFieldItemMaintenance ()

Purpose: Creates security fields for the selected viewer field
Notes:

Top

PROTECTED SelectionChangedHandler (Object, EventArgs)

Purpose: Event handler for the SelectionChanged event of the
SelectionService
Notes: Deselects the Label components

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 SubscribeParentFormDestroyed ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Subscribes the ParentFormDestroyed event
Notes:

Top

PROTECTED SubscribeUserControlEvents ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Allows for custom event subscriptions during OnLoad()
Notes: Intended to be overridden in the inheriting user control

Top

PROTECTED ToolClickHandler (Object, ToolClickEventArgs)

Purpose: Event handler for the ToolClick event of the owning Form's
ToolbarsManager
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
Top

PRIVATE ultraTree1_MouseClick (Object, MouseEventArgs)

Purpose: Event handler for the MouseClick event of the tree
Notes:

Parameters:
sender System.Object
The reference to the control that raised the event
e System.Windows.Forms.MouseEventArgs
The MouseEventArgs with the data for this event
Top

PRIVATE ultraTree1_MouseDoubleClick (Object, MouseEventArgs)

Purpose: Event handler for the MouseDoubleClick event of the tree
Notes:

Parameters:
sender System.Object
The reference to the control that raised the event
e System.Windows.Forms.MouseEventArgs
The MouseEventArgs with the data for this event
Top

PRIVATE ultraTree1_VisibleChanged (Object, EventArgs)

Purpose: Event handler for the VisibleChanged event of the tree
Notes:

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

PROTECTED CHARACTER UniqueInstanceName (character)

Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl
Purpose: Returns a unique object instance name based on the
provided object name
Notes:

Parameters:
pcObjectMasterName CHARACTER
The name of the object master
Returns CHARACTER
The unqiue instance name
Top

PROTECTED ViewerAutofit ()

Purpose: Auto fits the viewer
Notes:



Constructor Detail
Top

PUBLIC ViewerDesignerControl ()

Purpose: Constructor for the ViewerDesignerControl class
Notes:



Event Detail
Top

PUBLIC ModifiedChanged (Object, EventArgs)

Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl
Purpose: Raised when the designer's Modified property changes
Notes:

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

PUBLIC SaveChangesRequested (Object, EventArgs)

Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl
Purpose: Raised when SaveChanges is requested
Notes:

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


Property Detail
Top

PROTECTED CHARACTER DesignerVerbs

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns CHARACTER
Top

PUBLIC LOGICAL DesignTime

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL
Top

PROTECTED CHARACTER HiddenProperties

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns CHARACTER
Top

PUBLIC CHARACTER MessageBoxTitle

Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl

Returns CHARACTER
Top

PUBLIC LOGICAL Modified

Inherited from Consultingwerk.Windows.Framework.Repository.Object.ContainerDesignerControl

Returns LOGICAL
Top

PROTECTED CHARACTER NonBrowsableProperties

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns CHARACTER
Top

PROTECTED LOGICAL ParentFormDestroyedSubscribed

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL
Top

PUBLIC Consultingwerk.Windows.Framework.Repository.Object.SmartPropertyGridControl PropertyGrid


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

PUBLIC Infragistics.Win.UltraWinToolbars.UltraToolbarsManager ToolbarsManager


Returns Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
Top

PROTECTED LOGICAL UserControlEventsSubscribed

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       27.03.2024 00:56:58