Namespace: Consultingwerk.SmartComponents.Implementation
Class 
SmartDataBrowser Copy to Clipboard
Parent classes:
Infragistics.Win.UltraWinGrid.UltraGrid
Consultingwerk.SmartComponents.Base.SmartBrowserControl
Consultingwerk.SmartComponents.Implementation.SmartDataBrowser

Inherits: Consultingwerk.SmartComponents.Base.SmartBrowserControl
Implements: Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataTarget, Consultingwerk.SmartComponents.Interfaces.IAfterRetrieveDataSubscriber, Consultingwerk.SmartComponents.Interfaces.ICheckOkToClose, System.ComponentModel.ICustomTypeDescriptor, Consultingwerk.SmartComponents.IHasDesignerVerbs, Consultingwerk.SmartComponents.Interfaces.ISmartDataBrowser, Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget, Consultingwerk.SmartComponents.Interfaces.ISmartDataTargetWithBindingSource
Inherited by: Consultingwerk.SmartComponents.Implementation.SmartDynamicBrowser Consultingwerk.SmartComponents.Implementation.SmartUpdatableBrowser Consultingwerk.SmartComponents.Implementation.SmartDynamicUpdatableBrowser

File:SmartDataBrowser
Author(s):Marko Rüterbories / Consultingwerk Ltd.
Created:Wed Feb 18 09:19:52 CET 2009

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



