Consultingwerk.Forms.BaseForm - SmartComponent Library

Namespace:

Consultingwerk.Forms

Class

BaseForm

Parent classes:

Progress.Windows.Form

Consultingwerk.Forms.BaseForm

Inherits:

Progress.Windows.Form

Implements:

Consultingwerk.Forms.IBaseForm, System.ComponentModel.ICustomTypeDescriptor, Consultingwerk.SmartComponents.IHasDesignerVerbs

Inherited by:

File:	BaseForm
Purpose:	Base class for .NET Forms
Syntax:	Contains code to store window postion in the
	Registry (and restore it when Form will be reopened)
	Also implements DependentForms collection which is similar
	to the .NET default OwnedForms collection but does not
	result in the child Form to always stay on top of the
	parent
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Thu May 07 09:40:39 CEST 2009
Notes:	Base class for MdiContainer, SmartWindowsForm and
	EmbeddedWindowForm.
	Use this class as the base class for any .NET Form

Options	Name	Purpose
+	LOGICAL CanFindInComponentsCollection (Object)	Returns if the component can be found in the ComponentsCollection
#	CreateVerbs ()	Creates Designer Verbs based on the DesignerVerbs property
#	CustomizeToolbar ()	Customizes the UltraToolbarController associated with this BaseForm
#	DesignerInsertUserControl ()	Inserts a user control instance at design time.
+	System.Collections.Generic.List <System.Windows.Forms.Control> FindAllControlsOfType (Type)	Returns a List of all Controls in the Form that are of the given type
+	System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents ()	Returns a List of all Components in the Form
+	System.ComponentModel.AttributeCollection GetAttributes ()	Returns a collection of custom attributes for this instance of a component.
+	CHARACTER GetClassName ()	Returns the class name of this instance of a component.
+	CHARACTER GetComponentName ()	Returns the name of this instance of a component.
+	System.ComponentModel.TypeConverter GetConverter ()	Returns a type converter for this instance of a component.
+	System.ComponentModel.EventDescriptor GetDefaultEvent ()	Returns the default event for this instance of a component.
+	System.ComponentModel.PropertyDescriptor GetDefaultProperty ()	Returns the default property for this instance of a component.
+	System.Object GetEditor (Type)	Returns an editor of the specified type for this instance of a component.
+	System.ComponentModel.EventDescriptorCollection GetEvents ()	Returns the events for this instance of a component.
+	System.ComponentModel.EventDescriptorCollection GetEvents (Attribute[])	Returns the events for this instance of a component using the specified attribute array as a filter.
+	System.ComponentModel.PropertyDescriptorCollection GetProperties ()	Returns the properties for this instance of a component.
+	System.ComponentModel.PropertyDescriptorCollection GetProperties (Attribute[])	Returns the properties for this instance of a component using the attribute array as a filter.
+	System.Object GetPropertyOwner (PropertyDescriptor)	Returns an object that contains the property described by the specified property descriptor.
#	LoadRibbonQuickAccessToolbar ()	Restores the Quick Access Toolbar items from the Registry
#	CHARACTER LoadSettings ()	Loads the stored window settings (position etc.) from the registry
#	CHARACTER LoadSettings (character)	Loads stored window settings from the registry
#	OnFormClosed (FormClosedEventArgs)	Raises the FormClosed event
#	OnFormClosing (FormClosingEventArgs)	Raises the FormClosing event
#	OnFormDestroyed (EventArgs)	Raises the FormDestroyed event
#	OnLoad (EventArgs)	Raises the Load event
+	OnVerbClicked (character)	Event Handler method for Designer Verbs
#	RestoreUltraSplitterPosition ()	Restores the position of the Ultra Splitter Controls
#	RestoreWindowPosition ()	Restores the stored window position
-	SetDesignerProperties ()	Sets Properties to customize Visual Designer behaviour
#	StoreRibbonQuickAccessToolbar ()	Stores the current Quick Access Toolbar items in the Registry
#	StoreSettings (character)	Stores the current window settings (position etc.) to the registry
#	StoreSettings (character, character)	Stores window settings to the registry
#	StoreUltraSplitterPosition ()	Stores the position of the UltraSplitter Controls in the Registry
#	StoreWindowPosition ()	Stores the window position to the resgistry

