Namespace: Consultingwerk.Design.SmartComponents
Class 
BindingSourceFieldsForm Copy to Clipboard
Parent classes:
Inherits: Progress.Windows.Form
Implements: System.Drawing.Design.IToolboxService

File:BindingSourceFieldsForm
Purpose:Provides fields from a BindingSource as an IToolboxService
implementation
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Tue Nov 09 23:46:44 CET 2010



Top Method Summary
Options Name Purpose
+ AddCreator (ToolboxItemCreatorCallback, character) Adds a new toolbox item creator for a specified data format.
+ AddCreator (ToolboxItemCreatorCallback, character, IDesignerHost) Adds a new toolbox item creator for a specified data format and designer host.
+ AddLinkedToolboxItem (ToolboxItem, character, IDesignerHost) Adds the specified project-linked toolbox item to the toolbox in the specified category.
+ AddLinkedToolboxItem (ToolboxItem, IDesignerHost) Adds the specified project-linked toolbox item to the toolbox.
+ AddToolboxItem (ToolboxItem) Adds the specified toolbox item to the toolbox.
+ AddToolboxItem (ToolboxItem, character) Adds the specified toolbox item to the toolbox in the specified category.
+ System.Drawing.Design.ToolboxItem DeserializeToolboxItem (Object) Gets a toolbox item from the specified object that represents a toolbox item in serialized form.
+ System.Drawing.Design.ToolboxItem DeserializeToolboxItem (Object, IDesignerHost) Gets a toolbox item from the specified object that represents a toolbox item in serialized form, using the specified designer host.
+ System.Drawing.Design.ToolboxItem GetSelectedToolboxItem () Gets the currently selected toolbox item
+ System.Drawing.Design.ToolboxItem GetSelectedToolboxItem (IDesignerHost) Gets the currently selected toolbox item if it is available to all designers, or if it supports the specified designer.
+ System.Drawing.Design.ToolboxItemCollection GetToolboxItems () Gets the entire collection of toolbox items from the toolbox.
+ System.Drawing.Design.ToolboxItemCollection GetToolboxItems (character) Gets a collection of toolbox items from the toolbox that match the specified category.
+ System.Drawing.Design.ToolboxItemCollection GetToolboxItems (character, IDesignerHost) Gets the collection of toolbox items that are associated with the specified designer host and category from the toolbox.
+ System.Drawing.Design.ToolboxItemCollection GetToolboxItems (IDesignerHost) Gets the collection of toolbox items that are associated with the specified designer host from the toolbox.
# InitializeBindingSourceFields () Adds the fiels of the BindingSource schema as objects to the Toolbox
- InitializeComponent () Initializes the Visual Design
+ LOGICAL IsSupported (Object, ICollection) Gets a value indicating whether the specified object which represents a serialized toolbox item matches the specified attributes.
+ LOGICAL IsSupported (Object, IDesignerHost) Gets a value indicating whether the specified object which represents a serialized toolbox item can be used by the specified designer host.
+ LOGICAL IsToolboxItem (Object) Gets a value indicating whether the specified object is a serialized toolbox item.
+ LOGICAL IsToolboxItem (Object, IDesignerHost) Gets a value indicating whether the specified object is a serialized toolbox item, using the specified designer host.
# OnLoad (EventArgs) Raises the Load event
+ RemoveCreator (character) Removes a previously added toolbox item creator of the specified data format.
+ RemoveCreator (character, IDesignerHost) Removes a previously added toolbox creator that is associated with the specified data format and the specified designer host.
+ RemoveToolboxItem (ToolboxItem) Removes the specified toolbox item from the toolbox.
+ RemoveToolboxItem (ToolboxItem, character) Removes the specified toolbox item from the toolbox.
+ SelectedToolboxItemUsed () Notifies the toolbox service that the selected tool has been used.
+ System.Object SerializeToolboxItem (ToolboxItem) Gets a serializable object that represents the specified toolbox item.
+ LOGICAL SetCursor () Sets the current application's cursor to a cursor that represents the currently selected tool.
+ SetSelectedToolboxItem (ToolboxItem) Selects the specified toolbox item.
- ultraListView1_MouseDown (Object, MouseEventArgs) Event handler for the MouseDown event of the ultraUltraView1

