Namespace: Consultingwerk.Design.SmartComponents.Viewer
Class 
SmartViewerDesignerControl Copy to Clipboard
Parent classes:
Progress.Windows.UserControl
Consultingwerk.SmartComponents.Base.SmartUserControl
Consultingwerk.Design.SmartComponents.Viewer.SmartViewerDesignerControl

Inherits: Consultingwerk.SmartComponents.Base.SmartUserControl
Implements: Consultingwerk.Design.SmartComponents.IDesignerControl, IHasDesignerVerbs, System.ComponentModel.Design.Serialization.INameCreationService

File:SmartViewerDesignerControl
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Tue Nov 09 22:53:47 CET 2010

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ ComponentAddedHandler (Object, ComponentEventArgs) Event handler for the ComponentAdded event
# Progress.Data.BindingSource CreateDesignBindingSource () Creates the Design time BindingSource instance
+ CHARACTER CreateName (IContainer, Type) Creates a new name that is unique to all components in the specified container
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# DeleteControls () Deletes the selected controls
# DisableTool (character) Disables a tool on the Designer Toolbar
# DuplicateControls (Control, Control) Duplicates the controls of the source control on the target control
# EnableTool (character) Enables a tool on the Designer Toolbar
# FormClosingHandler (Object, FormClosingEventArgs) Event handler for the FormClosing event of the parent Form
+ System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents () Returns a List of all Components in the Form
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ Initialize () Initializes the Control and the Designer environment
- InitializeComponent () Initializes the Visual Design
# InitializeDesignEnvironment () Initializes the Designer environment
+ LOGICAL IsValidName (character) Gets a value indicating whether the specified name is valid
# OnFieldCreated (FieldCreatedEventArgs) Raises the FieldCreated event
# OnLoad (EventArgs) Raises the Load event
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# ParentFormDestroyedHandler (Object, EventArgs) Event handler for the FormDestroyed event of the owning Form
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ PrepareAddingControl (character, character, character) Prepares adding a Control
# SelectionChangedHandler (Object, EventArgs) Event handler for the SelectionChanged event
# Serialize (Control, character) Serializes the Controls of a container control
+ Serialize (table) Serializes the Design to a Temp-Table
+ ShutDown () Shuts down the design time environment
# CHARACTER SubstituteType (character) Substitutes the runtime control types with the design time control types
- timer1_Tick (Object, EventArgs) Event handler for the Tick event of the timer1
# ToolClickHandler (Object, ToolClickEventArgs) Event handler for the ToolClick event of the UltraToolbarsManager
# CHARACTER UniqueControlName (character, Control) Builds an unique name for a Control
# CHARACTER UniqueControlNameForSerialization (Control) Returns a unique control name for the serialization
+ ValidateName (character) Gets a value indicating whether the specified name is valid.

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

Top Event Summary
Options Name Purpose
+ FieldCreated (Object, FieldCreatedEventArgs) Raised whenever a field is added to the Designer

Top Property Summary
Options Name Purpose
+ Progress.Data.BindingSource BindingSource The reference to the template BindingSource (outside this form)
+ LOGICAL CreatePropertySheet Logical value indicating if the PropertySheet should be created
+ LOGICAL CreateToolboxForm Logical value indicating if the ToolboxForm should be created
+ System.ComponentModel.Design.IDesignerHost DesignerHost Returns the reference to the Designer Host
+ Infragistics.Win.UltraWinToolbars.UltraToolbarsManager DesignerToolbar Gets and sets the reference to the UltraToolbarsManager with the designer tools
# CHARACTER DesignerVerbs Property that is used to generate Designer Verbs (actions for the Visual Designer)
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ LOGICAL DesignTime Propery flags if the current instance of the SmartBindingSource is running at design time or runtime.
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# CHARACTER HiddenProperties Property that is used to mark properties (comma-delimited list) that will be excluded from the .NET TypeDescriptor properties list
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# CHARACTER NonBrowsableProperties Property that is used to mark properties (comma-delimited list) that should not show up in the Visual Designers Property Grid
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# LOGICAL ParentFormDestroyedSubscribed Returns if the FormDestroyed evengt of the containing Form has been subscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ System.ComponentModel.Design.IServiceContainer ServiceContainer Get and sets the refrence to the service container
+ System.Windows.Forms.Control SourceControl Gets and sets the reference to the source control
+ System.Collections.Generic.Dictionary <System.String> SubstituteDesignerControls Returns the dictionary of substituted controls on the designer
+ System.Collections.Generic.Dictionary <System.String> SubstituteDynamicControls Returns the dictionary of substituted dynamic contorls