Options

Name

Purpose

LOGICAL CanFindInComponentsCollection (Object)

Returns if the component can be found in the ComponentsCollection

CreateVerbs ()

Creates Designer Verbs based on the DesignerVerbs property

CustomizeToolbar ()

Customizes the UltraToolbarController associated with this BaseForm

DesignerInsertUserControl ()

Inserts a user control instance at design time.

System.Collections.Generic.List <System.Windows.Forms.Control> FindAllControlsOfType (Type)

Returns a List of all Controls in the Form that are of the given type

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

Returns a List of all Components in the Form

System.ComponentModel.AttributeCollection GetAttributes ()

Returns a collection of custom attributes for this instance of a component.

CHARACTER GetClassName ()

Returns the class name of this instance of a component.

CHARACTER GetComponentName ()

Returns the name of this instance of a component.

System.ComponentModel.TypeConverter GetConverter ()

Returns a type converter for this instance of a component.

System.ComponentModel.EventDescriptor GetDefaultEvent ()

Returns the default event for this instance of a component.

System.ComponentModel.PropertyDescriptor GetDefaultProperty ()

Returns the default property for this instance of a component.

System.Object GetEditor (Type)

Returns an editor of the specified type for this instance of a component.

System.ComponentModel.EventDescriptorCollection GetEvents ()

Returns the events for this instance of a component.

System.ComponentModel.EventDescriptorCollection GetEvents (Attribute[])

Returns the events for this instance of a component using the specified attribute array as a filter.

System.ComponentModel.PropertyDescriptorCollection GetProperties ()

Returns the properties for this instance of a component.

System.ComponentModel.PropertyDescriptorCollection GetProperties (Attribute[])

Returns the properties for this instance of a component using the attribute array as a filter.

System.Object GetPropertyOwner (PropertyDescriptor)

Returns an object that contains the property described by the specified property descriptor.

LoadRibbonQuickAccessToolbar ()

Restores the Quick Access Toolbar items from the Registry

CHARACTER LoadSettings ()

Loads the stored window settings (position etc.) from the registry

CHARACTER LoadSettings (character)

Loads stored window settings from the registry

OnFormClosed (FormClosedEventArgs)

Raises the FormClosed event

OnFormClosing (FormClosingEventArgs)

Raises the FormClosing event

OnFormDestroyed (EventArgs)

Raises the FormDestroyed event

OnLoad (EventArgs)

Raises the Load event

OnVerbClicked (character)

Event Handler method for Designer Verbs

RestoreUltraSplitterPosition ()

Restores the position of the Ultra Splitter Controls

RestoreWindowPosition ()

Restores the stored window position

SetDesignerProperties ()

Sets Properties to customize Visual Designer behaviour

StoreRibbonQuickAccessToolbar ()

Stores the current Quick Access Toolbar items in the Registry

StoreSettings (character)

Stores the current window settings (position etc.) to the registry

StoreSettings (character, character)

Stores window settings to the registry

StoreUltraSplitterPosition ()

Stores the position of the UltraSplitter Controls in the Registry

StoreWindowPosition ()

Stores the window position to the resgistry

	Options	Name	Purpose
	+	BaseForm ()	Constructor for the BaseForm class

Options

Name

Purpose

BaseForm ()

Constructor for the BaseForm class

	Options	Name	Purpose
	+	FormDestroyed DELEGATE System.EventHandler	Raised when a Form is destroyed (in the Destructor)

Options

Name

Purpose

FormDestroyed DELEGATE System.EventHandler

Raised when a Form is destroyed (in the Destructor)