Top Constructor Summary
Options Name Purpose
+ BindingSourceFieldsForm () Constructor of the BindingSourceFieldsForm class

Top Property Summary
Options Name Purpose
+ Progress.Data.BindingSource BindingSource Gets and sets the reference to the BindingSource
+ System.Drawing.Design.CategoryNameCollection CategoryNames Gets the names of all the tool categories currently on the toolbox.
+ Consultingwerk.Design.SmartComponents.IDesignerControl DesignerControl Gets and sets the Reference to the associated Designer Control instance
+ System.ComponentModel.Design.IDesignerHost DesignerHost Gets and sets the Reference to the associated IDesignerHost instance
+ CHARACTER SelectedCategory Gets or sets the name of the currently selected tool category from the toolbox.


Method Detail
Top

PUBLIC AddCreator (ToolboxItemCreatorCallback, character)

Purpose: Adds a new toolbox item creator for a specified data format.
Notes: Not implemented

Parameters:
creator System.Drawing.Design.ToolboxItemCreatorCallback
A ToolboxItemCreatorCallback that can create a component when the toolbox item is invoked.
format0 CHARACTER
The data format that the creator handles.
Top

PUBLIC AddCreator (ToolboxItemCreatorCallback, character, IDesignerHost)

Purpose: Adds a new toolbox item creator for a specified data format and designer host.
Notes: Not implemented

Parameters:
creator System.Drawing.Design.ToolboxItemCreatorCallback
A ToolboxItemCreatorCallback that can create a component when the toolbox item is invoked.
format0 CHARACTER
The data format that the creator handles.
host System.ComponentModel.Design.IDesignerHost
The IDesignerHost that represents the designer host to associate with the creator.
Top

PUBLIC AddLinkedToolboxItem (ToolboxItem, character, IDesignerHost)

Purpose: Adds the specified project-linked toolbox item to the toolbox in the specified category.
Notes: Not implemented

Parameters:
toolboxItem System.Drawing.Design.ToolboxItem
The linked ToolboxItem to add to the toolbox.
category CHARACTER
The toolbox item category to add the toolbox item to.
host System.ComponentModel.Design.IDesignerHost
The IDesignerHost for the current design document.
Top

PUBLIC AddLinkedToolboxItem (ToolboxItem, IDesignerHost)

Purpose: Adds the specified project-linked toolbox item to the toolbox.
Notes: Not implemented

Parameters:
toolboxItem System.Drawing.Design.ToolboxItem
The linked ToolboxItem to add to the toolbox.
host System.ComponentModel.Design.IDesignerHost
The reference to the IDesignerHost implementation
Top

PUBLIC AddToolboxItem (ToolboxItem)

Purpose: Adds the specified toolbox item to the toolbox.
Notes: Not implemented

Parameters:
toolboxItem System.Drawing.Design.ToolboxItem
The ToolboxItem to add to the toolbox.
Top

PUBLIC AddToolboxItem (ToolboxItem, character)

Purpose: Adds the specified toolbox item to the toolbox in the specified category.
Notes: Not implemented

Parameters:
toolboxItem System.Drawing.Design.ToolboxItem
The ToolboxItem to add to the toolbox.
category CHARACTER
The toolbox item category to add the ToolboxItem to.
Top

PUBLIC System.Drawing.Design.ToolboxItem DeserializeToolboxItem (Object)

Purpose: Gets a toolbox item from the specified object that represents a
toolbox item in serialized form.
Notes:

Parameters:
serializedObject System.Object
The object that contains the ToolboxItem to retrieve.
Returns System.Drawing.Design.ToolboxItem
The ToolboxItem created from deserialization.
Top

PUBLIC System.Drawing.Design.ToolboxItem DeserializeToolboxItem (Object, IDesignerHost)

Purpose: Gets a toolbox item from the specified object that represents a
toolbox item in serialized form, using the specified designer host.
Notes:

Parameters:
serializedObject System.Object
The object that contains the ToolboxItem to retrieve.
host System.ComponentModel.Design.IDesignerHost
The IDesignerHost to associate with this ToolboxItem.
Returns System.Drawing.Design.ToolboxItem
The ToolboxItem created from deserialization.
Top

PUBLIC System.Drawing.Design.ToolboxItem GetSelectedToolboxItem ()

Purpose: Gets the currently selected toolbox item
Notes: Not implemented