Top Method Summary
Options Name Purpose
+ ActivateCurrentRow () Activates the current grid row during Update/Delete/Copy in a Viewer
# AfterQueryPositionChangedHandler (Object, EventArgs) Activates the current query row (on add and delete)
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ AfterRetrieveDataCallback (ISmartDataSource) Callback method for the AfterRetrieveData event
Overrides Consultingwerk.SmartComponents.Base.SmartBrowserControl:AfterRetrieveDataCallback (ISmartDataSource)
+ ApplyGridSettings (character) Applies stored Grid Settings
+ AttachBindingSource (BindingSource) This Method attaches a new BindingSource given as the Parameter poBindingSource to the Objects of the current Class. The new BindingSource may be created by a DataAdapter or borrowed from a Browser. It is called by the SmartDataAdapter Class when creating a new BindingSource or when a new SmartDataSource is registered to the Class implementing the Interface ISmartDataTarget.
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# BeginUpdateStateHandler (Object, DataSourceUpdateStateEventArgs) Event handler for the BeginUpdateState event of the data source
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# BindingSourceListChangedHandler (Object, ListChangedEventArgs) Handles the ListChanged event of the BindingSource
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# ClearFilterRow (FilterClearButtonUIElement) Clears the Filter Row
# CollectFilterValuesHandler (Object, CollectFilterValuesEventArgs) Event handler for the CollectFilterValues event of the ISmartFilterTarget
Overrides Consultingwerk.SmartComponents.Base.SmartBrowserControl:CollectFilterValuesHandler (Object, CollectFilterValuesEventArgs)
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
# DeleteRecord () This Method is a dispatcher to call DeleteRow inside of the SmartDataSource of the current Class. It is called by the SmartTableIOSources SmartToolbarController or SmartToolStripContainer if the tool to delete a record is pressed and by the SmartDataBrowser if the AfterRowsDeleted Event fires.
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# DeregisterBindingSourceEvents () Deregisters events of the BindingSource
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ DisableDelKeyUsage () Disable the usage of the Del key for the entire Grid
# DisableForUpdate (ISmartDataTarget) Disable the Controls during an Update. This Method is called by the SmartDataAdapter by a call to BeginUpdateState () which is defined in the Interface ISmartDataSource.
Overrides Consultingwerk.SmartComponents.Base.SmartBrowserControl:DisableForUpdate (ISmartDataTarget)
+ DisableMultiSelection () Disables selection of multiple rows in the SmartDataBrowser
# DisposedHandler (Object, EventArgs) Event handler for the Disposed event of the SmartBrowserControl
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# EnableAfterUpdate () Enable the Controls after an Update. This Method is called by the SmartDataAdapter when setting the SmartDataSourceState Property to Navigatable. Enforced by Interface ISmartDataTarget.
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ EnableMultiSelection () Enabels selection of multiple rows in the SmartDataBrowser
# EnableSmartFilterUserInterface () Enables te SmartFilter UI
# EndUpdateStateHandler (Object, DataSourceUpdateStateEventArgs) Event handler for the EndUpdateState event of the data source
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ EvaluateTableIOState () Updateable Browsers are not supported by this class but the Method is enforced by the Interface ISmartDataTarget.
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ CHARACTER ExportToExcel () Exports the browsers contents to an Excel file using the UltraGrid Excel Exported
+ CHARACTER ExportToExcel (IUltraGridExcelExportParameter) Exports the browsers contents to an Excel file using the UltraGrid Excel Exported
# FormatColumnFilters () Assigns the default column filter type for numeric and date columns to GreaterThanOrEqualTo
# FormatColumns () Formats numeric columns (Integer, Decimal). Invoked from the method InitializeLayoutHandler. * All Bands and Columns are processed and if the DisplayStyle has not been changed in the Visual Designer, Integer and Decimal fields get formatted according to their datatype.
# FormatGrid () Formats the Grid Appearance
# FormatSmartColumns () Formats special columns supported by the SmartFramework functionality
+ 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.
+ CHARACTER GetCurrentSettings () Returns a string with the current Grid settings
+ 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.
+ GetSelectedRowsDataset (dataset-handle) Returns a ProDataset with a copy of the selected rows
# HideNonVisibleColumns () Hides the non visible Columns from the Grid
# InitializeColumnFilterOperatorItems () Initializes the Column Filer Operator DropDown Items
# InitializeLayoutHandler (Object, InitializeLayoutEventArgs) Handle default behaviour of the Grid and apply a default layout. This Method is called if the InitializeLayout Event of the UltraGrid is fired.
+ LOGICAL IsOkToClose (logical, CloseReason) Check if it is ok to close the parent form.
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# CHARACTER LoadSettings () Loads a browsers column settings from the Registry
# OnAfterDeleteRecord (EventArgs) Raises the AfterDeleteRecord event
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# OnAfterRowRegionScroll (RowScrollRegionEventArgs) Raises the OnAfterRowRegionScroll event
# OnBeforeDeleteRecord (CancelEventArgs) Raises the BeforeDeleteRecord event
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# OnBeforeSortChange (BeforeSortChangeEventArgs) Raises the BeforeSortChange event
# OnBeginInit () Invoked at the beginning of a Containers InitializeComponents method
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# OnCreateControl () Raises the CreateControl event
# OnDefaultAction (EventArgs) Raises the DefaultAction event
# OnDoubleClickRow (DoubleClickRowEventArgs) Raises the DoubleClickRow event
# OnEndInit () Invoked at the end of a Containers InitializeComponents method
Overrides Consultingwerk.SmartComponents.Base.SmartBrowserControl:OnEndInit ()
# OnEnter (EventArgs) Raises the Enter event
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# OnGotFocus (EventArgs) Raises the GotFocus event.
# OnHandleCreated (EventArgs) Raises the HandleCreated event
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# OnKeyDown (KeyEventArgs) Raises the KeyDown Event
# OnMouseUp (MouseEventArgs) Raises the MouseUp event
# OnMouseWheel (MouseEventArgs) Raises the MouseWheel Event
# OnSmartBrowserListChanged (SmartBrowserListChangedEventArgs) Raises the SmartBrowserListChanged
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# OnSmartDataBrowserActivated (Object, EventArgs) Raises the SmartDataBrowserActivated event
# OnSmartFilterActiveChanged (EventArgs) Raises the SmartFilterActiveChanged
+ OnVerbClicked (character) Event Handler method for Designer Verbs
# ParentFormClosedHandler (Object, FormClosedEventArgs) Event handler for the FormClosed event of the Parent Form
# ParentFormDestroyedHandler (Object, EventArgs) Event handler for the FormDestroyed event of the owning Form
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# PerformFilterRow () Performs the Filter Row
# RegisterBindingSourceEvents () Registers events of the BindingSource
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ RegisterDefaultActionSubscriber (IDefaultActionSubscriber) Register a new DefaultActionSubscriber (Class that implements IDefaultActionSubscriber).
# RestoreSettings () Restores the actual browser column settings
+ ResumeRowSynchronizationAfterReposition () Resume row syncronization
# SaveSettings () Stores a browsers column settings to the Registry
# ScrollOffHome () Fetches the previous batch from the DataSource
+ ScrollToCurrentRow (logical) Scrolls to the BindingSource's position
+ ScrollToCurrentRow (logical, logical) Scrolls to the BindingSource's position
+ ScrollToFirstRow () Scrolls the Grid to the First Row
+ ScrollToLastRow () Scrolls the Grid to the Last Row
+ SelectAllRows () Selects all rows in the Grid
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
- SetDesignerProperties () Set properties for ICustomTypeDescriptor
+ SetGridReadOnly () Set the entire Grid to Read-Only
# SetMultiSelection (logical) Enables or Disables multi-selection in the Grid
+ StartEditModeInViewer () Invokes EnableFields (Update) in a Viewer linked to the same SmartDataAdapter
# StoreSettings (character) Stores a browsers column settings to the Registry
# StoreVisibleGridColumns () Stores the currently visible columns (of band 0) in the VisibleGridColumns property
+ SuspendRowSynchronizationForReposition () Suspends row syncronization
+ UpdateSortIndicator (character) Updates the Sort Indicators of the SmartDataBrowser columns

Top Constructor Summary
Options Name Purpose
+ SmartDataBrowser () Creates a new Instance of SmartDataBrowser and subscribes Handlers to Events.