Options	Name	Purpose
#	CHARACTER BindableProperties	Property that is used to mark properties (comma-delimited list) that should be Data-Bindable
#	CHARACTER CategorizedProperties	Property that is used to mark properties (comma-delimited list) that should receive a Category attribute
#	CHARACTER CategoryProperties	Categories of the Property in the CategorizedProperty list
+	LOGICAL DeleteOnFormClosed	Gets/Sets if the BaseForm instance should automatically delete itself in the OnFormClosed method (defaults to True). Setting this to FALSE will allow to let the BaseForm instance in memory (when no other reference exists), i.e. to access properties of the Form class when the Form has been closed.
+	System.Collections.Generic.List <Progress.Windows.Form> DependentForms	A list of Forms that are dependent from this Form.
#	CHARACTER DescribedProperties	Property that is used to mark properties (comma-delimited list) that should receive a Description attribute
#	CHARACTER DescriptionProperties	Description of the Property in the DescribedProperties list
#	CHARACTER DesignerVerbs	Property that is used to generate Designer Verbs (actions for the Visual Designer)
#	CHARACTER DesignerVisibilityAttributes	The CHARACTER representation of the DesignerSerializationVisibiltiy attribute (Content/Visible/Hidden), see .NET Enumeration System.ComponentModel.DesignerSerializationVisibility
#	CHARACTER DesignerVisibilityProperties	Property that is used to mark properties (comma-delimited list) that should receive a DesignerSerializationVisibility Attribute
+	LOGICAL DesignTime	Propery flags if the current instance of the SmartBindingSource is running at design time or runtime.
#	CHARACTER HiddenProperties	Property that is used to mark properties (comma-delimited list) that will be excluded from the .NET TypeDescriptor properties list
+	LOGICAL IsClosed	Returns if the Forms has been closed.
#	CHARACTER NonBrowsableProperties	Property that is used to mark properties (comma-delimited list) that should not show up in the Visual Designers Property Grid
+	System.Windows.Forms.FormWindowState PreviousWindowState	Returns the previous WindowState
#	LOGICAL StoreFormPosition	Controls if this Form instance should store and restore the Form position and size.
+	LOGICAL UseStartupSizeAsMinSize	When set to True the OnLoad method will apply the current form (startup size) to the MinimumSize. This will be done before loading the stored Form size from the user profile (e.g. Windows Registry)
+	CHARACTER WindowPositionRegistryKey	Gets and sets the Registry Key used for storing this Forms window position

Options

Name

Purpose

CHARACTER BindableProperties

Property that is used to mark properties (comma-delimited list) that should be Data-Bindable

CHARACTER CategorizedProperties

Property that is used to mark properties (comma-delimited list) that should receive a Category attribute

CHARACTER CategoryProperties

Categories of the Property in the CategorizedProperty list

LOGICAL DeleteOnFormClosed

Gets/Sets if the BaseForm instance should automatically delete itself in the OnFormClosed method (defaults to True). Setting this to FALSE will allow to let the BaseForm instance in memory (when no other reference exists), i.e. to access properties of the Form class when the Form has been closed.

System.Collections.Generic.List <Progress.Windows.Form> DependentForms

A list of Forms that are dependent from this Form.

CHARACTER DescribedProperties

Property that is used to mark properties (comma-delimited list) that should receive a Description attribute

CHARACTER DescriptionProperties

Description of the Property in the DescribedProperties list

CHARACTER DesignerVerbs

Property that is used to generate Designer Verbs (actions for the Visual Designer)

CHARACTER DesignerVisibilityAttributes

The CHARACTER representation of the DesignerSerializationVisibiltiy attribute (Content/Visible/Hidden), see .NET Enumeration System.ComponentModel.DesignerSerializationVisibility

CHARACTER DesignerVisibilityProperties

Property that is used to mark properties (comma-delimited list) that should receive a DesignerSerializationVisibility Attribute

LOGICAL DesignTime

Propery flags if the current instance of the SmartBindingSource is running at design time or runtime.

CHARACTER HiddenProperties

Property that is used to mark properties (comma-delimited list) that will be excluded from the .NET TypeDescriptor properties list