Returns System.Drawing.Design.ToolboxItem
The ToolboxItem that is currently selected, or a null reference (Nothing in Visual Basic) if no toolbox item is currently selected.
Top

PUBLIC System.Drawing.Design.ToolboxItem GetSelectedToolboxItem (IDesignerHost)

Purpose: Gets the currently selected toolbox item if it is available to all
designers, or if it supports the specified designer.
Notes: Not implemented

Parameters:
host System.ComponentModel.Design.IDesignerHost
The IDesignerHost that the selected tool must be associated with for it to be returned.
Returns System.Drawing.Design.ToolboxItem
The ToolboxItem that is currently selected, or a null reference (Nothing in Visual Basic) if no toolbox item is currently selected.
Top

PUBLIC System.Drawing.Design.ToolboxItemCollection GetToolboxItems ()

Purpose: Gets the entire collection of toolbox items from the toolbox.
Notes: Not implemented

Returns System.Drawing.Design.ToolboxItemCollection
A ToolboxItemCollection that contains the current toolbox items that are associated with the specified category and designer host.
Top

PUBLIC System.Drawing.Design.ToolboxItemCollection GetToolboxItems (character)

Purpose: Gets a collection of toolbox items from the toolbox that match
the specified category.
Notes: Not implemented

Parameters:
category CHARACTER
The toolbox item category to retrieve the toolbox items from.
Returns System.Drawing.Design.ToolboxItemCollection
A ToolboxItemCollection that contains the current toolbox items that are associated with the specified category and designer host.
Top

PUBLIC System.Drawing.Design.ToolboxItemCollection GetToolboxItems (character, IDesignerHost)

Purpose: Gets the collection of toolbox items that are associated with the
specified designer host and category from the toolbox.
Notes: Not implemented

Parameters:
category CHARACTER
The toolbox item category to retrieve the toolbox items from.
host System.ComponentModel.Design.IDesignerHost
The IDesignerHost that is associated with the toolbox items to retrieve.
Returns System.Drawing.Design.ToolboxItemCollection
A ToolboxItemCollection that contains the current toolbox items that are associated with the specified category and designer host.
Top

PUBLIC System.Drawing.Design.ToolboxItemCollection GetToolboxItems (IDesignerHost)

Purpose: Gets the collection of toolbox items that are associated with
the specified designer host from the toolbox.
Notes: Not implemented

Parameters:
host System.ComponentModel.Design.IDesignerHost
The IDesignerHost that is associated with the toolbox items to retrieve.
Returns System.Drawing.Design.ToolboxItemCollection
A ToolboxItemCollection that contains the current toolbox items that are associated with the specified category and designer host.
Top

PROTECTED InitializeBindingSourceFields ()

Purpose: Adds the fiels of the BindingSource schema as objects to the Toolbox
Notes:

Top

PRIVATE InitializeComponent ()

Purpose: Initializes the Visual Design
Notes:

Top

PUBLIC LOGICAL IsSupported (Object, ICollection)

Purpose: Gets a value indicating whether the specified object which
represents a serialized toolbox item matches the specified attributes.
Notes:

Parameters:
serializedObject System.Object
The object that contains the ToolboxItem to retrieve.
filterAttributes System.Collections.ICollection
An ICollection that contains the attributes to test the serialized object for.
Returns LOGICAL
true if the object matches the specified attributes; otherwise, false.
Top

PUBLIC LOGICAL IsSupported (Object, IDesignerHost)

Purpose: Gets a value indicating whether the specified object which
represents a serialized toolbox item can be used by the specified designer host.
Notes:

Parameters:
serializedObject System.Object
The object that contains the ToolboxItem to retrieve.
host System.ComponentModel.Design.IDesignerHost
The IDesignerHost to test for support for the ToolboxItem.
Returns LOGICAL
true if the specified object is compatible with the specified designer host; otherwise, false.
Top

PUBLIC LOGICAL IsToolboxItem (Object)

Purpose: Gets a value indicating whether the specified object is a serialized
toolbox item.
Notes:

Parameters:
serializedObject System.Object
The object to inspect.
Returns LOGICAL
true if the object contains a toolbox item object; otherwise, false.
Top

PUBLIC LOGICAL IsToolboxItem (Object, IDesignerHost)