Top Event Summary
Options Name Purpose
+ AfterDeleteRecord DELEGATE System.EventHandler Event fired when the viewer has successfully deleted a record.
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ BeforeDeleteRecord DELEGATE System.ComponentModel.CancelEventHandler Event fired when the Viewer starts deleting a record. This event is cancellable
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ DefaultAction DELEGATE System.EventHandler Event that combines double click on a data row or the selection of the Return or Enter key
+ SmartBrowserListChanged (Object, SmartBrowserListChangedEventArgs) Raised when the ListChanged event of the BindingSource of the SmartBrowserControl is raised
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ SmartDataBrowserActivated DELEGATE System.EventHandler Static event raised whenever a SmartDataBrowser is activated. This event is useful to control a central UltraGridColumnChooser etc.
+ SmartFilterActiveChanged (Object, EventArgs) Raised when the SmartFilterActiveChanged property is changed

Top Property Summary
Options Name Purpose
# CHARACTER BindableProperties
+ Progress.Data.BindingSource BindingSource
# CHARACTER CategorizedProperties
# CHARACTER CategoryProperties
+ LOGICAL DeleteDataSourceOnFormClosed
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# CHARACTER DescribedProperties
# CHARACTER DescriptionProperties
+ LOGICAL DeselectRowsOnActivate
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# CHARACTER DesignerVerbs
# CHARACTER DesignerVisibilityAttributes
# CHARACTER DesignerVisibilityProperties
# LOGICAL DesignTime
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ LOGICAL EditInViewerOnDefaultAction
+ LOGICAL FetchAllRecordsOnGroupBy
# CHARACTER HiddenProperties
+ LOGICAL Initializing
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource LinkDataSource
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# CHARACTER NonBrowsableProperties
# LOGICAL ParentFormDestroyed
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# LOGICAL ParentFormDestroyedSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ INTEGER RepositionedRow
+ LOGICAL SaveColumnSettings
+ CHARACTER SettingsKey
+ Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ LOGICAL SmartFilterActive
+ LOGICAL SmartFilterUseMatches
+ LOGICAL SmartFilterUseOperators
+ CHARACTER SmartFilterWordIndexColumns
+ LOGICAL StoreVisibleGridColumns
+ CHARACTER VisibleGridColumns


Method Detail
Top

PUBLIC ActivateCurrentRow ()
Purpose: Activates the current grid row during Update/Delete/Copy in a Viewer
Notes:

Top