LOGICAL IsClosed

Returns if the Forms has been closed.

CHARACTER NonBrowsableProperties

Property that is used to mark properties (comma-delimited list) that should not show up in the Visual Designers Property Grid

System.Windows.Forms.FormWindowState PreviousWindowState

Returns the previous WindowState

LOGICAL StoreFormPosition

Controls if this Form instance should store and restore the Form position and size.

LOGICAL UseStartupSizeAsMinSize

When set to True the OnLoad method will apply the current form (startup size) to the MinimumSize. This will be done before loading the stored Form size from the user profile (e.g. Windows Registry)

CHARACTER WindowPositionRegistryKey

Gets and sets the Registry Key used for storing this Forms window position

PUBLIC LOGICAL CanFindInComponentsCollection (Object)

PROTECTED CreateVerbs ()

PROTECTED CustomizeToolbar ()

PROTECTED DesignerInsertUserControl ()

PUBLIC System.Collections.Generic.List <System.Windows.Forms.Control> FindAllControlsOfType (Type)

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

PUBLIC System.ComponentModel.AttributeCollection GetAttributes ()

PUBLIC CHARACTER GetClassName ()

PUBLIC CHARACTER GetComponentName ()

PUBLIC System.ComponentModel.TypeConverter GetConverter ()

PUBLIC System.ComponentModel.EventDescriptor GetDefaultEvent ()

PUBLIC System.ComponentModel.PropertyDescriptor GetDefaultProperty ()

PUBLIC System.Object GetEditor (Type)

PUBLIC System.ComponentModel.EventDescriptorCollection GetEvents ()

PUBLIC System.ComponentModel.EventDescriptorCollection GetEvents (Attribute[])

PUBLIC System.ComponentModel.PropertyDescriptorCollection GetProperties ()

PUBLIC System.ComponentModel.PropertyDescriptorCollection GetProperties (Attribute[])

PUBLIC System.Object GetPropertyOwner (PropertyDescriptor)

PROTECTED LoadRibbonQuickAccessToolbar ()

PROTECTED CHARACTER LoadSettings ()

PROTECTED CHARACTER LoadSettings (character)

PROTECTED OnFormClosed (FormClosedEventArgs)

PROTECTED OnFormClosing (FormClosingEventArgs)

PROTECTED OnFormDestroyed (EventArgs)

PROTECTED OnLoad (EventArgs)

PUBLIC OnVerbClicked (character)

PROTECTED RestoreUltraSplitterPosition ()

PROTECTED RestoreWindowPosition ()

PRIVATE SetDesignerProperties ()

PROTECTED StoreRibbonQuickAccessToolbar ()

PROTECTED StoreSettings (character)

PROTECTED StoreSettings (character, character)

PROTECTED StoreUltraSplitterPosition ()

PROTECTED StoreWindowPosition ()

PUBLIC BaseForm ()

PUBLIC FormDestroyed DELEGATE System.EventHandler

PROTECTED CHARACTER BindableProperties

PROTECTED CHARACTER CategorizedProperties

PROTECTED CHARACTER CategoryProperties

PUBLIC LOGICAL DeleteOnFormClosed

PUBLIC System.Collections.Generic.List <Progress.Windows.Form> DependentForms

PROTECTED CHARACTER DescribedProperties

PROTECTED CHARACTER DescriptionProperties

PROTECTED CHARACTER DesignerVerbs

PROTECTED CHARACTER DesignerVisibilityAttributes

PROTECTED CHARACTER DesignerVisibilityProperties

PUBLIC LOGICAL DesignTime

PROTECTED CHARACTER HiddenProperties

PUBLIC LOGICAL IsClosed

PROTECTED CHARACTER NonBrowsableProperties

PUBLIC System.Windows.Forms.FormWindowState PreviousWindowState

PROTECTED LOGICAL StoreFormPosition

PUBLIC LOGICAL UseStartupSizeAsMinSize

PUBLIC CHARACTER WindowPositionRegistryKey