Purpose: Gets a value indicating whether the specified object is a serialized
toolbox item, using the specified designer host.
Notes:

Parameters:
serializedObject System.Object
The object to inspect.
host System.ComponentModel.Design.IDesignerHost
The IDesignerHost that is making this request.
Returns LOGICAL
true if the object contains a toolbox item object; otherwise, false.
Top

PROTECTED OnLoad (EventArgs)

Purpose: Raises the Load event
Notes: Invokes InitializeBindingSourceFields

Parameters:
e System.EventArgs
The default .NET System.EventArgs instance of the Load event
Top

PUBLIC RemoveCreator (character)

Purpose: Removes a previously added toolbox item creator of the specified
data format.
Notes:

Parameters:
format0 CHARACTER
The data format of the creator to remove.
Top

PUBLIC RemoveCreator (character, IDesignerHost)

Purpose: Removes a previously added toolbox creator that is associated with
the specified data format and the specified designer host.
Notes:

Parameters:
format0 CHARACTER
The data format of the creator to remove.
host System.ComponentModel.Design.IDesignerHost
The IDesignerHost that is associated with the creator to remove.
Top

PUBLIC RemoveToolboxItem (ToolboxItem)

Purpose: Removes the specified toolbox item from the toolbox.
Notes:

Parameters:
toolboxItem System.Drawing.Design.ToolboxItem
The ToolboxItem to remove from the toolbox.
Top

PUBLIC RemoveToolboxItem (ToolboxItem, character)

Purpose: Removes the specified toolbox item from the toolbox.
Notes:

Parameters:
toolboxItem System.Drawing.Design.ToolboxItem
The ToolboxItem to remove from the toolbox.
category CHARACTER
The toolbox item category to remove the ToolboxItem from.
Top

PUBLIC SelectedToolboxItemUsed ()

Purpose: Notifies the toolbox service that the selected tool has been used.
Notes:

Top

PUBLIC System.Object SerializeToolboxItem (ToolboxItem)

Purpose: Gets a serializable object that represents the specified toolbox item.
Notes:

Parameters:
toolboxItem System.Drawing.Design.ToolboxItem
The ToolboxItem to serialize.
Returns System.Object
An object that represents the specified ToolboxItem.
Top

PUBLIC LOGICAL SetCursor ()

Purpose: Sets the current application's cursor to a cursor that represents the
currently selected tool.
Notes:

Returns LOGICAL
true if the cursor is set by the currently selected tool, false if there is no tool selected and the cursor is set to the standard windows cursor.
Top

PUBLIC SetSelectedToolboxItem (ToolboxItem)

Purpose: Selects the specified toolbox item.
Notes:

Parameters:
toolboxItem System.Drawing.Design.ToolboxItem
The ToolboxItem to select.
Top

PRIVATE ultraListView1_MouseDown (Object, MouseEventArgs)

Purpose: Event handler for the MouseDown event of the ultraUltraView1
Notes:

Parameters:
sender System.Object
The object that raised the event
e System.Windows.Forms.MouseEventArgs
The MouseEventArgs instance that contains the parameters of the event


Constructor Detail
Top

PUBLIC BindingSourceFieldsForm ()

Purpose: Constructor of the BindingSourceFieldsForm class
Notes:



Property Detail
Top

PUBLIC Progress.Data.BindingSource BindingSource

Purpose: Gets and sets the reference to the BindingSource
Notes:

Returns Progress.Data.BindingSource
Top

PUBLIC System.Drawing.Design.CategoryNameCollection CategoryNames

Purpose: Gets the names of all the tool categories currently on the toolbox.
Notes:

Returns System.Drawing.Design.CategoryNameCollection
Top

PUBLIC Consultingwerk.Design.SmartComponents.IDesignerControl DesignerControl

Purpose: Gets and sets the Reference to the associated Designer Control instance
Notes:

Returns Consultingwerk.Design.SmartComponents.IDesignerControl
Top

PUBLIC System.ComponentModel.Design.IDesignerHost DesignerHost

Purpose: Gets and sets the Reference to the associated IDesignerHost instance
Notes:

Returns System.ComponentModel.Design.IDesignerHost
Top

PUBLIC CHARACTER SelectedCategory

Purpose: Gets or sets the name of the currently selected tool category from the toolbox.
Notes:

Returns CHARACTER


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