PROTECTED AfterQueryPositionChangedHandler (Object, EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Activates the current query row (on add and delete)
Notes: Event handler for the AfterQueryPositionChanged event of the ISmartDataSource

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

PUBLIC AfterRetrieveDataCallback (ISmartDataSource)
Overrides Consultingwerk.SmartComponents.Base.SmartBrowserControl:AfterRetrieveDataCallback (ISmartDataSource)
Purpose: Callback method for the AfterRetrieveData event
Notes: Executed by the SmartDataAdapter class with the AfterRetrieveData
event

Parameters:
sender Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
The reference to the ISmartDataSource that invoked the Callback method
Top

PUBLIC ApplyGridSettings (character)
Purpose: Applies stored Grid Settings
Notes:

Parameters:
pcSettings CHARACTER
The character value representing the grid settings
Top

PUBLIC AttachBindingSource (BindingSource)
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: This Method attaches a new BindingSource given as the Parameter
poBindingSource to the Objects of the current Class. The new
BindingSource may be created by a DataAdapter or borrowed from a
Browser.
It is called by the SmartDataAdapter Class when creating a new
BindingSource or when a new SmartDataSource is registered to the
Class implementing the Interface ISmartDataTarget.
Notes: Enforced by Interface ISmartDataTarget.

Parameters:
poBindingSource Progress.Data.BindingSource
The BindingSource to be attached to the Grids DataSource Property.
Top

PROTECTED BeginUpdateStateHandler (Object, DataSourceUpdateStateEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Event handler for the BeginUpdateState event of the data source
Notes:

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

PROTECTED BindingSourceListChangedHandler (Object, ListChangedEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Handles the ListChanged event of the BindingSource
Notes:

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

PROTECTED ClearFilterRow (FilterClearButtonUIElement)
Purpose: Clears the Filter Row
Notes: Method overridden in the SmartUpdatableBrowse to allow to save pending
updates before clearing the filter

Parameters:
poUIElement Infragistics.Win.UltraWinGrid.FilterClearButtonUIElement
The UIElement that was clicked to distinguish between clear filter row and a single filter cell
Top

PROTECTED CollectFilterValuesHandler (Object, CollectFilterValuesEventArgs)
Overrides Consultingwerk.SmartComponents.Base.SmartBrowserControl:CollectFilterValuesHandler (Object, CollectFilterValuesEventArgs)
Purpose: Event handler for the CollectFilterValues event of the ISmartFilterTarget
Notes: Attaches the Grids filter values to the Query Expression when the Grid's
SmartFilterActive attribute is set to TRUE

Parameters:
sender Progress.Lang.Object
The object that raised the CollectFilterValues event
e Consultingwerk.SmartComponents.Implementation.CollectFilterValuesEventArgs
The CollectFilterValuesEventArgs with the data for this event
Top

PROTECTED CreateVerbs ()
Purpose: Creates Designer Verbs based on the DesignerVerbs property
Notes:

Top

PROTECTED DeleteRecord ()
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: This Method is a dispatcher to call DeleteRow inside of the
SmartDataSource of the current Class.
It is called by the SmartTableIOSources SmartToolbarController or
SmartToolStripContainer if the tool to delete a record is pressed
and by the SmartDataBrowser if the AfterRowsDeleted Event fires.
Notes:

Top

PROTECTED DeregisterBindingSourceEvents ()
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Deregisters events of the BindingSource
Notes:

Top

PUBLIC DisableDelKeyUsage ()
Purpose: Disable the usage of the Del key for the entire Grid
Notes: Invoked from the method InitializeLayoutHandler

Top

PROTECTED DisableForUpdate (ISmartDataTarget)
Overrides Consultingwerk.SmartComponents.Base.SmartBrowserControl:DisableForUpdate (ISmartDataTarget)
Purpose: Disable the Controls during an Update.
This Method is called by the SmartDataAdapter by a call to
BeginUpdateState () which is defined in the Interface ISmartDataSource.
Notes: Enforced by Interface ISmartDataTarget.

Parameters:
poSmartDataTarget Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget
The ISmartDataTarget instance that is in update mode
Top

PUBLIC DisableMultiSelection ()
Purpose: Disables selection of multiple rows in the SmartDataBrowser
Notes:

Top

PROTECTED DisposedHandler (Object, EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Event handler for the Disposed event of the SmartBrowserControl
Notes:

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

PROTECTED EnableAfterUpdate ()
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Enable the Controls after an Update.
This Method is called by the SmartDataAdapter when setting the
SmartDataSourceState Property to Navigatable.
Enforced by Interface ISmartDataTarget.
Notes: Use this only in a Browser!

Top

PUBLIC EnableMultiSelection ()
Purpose: Enabels selection of multiple rows in the SmartDataBrowser
Notes: It is required to set DeselectRowsOnActivate = FALSE when using this
method

Top

PROTECTED EnableSmartFilterUserInterface ()
Purpose: Enables te SmartFilter UI
Notes:

Top

PROTECTED EndUpdateStateHandler (Object, DataSourceUpdateStateEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Event handler for the EndUpdateState event of the data source
Notes:

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

PUBLIC EvaluateTableIOState ()
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Updateable Browsers are not supported by this class but the Method
is enforced by the Interface ISmartDataTarget.
Notes:

Top

PUBLIC CHARACTER ExportToExcel ()
Purpose: Exports the browsers contents to an Excel file using the UltraGrid Excel Exported
Notes:

Returns CHARACTER
The filename of the exported document
Top

PUBLIC CHARACTER ExportToExcel (IUltraGridExcelExportParameter)
Purpose: Exports the browsers contents to an Excel file using the UltraGrid Excel Exported
Notes:

Parameters:
poOptions Consultingwerk.Windows.Util.IUltraGridExcelExportParameter
The IUltraGridExcelExportParameter for this export
Returns CHARACTER
The filename of the exported document
Top

PROTECTED FormatColumnFilters ()
Purpose: Assigns the default column filter type for numeric and date columns
to GreaterThanOrEqualTo
Notes: Keeps the default visualization in sync with the comparison types
used by UltraGridFilterRowHelper class

Top

PROTECTED FormatColumns ()
Purpose: Formats numeric columns (Integer, Decimal).
Invoked from the method InitializeLayoutHandler.
All Bands and Columns are processed and if the DisplayStyle has not
been changed in the Visual Designer, Integer and Decimal fields get
formatted according to their datatype.
Notes:

Top

PROTECTED FormatGrid ()
Purpose: Formats the Grid Appearance
Notes: Sets the Color of the ActiveRow Appearance if not yet set.

Top

PROTECTED FormatSmartColumns ()
Purpose: Formats special columns supported by the SmartFramework functionality
Notes:

Top

PUBLIC System.ComponentModel.AttributeCollection GetAttributes ()
Purpose: Returns a collection of custom attributes for this instance of a
component.
Notes:

Returns System.ComponentModel.AttributeCollection
The System.ComponentModel.AttributeCollection describing the types attributes
Top

PUBLIC CHARACTER GetClassName ()
Purpose: Returns the class name of this instance of a component.
Notes:

Returns CHARACTER
The class name of the Component
Top

PUBLIC CHARACTER GetComponentName ()
Purpose: Returns the name of this instance of a component.
Notes:

Returns CHARACTER
The Component Name of this instance
Top

PUBLIC System.ComponentModel.TypeConverter GetConverter ()
Purpose: Returns a type converter for this instance of a component.
Notes:

Returns System.ComponentModel.TypeConverter
The System.ComponentModel.TypeConverter for this instance of a component.
Top

PUBLIC CHARACTER GetCurrentSettings ()
Purpose: Returns a string with the current Grid settings
Notes:

Returns CHARACTER
The string representing the current grid settings
Top

PUBLIC System.ComponentModel.EventDescriptor GetDefaultEvent ()
Purpose: Returns the default event for this instance of a component.
Notes:

Returns System.ComponentModel.EventDescriptor
The System.ComponentModel.EventDescriptor for the default event of this component
Top

PUBLIC System.ComponentModel.PropertyDescriptor GetDefaultProperty ()
Purpose: Returns the default property for this instance of a component.
Notes:

Returns System.ComponentModel.PropertyDescriptor
The System.ComponentModel.PropertyDescriptor for the default property of the component
Top

PUBLIC System.Object GetEditor (Type)
Purpose: Returns an editor of the specified type for this instance of a
component.
Notes:

Parameters:
editorBaseType System.Type
A System.Type that represents the editor for this object.
Returns System.Object
The reference to the Editor of the type of the component instance
Top

PUBLIC System.ComponentModel.EventDescriptorCollection GetEvents ()
Purpose: Returns the events for this instance of a component.
Notes:

Returns System.ComponentModel.EventDescriptorCollection
The System.ComponentModel.EventDescriptorCollection describing the events of the component
Top

PUBLIC System.ComponentModel.EventDescriptorCollection GetEvents (Attribute[])
Purpose: Returns the events for this instance of a component using the
specified attribute array as a filter.
Notes:

Parameters:
attributes System.Attribute[]
A System.Attribute[] that is used as a filter.
Returns System.ComponentModel.EventDescriptorCollection
The System.ComponentModel.EventDescriptorCollection describing the events of the component
Top

PUBLIC System.ComponentModel.PropertyDescriptorCollection GetProperties ()
Purpose: Returns the properties for this instance of a component.
Notes:

Returns System.ComponentModel.PropertyDescriptorCollection
A System.ComponentModel.PropertyDescriptorCollection that represents the properties for this component instance.
Top

PUBLIC System.ComponentModel.PropertyDescriptorCollection GetProperties (Attribute[])
Purpose: Returns the properties for this instance of a component using the
attribute array as a filter.
Notes:

Parameters:
attributes System.Attribute[]
A System.Attribute[] that is used as a filter.
Returns System.ComponentModel.PropertyDescriptorCollection
A System.ComponentModel.PropertyDescriptorCollection that represents the properties for this component instance.
Top

PUBLIC System.Object GetPropertyOwner (PropertyDescriptor)
Purpose: Returns an object that contains the property described by the
specified property descriptor.
Notes:

Parameters:
pd System.ComponentModel.PropertyDescriptor
A System.ComponentModel.PropertyDescriptor that represents the property whose owner is to be found.
Returns System.Object
An System.Object that represents the owner of the specified property.
Top

PUBLIC GetSelectedRowsDataset (dataset-handle)
Purpose: Returns a ProDataset with a copy of the selected rows
Notes: Useful for routines that need to process the selected rows
Only supported when the SmartDataSource is a SmartDatasetAdapter
extended type, e.g. SmartBusinessEntityAdapter, SmartDatasetChildAdapter

Parameters:
phDataset DATASET-HANDLE
OUTPUT DATASET-HANDLE The Dataset containing the duplicates of the rows
Top

PROTECTED HideNonVisibleColumns ()
Purpose: Hides the non visible Columns from the Grid
Notes: Following the VisibleGridColumns Property

Top

PROTECTED InitializeColumnFilterOperatorItems ()
Purpose: Initializes the Column Filer Operator DropDown Items
Notes: Invoked from the EnableSmartFilterUserInterface method (InitializaLayoutHandler)
when the SmartFilterUseOperators property is TRUE

Top

PROTECTED InitializeLayoutHandler (Object, InitializeLayoutEventArgs)
Purpose: Handle default behaviour of the Grid and apply a default layout.
This Method is called if the InitializeLayout Event of the UltraGrid
is fired.
Notes:

Parameters:
sender System.Object
Indicates which Object has raised the Event
e Infragistics.Win.UltraWinGrid.InitializeLayoutEventArgs
The InitializeLayoutEventArgs with the data for this event
Top

PUBLIC LOGICAL IsOkToClose (logical, CloseReason)
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Check if it is ok to close the parent form.
Notes: This class does always return TRUE, as a read-only browser has no
reason to prevent closing the parent form

Parameters:
plShowMessage LOGICAL
When TRUE a message is Shown explaining why it is not ok to close the parent form
poCloseReason System.Windows.Forms.CloseReason
The System.Windows.Forms.CloseReason passed from then OnFormClosing Method of the parent form giving the reason why the form is closed
Returns LOGICAL
Logical value indicating if the parent Form may be closed
Top

PROTECTED CHARACTER LoadSettings ()
Purpose: Loads a browsers column settings from the Registry
Notes:

Returns CHARACTER
The settings for this Grid instance
Top

PROTECTED OnAfterDeleteRecord (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Raises the AfterDeleteRecord event
Notes:

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

PROTECTED OnAfterRowRegionScroll (RowScrollRegionEventArgs)
Purpose: Raises the OnAfterRowRegionScroll event
Notes: Occurs after a row scrolling region is scrolled.

Parameters:
e Infragistics.Win.UltraWinGrid.RowScrollRegionEventArgs
Infragistics.Win.UltraWinGrid.RowScrollRegionEventArgs
Top

PROTECTED OnBeforeDeleteRecord (CancelEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Raises the BeforeDeleteRecord event
Notes:

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

PROTECTED OnBeforeSortChange (BeforeSortChangeEventArgs)
Purpose: Raises the BeforeSortChange event
Notes:

Parameters:
e Infragistics.Win.UltraWinGrid.BeforeSortChangeEventArgs
The BeforeSortChangeEventArgs with the data for this event
Top

PROTECTED OnBeginInit ()
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Invoked at the beginning of a Containers InitializeComponents
method
Notes: Enforced by System.ComponentModel.ISupportInitialize
http://msdn.microsoft.com/de-de/library/system.componentmodel.isupportinitialize.begininit(VS.80).aspx

Top

PROTECTED OnCreateControl ()
Purpose: Raises the CreateControl event
Notes: The OnCreateControl method is called when the control is first
created

Top

PROTECTED OnDefaultAction (EventArgs)
Purpose: Raises the DefaultAction event
Notes:

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

PROTECTED OnDoubleClickRow (DoubleClickRowEventArgs)
Purpose: Raises the DoubleClickRow event
Notes:

Parameters:
e Infragistics.Win.UltraWinGrid.DoubleClickRowEventArgs
The DoubleClickRowEventArgs with the Data for this event
Top

PROTECTED OnEndInit ()
Overrides Consultingwerk.SmartComponents.Base.SmartBrowserControl:OnEndInit ()
Purpose: Invoked at the end of a Containers InitializeComponents method
Notes: Enforced by System.ComponentModel.ISupportInitialize
http://msdn.microsoft.com/de-de/library/system.componentmodel.isupportinitialize.endinit(VS.80).aspx

Top

PROTECTED OnEnter (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Raises the Enter event
Notes:

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

PROTECTED OnGotFocus (EventArgs)
Purpose: Raises the GotFocus event.
Notes:

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

PROTECTED OnHandleCreated (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Raises the HandleCreated event
Notes:

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

PROTECTED OnKeyDown (KeyEventArgs)
Purpose: Raises the KeyDown Event
Notes: Used to trap Cursor-Up and Page-Up to implement backwards-batching

Parameters:
e System.Windows.Forms.KeyEventArgs
The KeyEventArgs with the data for this event
Top

PROTECTED OnMouseUp (MouseEventArgs)
Purpose: Raises the MouseUp event
Notes: Handles the pressing of the Grid's FilterClearButtonUIElement to handle
the clearing of the SmartFilter Row

Parameters:
e System.Windows.Forms.MouseEventArgs
The MouseEventArgs with the data for this event
Top

PROTECTED OnMouseWheel (MouseEventArgs)
Purpose: Raises the MouseWheel Event
Notes: Used implement backwards-batching

Parameters:
e System.Windows.Forms.MouseEventArgs
System.Windows.Forms.MouseEventArgs
Top

PROTECTED OnSmartBrowserListChanged (SmartBrowserListChangedEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Raises the SmartBrowserListChanged
Notes:

Parameters:
e SmartBrowserListChangedEventArgs
The SmartBrowserListChangedEventArgs with the data for the event
Top

PROTECTED OnSmartDataBrowserActivated (Object, EventArgs)
Purpose: Raises the SmartDataBrowserActivated event
Notes: Static event raised whenever a SmartDataBrowser is activated. This
event is useful to control a central UltraGridColumnChooser etc.
This method may be removed using the NoStaticsInHybrids setting
in Consultingwerk/products.i. This allows to avoid static members
in hybrid classes SmartDataBrowser and SmartBusinessEntityAdapter
to avoid issues with the combination of static and hybrids on 11.2
and 11.3, OE defect OE00240707 http://knowledgebase.progress.com/articles/Article/000042229?popup=true

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 OnSmartFilterActiveChanged (EventArgs)
Purpose: Raises the SmartFilterActiveChanged
Notes:

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

PUBLIC OnVerbClicked (character)
Purpose: Event Handler method for Designer Verbs
Notes: This method is intended to be overridden

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

PROTECTED ParentFormClosedHandler (Object, FormClosedEventArgs)
Purpose: Event handler for the FormClosed event of the Parent Form
Notes:

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

PROTECTED ParentFormDestroyedHandler (Object, EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
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 PerformFilterRow ()
Purpose: Performs the Filter Row
Notes:

Top

PROTECTED RegisterBindingSourceEvents ()
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Registers events of the BindingSource
Notes:

Top

PUBLIC RegisterDefaultActionSubscriber (IDefaultActionSubscriber)
Purpose: Register a new DefaultActionSubscriber (Class that implements
IDefaultActionSubscriber).
Notes:

Parameters:
poDefaultActionSubscriber Consultingwerk.SmartComponents.Interfaces.IDefaultActionSubscriber
The IDefaultActionSubscriber instance to register
Top

PROTECTED RestoreSettings ()
Purpose: Restores the actual browser column settings
Notes: SUBSTITUTE ("&1,&2,&3,&4":U,
THIS-OBJECT:DisplayLayout:Bands[0]:Columns[i]:Key, DisplayLayout:Bands[0]:Columns[i]:Key,
THIS-OBJECT:DisplayLayout:Bands[0]:Columns[i]:Width, DisplayLayout:Bands[0]:Columns[i]:Width,
THIS-OBJECT:DisplayLayout:Bands[0]:Columns[i]:Header:VisiblePosition, DisplayLayout:Bands[0]:Columns[i]:Header:VisiblePosition,
THIS-OBJECT:DisplayLayout:Bands[0]:Columns[i]:Hidden) DisplayLayout:Bands[0]:Columns[i]:Hidden) .

Top

PUBLIC ResumeRowSynchronizationAfterReposition ()
Purpose: Resume row syncronization
Notes: SuspendRowSynchronization and ResumeRowSynchronization methods can
be used to temporarily suspend UltraGrid from responding to data
source change notifications. When row syncrhonization is suspended,
the UltraGrid will still mark the rows dirty so it will re-create
the rows next time it gets painted.

Top

PROTECTED SaveSettings ()
Purpose: Stores a browsers column settings to the Registry
Notes: This methods builds the settings string of the Grid that will
actually be stored using the StoreSettings method (so this
can be overloaded independently).

Top

PROTECTED ScrollOffHome ()
Purpose: Fetches the previous batch from the DataSource
Notes: Uses the OffHome method of the Adapter. The Adapter needs to implement
ISupportsScrollup

Top

PUBLIC ScrollToCurrentRow (logical)
Purpose: Scrolls to the BindingSource's position
Notes: Enforces reposition/scolling also to rows already visible (previous default)

Parameters:
plAllRegions LOGICAL
Logical value indicating if all RowScrollRegions will be positioned to the current row of just the first one.
Top

PUBLIC ScrollToCurrentRow (logical, logical)
Purpose: Scrolls to the BindingSource's position
Notes:

Parameters:
plAllRegions LOGICAL
Logical value indicating if all RowScrollRegions will be positioned to the current row of just the first one.
plEnforeScroll LOGICAL
Logical set to false to indicate that we should only scroll when the row would otherwise not be visible, FALSE is the ABL Browse widget's SET-REPOSITIONED-ROW CONDITIONAL behaviour
Top

PUBLIC ScrollToFirstRow ()
Purpose: Scrolls the Grid to the First Row
Notes:

Top

PUBLIC ScrollToLastRow ()
Purpose: Scrolls the Grid to the Last Row
Notes:

Top

PUBLIC SelectAllRows ()
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Selects all rows in the Grid
Notes:

Top

PRIVATE SetDesignerProperties ()
Purpose: Set properties for ICustomTypeDescriptor
Notes:

Top

PUBLIC SetGridReadOnly ()
Purpose: Set the entire Grid to Read-Only
Notes: Invoked from the method InitializeLayoutHandler
All Bands and Columns are processed and set into read only mode

Top

PROTECTED SetMultiSelection (logical)
Purpose: Enables or Disables multi-selection in the Grid
Notes:

Parameters:
plEnable LOGICAL
Logical value indicating if multi-selection should be possible
Top

PUBLIC StartEditModeInViewer ()
Purpose: Invokes EnableFields (Update) in a Viewer linked to the same
SmartDataAdapter
Notes:

Top

PROTECTED StoreSettings (character)
Purpose: Stores a browsers column settings to the Registry
Notes: This methods stores the actual settings string of the Grid that have
been built by SaveSettings method (so this
can be overloaded independently).

Parameters:
pcSettings CHARACTER
The settings string to store
Top

PROTECTED StoreVisibleGridColumns ()
Purpose: Stores the currently visible columns (of band 0) in the
VisibleGridColumns property
Notes: Only supported during DesignTime

Top

PUBLIC SuspendRowSynchronizationForReposition ()
Purpose: Suspends row syncronization
Notes: SuspendRowSynchronization and ResumeRowSynchronization methods can
be used to temporarily suspend UltraGrid from responding to data
source change notifications. When row syncrhonization is suspended,
the UltraGrid will still mark the rows dirty so it will re-create
the rows next time it gets painted.

Top

PUBLIC UpdateSortIndicator (character)
Purpose: Updates the Sort Indicators of the SmartDataBrowser columns
Notes: Typically invoked from a SmartDataAdapter after setting the QuerySort
property. Does not call back into QuerySort

Parameters:
pcQuerySort CHARACTER
The QuerySort to visualize


Constructor Detail
Top

PUBLIC SmartDataBrowser ()
Purpose: Creates a new Instance of SmartDataBrowser and subscribes Handlers
to Events.
Notes:



Event Detail
Top

PUBLIC AfterDeleteRecord DELEGATE System.EventHandler
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Event fired when the viewer has successfully deleted a record.
Notes: This event is defined using a .NET delegate, so it will show in
the PropertyGrid of the VisualDesigner

Delegate: System.EventHandler
Top

PUBLIC BeforeDeleteRecord DELEGATE System.ComponentModel.CancelEventHandler
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Event fired when the Viewer starts deleting a record.
This event is cancellable
Notes: This event is defined using a .NET delegate, so it will show in
the PropertyGrid of the VisualDesigner

Delegate: System.ComponentModel.CancelEventHandler
Top

PUBLIC DefaultAction DELEGATE System.EventHandler
Purpose: Event that combines double click on a data row or the selection
of the Return or Enter key
Notes:

Delegate: System.EventHandler
Top

PUBLIC SmartBrowserListChanged (Object, SmartBrowserListChangedEventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Raised when the ListChanged event of the BindingSource of the SmartBrowserControl
is raised
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the SmartBrowserListChanged event
e SmartBrowserListChangedEventArgs
The SmartBrowserListChangedEventArgs with the data for the event
Top

PUBLIC SmartDataBrowserActivated DELEGATE System.EventHandler
Purpose: Static event raised whenever a SmartDataBrowser is activated. This
event is useful to control a central UltraGridColumnChooser etc.
Notes: This event may be removed using the NoStaticsInHybrids setting
in Consultingwerk/products.i. This allows to avoid static members
in hybrid classes SmartDataBrowser and SmartBusinessEntityAdapter
to avoid issues with the combination of static and hybrids on 11.2
and 11.3, OE defect OE00240707 http://knowledgebase.progress.com/articles/Article/000042229?popup=true

Delegate: System.EventHandler
Top

PUBLIC SmartFilterActiveChanged (Object, EventArgs)
Purpose: Raised when the SmartFilterActiveChanged property is changed
Notes:

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


Property Detail
Top

PROTECTED CHARACTER BindableProperties

Returns CHARACTER
Top

PUBLIC Progress.Data.BindingSource BindingSource

Returns Progress.Data.BindingSource
Top

PROTECTED CHARACTER CategorizedProperties

Returns CHARACTER
Top

PROTECTED CHARACTER CategoryProperties

Returns CHARACTER
Top

PUBLIC LOGICAL DeleteDataSourceOnFormClosed
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl

Returns LOGICAL
Top

PROTECTED CHARACTER DescribedProperties

Returns CHARACTER
Top

PROTECTED CHARACTER DescriptionProperties

Returns CHARACTER
Top

PUBLIC LOGICAL DeselectRowsOnActivate
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl

Returns LOGICAL
Top

PROTECTED CHARACTER DesignerVerbs

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityAttributes

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityProperties

Returns CHARACTER
Top

PROTECTED LOGICAL DesignTime
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl

Returns LOGICAL
Top

PUBLIC LOGICAL EditInViewerOnDefaultAction

Returns LOGICAL
Top

PUBLIC LOGICAL FetchAllRecordsOnGroupBy

Returns LOGICAL
Top

PROTECTED CHARACTER HiddenProperties

Returns CHARACTER
Top

PUBLIC LOGICAL Initializing
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl

Returns LOGICAL
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource LinkDataSource
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource
Top

PROTECTED CHARACTER NonBrowsableProperties

Returns CHARACTER
Top

PROTECTED LOGICAL ParentFormDestroyed
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl

Returns LOGICAL
Top

PROTECTED LOGICAL ParentFormDestroyedSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl

Returns LOGICAL
Top

PUBLIC INTEGER RepositionedRow

Returns INTEGER
Top

PUBLIC LOGICAL SaveColumnSettings

Returns LOGICAL
Top

PUBLIC CHARACTER SettingsKey

Returns CHARACTER
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl

Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
Top

PUBLIC LOGICAL SmartFilterActive

Returns LOGICAL
Top

PUBLIC LOGICAL SmartFilterUseMatches

Returns LOGICAL
Top

PUBLIC LOGICAL SmartFilterUseOperators

Returns LOGICAL
Top

PUBLIC CHARACTER SmartFilterWordIndexColumns

Returns CHARACTER
Top

PUBLIC LOGICAL StoreVisibleGridColumns

Returns LOGICAL
Top

PUBLIC CHARACTER VisibleGridColumns

Returns CHARACTER


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       04.02.2020 23:17:02