Method Detail
Top

PUBLIC ComponentAddedHandler (Object, ComponentEventArgs)
Purpose: Event handler for the ComponentAdded event
Notes:

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

PROTECTED Progress.Data.BindingSource CreateDesignBindingSource ()
Purpose: Creates the Design time BindingSource instance
Notes:

Returns Progress.Data.BindingSource
The reference to the BindingSource instance
Top

PUBLIC CHARACTER CreateName (IContainer, Type)
Purpose: Creates a new name that is unique to all components in the specified
container
Notes:

Parameters:
container System.ComponentModel.IContainer
The container where the new object is added
dataType System.Type
The data type of the object that receives the name
Returns CHARACTER
The name for the new control
Top

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

Top

PROTECTED DeleteControls ()
Purpose: Deletes the selected controls
Notes:

Top

PROTECTED DisableTool (character)
Purpose: Disables a tool on the Designer Toolbar
Notes:

Parameters:
pcTool CHARACTER
The name of the tool to disable
Top

PROTECTED DuplicateControls (Control, Control)
Purpose: Duplicates the controls of the source control on the target control
Notes:

Parameters:
poSourceControls System.Windows.Forms.Control
The reference to the source control container
poTargetControls System.Windows.Forms.Control
The reference to the target control container
Top

PROTECTED EnableTool (character)
Purpose: Enables a tool on the Designer Toolbar
Notes:

Parameters:
pcTool CHARACTER
The name of the tool to enable
Top

PROTECTED FormClosingHandler (Object, FormClosingEventArgs)
Purpose: Event handler for the FormClosing event of the parent Form
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.Windows.Forms.FormClosingEventArgs
The FormClosingEventArgs with the data for this event
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

PUBLIC Initialize ()
Purpose: Initializes the Control and the Designer environment
Notes:

Top

PRIVATE InitializeComponent ()
Purpose: Initializes the Visual Design
Notes:

Top

PROTECTED InitializeDesignEnvironment ()
Purpose: Initializes the Designer environment
Notes:

Top

PUBLIC LOGICAL IsValidName (character)
Purpose: Gets a value indicating whether the specified name is valid
Notes: Always returns True

Parameters:
name CHARACTER
The name to validate
Returns LOGICAL
Logical value indicating of the name is valid
Top

PROTECTED OnFieldCreated (FieldCreatedEventArgs)
Purpose: Raises the FieldCreated event
Notes:

Parameters:
e Consultingwerk.Design.SmartComponents.FieldCreatedEventArgs
The FieldCreatedEventArgs with the data for this event
Top

PROTECTED OnLoad (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Raises the Load event
Notes: Subscribes the FormDestroyed event from the ParentForm

Parameters:
e System.EventArgs
The System.EventArgs with the data for this 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 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

PUBLIC PrepareAddingControl (character, character, character)
Purpose: Prepares adding a Control
Notes:

Parameters:
pcFieldName CHARACTER
The name of the field to add
pcFieldDataType CHARACTER
The DataType of the field to add
pcFieldLabel CHARACTER
The Label of the field to add
Top

PROTECTED SelectionChangedHandler (Object, EventArgs)
Purpose: Event handler for the SelectionChanged event
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 Serialize (Control, character)
Purpose: Serializes the Controls of a container control
Notes: Recursive method

Parameters:
poParentControl System.Windows.Forms.Control
The reference to the Parent Control
pcParentInstanceId CHARACTER
The Instance Id of the current container instance
Top

PUBLIC Serialize (table)
Purpose: Serializes the Design to a Temp-Table
Notes:

Parameters:
ttViewerDesign TABLE
OUTPUT Temp-Table with the controls and their properties
Top

PUBLIC ShutDown ()
Purpose: Shuts down the design time environment
Notes:

Top

PROTECTED CHARACTER SubstituteType (character)
Purpose: Substitutes the runtime control types with the design time control
types
Notes:

Parameters:
pcSourceType CHARACTER
The source control type
Returns CHARACTER
The control type to be used during design time
Top

PRIVATE timer1_Tick (Object, EventArgs)
Purpose: Event handler for the Tick event of the timer1
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 ToolClickHandler (Object, ToolClickEventArgs)
Purpose: Event handler for the ToolClick event of the UltraToolbarsManager
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

PROTECTED CHARACTER UniqueControlName (character, Control)
Purpose: Builds an unique name for a Control
Notes:

Parameters:
pcControlName CHARACTER
The proposed name for the Control
poParentControl System.Windows.Forms.Control
The controls parent
Returns CHARACTER
The unique name for the control
Top

PROTECTED CHARACTER UniqueControlNameForSerialization (Control)
Purpose: Returns a unique control name for the serialization
Notes:

Parameters:
poControl System.Windows.Forms.Control
The reference to the control
Returns CHARACTER
The unique control name for the serialization
Top

PUBLIC ValidateName (character)
Purpose: Gets a value indicating whether the specified name is valid.
Notes: his method is similar to IsValidName, except that this method throws
an exception if the name is invalid. This allows implementers to
provide detailed information in the exception message.

Parameters:
name CHARACTER
The name for the new control


Constructor Detail
Top

PUBLIC SmartViewerDesignerControl ()
Purpose: Constructor for the SmartViewerDesignerControl class
Notes:



Event Detail
Top

PUBLIC FieldCreated (Object, FieldCreatedEventArgs)
Purpose: Raised whenever a field is added to the Designer
Notes:

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


Property Detail
Top

PUBLIC Progress.Data.BindingSource BindingSource
Purpose: The reference to the template BindingSource (outside this form)
Notes:

Returns Progress.Data.BindingSource
Top

PUBLIC LOGICAL CreatePropertySheet
Purpose: Logical value indicating if the PropertySheet should be created
Notes:

Returns LOGICAL
Top

PUBLIC LOGICAL CreateToolboxForm
Purpose: Logical value indicating if the ToolboxForm should be created
Notes:

Returns LOGICAL
Top

PUBLIC System.ComponentModel.Design.IDesignerHost DesignerHost
Purpose: Returns the reference to the Designer Host
Notes:

Returns System.ComponentModel.Design.IDesignerHost
Top

PUBLIC Infragistics.Win.UltraWinToolbars.UltraToolbarsManager DesignerToolbar
Purpose: Gets and sets the reference to the UltraToolbarsManager with the
designer tools
Notes:

Returns Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
Top

PROTECTED CHARACTER DesignerVerbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Property that is used to generate Designer Verbs (actions for the
Visual Designer)
Notes:

Returns CHARACTER
Top

PUBLIC LOGICAL DesignTime
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Propery flags if the current instance of the SmartBindingSource
is running at design time or runtime.
Notes: Set during constructor using a check at the
System.ComponentModel.LicenseManager

Returns LOGICAL
Top

PROTECTED CHARACTER HiddenProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Property that is used to mark properties (comma-delimited list) that
will be excluded from the .NET TypeDescriptor properties list
Notes:

Returns CHARACTER
Top

PROTECTED CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Property that is used to mark properties (comma-delimited list) that
should not show up in the Visual Designers Property Grid
Notes:

Returns CHARACTER
Top

PROTECTED LOGICAL ParentFormDestroyedSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Returns if the FormDestroyed evengt of the containing Form has been
subscribed
Notes:

Returns LOGICAL
Top

PUBLIC System.ComponentModel.Design.IServiceContainer ServiceContainer
Purpose: Get and sets the refrence to the service container
Notes:

Returns System.ComponentModel.Design.IServiceContainer
Top

PUBLIC System.Windows.Forms.Control SourceControl
Purpose: Gets and sets the reference to the source control
Notes:

Returns System.Windows.Forms.Control
Top

PUBLIC System.Collections.Generic.Dictionary <System.String> SubstituteDesignerControls
Purpose: Returns the dictionary of substituted controls on the designer
Notes:

Returns System.Collections.Generic.Dictionary <System.String>
Top

PUBLIC System.Collections.Generic.Dictionary <System.String> SubstituteDynamicControls
Purpose: Returns the dictionary of substituted dynamic contorls
Notes:

Returns System.Collections.Generic.Dictionary <System.String>


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