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.Design.IDesignToolbarTarget, Consultingwerk.SmartComponents.Interfaces.IAfterRetrieveDataSubscriber, Consultingwerk.SmartComponents.Base.IAlwaysEnabledControl, Consultingwerk.SmartComponents.Interfaces.ICheckOkToClose, System.ComponentModel.ICustomTypeDescriptor, Consultingwerk.SmartComponents.IHasDesignerVerbs, Consultingwerk.SmartComponents.Interfaces.ILaunchDetailForm, Consultingwerk.SmartComponents.Interfaces.ISmartDataBrowser, Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget, Consultingwerk.SmartComponents.Interfaces.ISmartDataTargetWithBindingSource, Consultingwerk.SmartComponents.Interfaces.ISmartExportTarget, Consultingwerk.SmartComponents.Interfaces.ISmartToolbarTarget, Consultingwerk.SmartComponents.Interfaces.ISupportFormShownHandler
Inherited by: Consultingwerk.SmartComponents.Implementation.SmartDynamicBrowser Consultingwerk.SmartComponents.Implementation.SmartUpdatableBrowser Consultingwerk.SmartComponents.Implementation.SmartDynamicUpdatableBrowser


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
AfterRetrieveDataCallback (ISmartDataSource) Callback method for the AfterRetrieveData event
ApplyBrowserView (UltraGridView) Applies a view to the SmartDataBrowser
ApplyGridSettings (character) Applies stored Grid Settings
ClearFilterRow (FilterClearButtonUIElement) Clears the Filter Row
ClearFilterRow (FilterClearButtonUIElement, logical) Clears the Filter Row
ClearFilterRow (logical) Clears the Filter Row
CollectFilterValuesHandler (Object, CollectFilterValuesEventArgs) Event handler for the CollectFilterValues event of the ISmartFilterTarget
CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
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.
DisableMultiSelection () Disables selection of multiple rows in the SmartDataBrowser
EnableMultiSelection () Enables selection of multiple rows in the SmartDataBrowser
EnableSmartFilterUserInterface () Enables te SmartFilter UI
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
CHARACTER ExportToPdf () Exports the browsers contents to a PDF file using the UltraGrid PDF Exporter
CHARACTER ExportToPdf (IUltraGridPdfExportParameter) Exports the browsers contents to a PDF file using the UltraGrid PDF Exporter
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.
Consultingwerk.Windows.Util.UltraGridView GetCurrentBrowserView () Returns the current view
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
HandleFormShown () Callback executed by the SmartWindowForm instance after the form has been Shown
HideNonVisibleColumns () Hides the non visible Columns from the Grid
InitializeBrowserLogicObject () Initializes the Viewer Logic Object
InitializeColumnFilterOperatorItems () Initializes the Column Filer Operator DropDown Items
InitializeLayoutHandler (Object, InitializeLayoutEventArgs) Handle default behavior of the Grid and apply a default layout. This Method is called if the InitializeLayout Event of the UltraGrid is fired.
Progress.Windows.Form LaunchDetailForm () Launches the DetailForm and adds a Data Link
Progress.Windows.Form LaunchDetailForm (DetailFormOperationEnum) Launches the DetailForm and adds a Data Link
CHARACTER LoadSettings () Loads a browsers column settings from the Registry
OnAfterRowRegionScroll (RowScrollRegionEventArgs) Raises the OnAfterRowRegionScroll event
OnBeforeSortChange (BeforeSortChangeEventArgs) Raises the BeforeSortChange event
OnCollectFilterValues (BrowserCollectFilterValuesEventArgs) Raises the CollectFilterValues
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
OnGotFocus (EventArgs) Raises the GotFocus event.
OnKeyDown (KeyEventArgs) Raises the KeyDown Event
OnMouseUp (MouseEventArgs) Raises the MouseUp event
OnMouseWheel (MouseEventArgs) Raises the MouseWheel Event
OnOpenDetailForm (OpenDetailFormEventArgs) Publishes the OpenDetailForm event
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
PerformFilterRow () Performs the Filter Row
ProcessFieldSecurity () Processes field security from the IFieldAuthorizationProvider
ProcessFieldSecurity (UltraGridColumn, FieldRestrictionEnum) Processes field security from the IFieldAuthorizationProvider
LOGICAL RaiseToolbarAction (Object, ToolClickEventArgs, character) Executes a Toolbar Action
RegisterDefaultActionSubscriber (IDefaultActionSubscriber) Register a new DefaultActionSubscriber (Class that implements IDefaultActionSubscriber).
ResetGridSettings () Resets stored grid settings
RestoreSettings () Restores the actual browser column settings
ResumeRowSynchronizationAfterReposition () Resume row synchronization
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
SetDefaultFilterOperators () Sets the default filter operators
SetDesignerProperties () Set properties for ICustomTypeDescriptor
SetGridReadOnly () Set the entire Grid to Read-Only
SetHasViewManagerAttached (logical) Sets logical value if a SmartDataBrowserViewManager control is attached
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
SubscribeControlEventHandler (Control, character, character) Subscribes a Control to an Event Handler in the Grid Logic Class
SuspendRowSynchronizationForReposition () Suspends row synchronization
UpdateSortIndicator (character) Updates the Sort Indicators of the SmartDataBrowser columns
UpdateSortIndicator (UltraGridSort) 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
CollectFilterValues (Object, BrowserCollectFilterValuesEventArgs) Raised when the SmartDataBrowser handles the SmartDataSource's CollectFilterValues event
DefaultAction DELEGATE System.EventHandler Event that combines double click on a data row or the selection of the Return or Enter key
EndInit DELEGATE System.EventHandler Raised when the SmartDataBrowser is initialized
OpenDetailForm (Object, OpenDetailFormEventArgs) Raised to Launch the Detail Form
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 BrowserLogicClass
Consultingwerk.SmartComponents.Interfaces.ISmartDataBrowserLogic BrowserLogicObject
CHARACTER CategorizedProperties
CHARACTER CategoryProperties
CHARACTER DescribedProperties
CHARACTER DescriptionProperties
CHARACTER DesignerVerbs
CHARACTER DesignerVisibilityAttributes
CHARACTER DesignerVisibilityProperties
CHARACTER DetailForm
CHARACTER DetailFormDataSources
LOGICAL DetailFormForUpdates
LOGICAL DetailFormModal
LOGICAL EditInViewerOnDefaultAction
LOGICAL FetchAllRecordsOnGroupBy
CHARACTER HiddenProperties
CHARACTER NonBrowsableProperties
LOGICAL RaiseEventToLaunchDetailForm
INTEGER RepositionedRow
LOGICAL SaveColumnSettings
CHARACTER SecurityKey
CHARACTER SettingsKey
Consultingwerk.SmartComponents.Interfaces.ISmartExportSource SmartExportSource
LOGICAL SmartFilterActive
CHARACTER SmartFilterOperators
LOGICAL SmartFilterUseMatches
LOGICAL SmartFilterUseOperators
CHARACTER SmartFilterWordIndexColumns
LOGICAL StoreVisibleGridColumns
CHARACTER VisibleGridColumns


Method Detail
Top

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

Top

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

ApplyBrowserView (UltraGridView)
Purpose: Applies a view to the SmartDataBrowser
Notes:

Parameters:
poView Consultingwerk.Windows.Util.UltraGridView
The UltraGridView instance
Top

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

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

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

ClearFilterRow (FilterClearButtonUIElement, logical)
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
plRetrieveData LOGICAL
Logical value indicating if the RetrieveData should be called
Top

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

Parameters:
plRetrieveData LOGICAL
Logical value indicating if the RetrieveData should be called
Top

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

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

Top

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

Top

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

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

Top

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

Top

EnableSmartFilterUserInterface ()
Purpose: Enables te SmartFilter UI
Notes:

Top

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

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

CHARACTER ExportToPdf ()
Purpose: Exports the browsers contents to a PDF file using the UltraGrid PDF Exporter
Notes:

Returns CHARACTER
The filename of the exported document
Top

CHARACTER ExportToPdf (IUltraGridPdfExportParameter)
Purpose: Exports the browsers contents to a PDF file using the UltraGrid PDF Exporter
Notes:

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

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

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

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

Top

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

Top

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

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

Returns CHARACTER
The class name of the Component
Top

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

Returns CHARACTER
The Component Name of this instance
Top

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

Consultingwerk.Windows.Util.UltraGridView GetCurrentBrowserView ()
Purpose: Returns the current view
Notes:

Returns Consultingwerk.Windows.Util.UltraGridView
The UltraGridView describing the current view
Top

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

Returns CHARACTER
The string representing the current grid settings
Top

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

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

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

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

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

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

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

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

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

HandleFormShown ()
Purpose: Callback executed by the SmartWindowForm instance after
the form has been Shown
Notes: Allows for final control initialization

Top

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

Top

InitializeBrowserLogicObject ()
Purpose: Initializes the Viewer Logic Object
Notes: The SmartViewerControl will initialize the ViewerLogicClass during
EndInit when the property ViewerLogicClass is set and the Viewer
does not have a SmartGroupAssignSource
The Viewer Logic Object will also not initialized when the ViewerLogicObject
instance is already set
Registers the ViewerLogicObject also for the SmartGroupAssignTargets

Top

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

Top

InitializeLayoutHandler (Object, InitializeLayoutEventArgs)
Purpose: Handle default behavior 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

Progress.Windows.Form LaunchDetailForm ()
Purpose: Launches the DetailForm and adds a Data Link
Notes:

Returns Progress.Windows.Form
The reference to the launched Form instance
Top

Progress.Windows.Form LaunchDetailForm (DetailFormOperationEnum)
Purpose: Launches the DetailForm and adds a Data Link
Notes:

Parameters:
poOperation Consultingwerk.SmartComponents.Implementation.DetailFormOperationEnum
Add, Copy, Update, View
Returns Progress.Windows.Form
The reference to the launched Form instance
Top

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

Returns CHARACTER
The settings for this Grid instance
Top

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

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

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

OnCollectFilterValues (BrowserCollectFilterValuesEventArgs)
Purpose: Raises the CollectFilterValues
Notes:

Parameters:
e Consultingwerk.SmartComponents.Implementation.BrowserCollectFilterValuesEventArgs
The BrowserCollectFilterValuesEventArgs with the data for the event
Top

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

Top

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

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

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

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

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

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

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

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

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

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

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

OnOpenDetailForm (OpenDetailFormEventArgs)
Purpose: Publishes the OpenDetailForm event
Notes:

Parameters:
e Consultingwerk.SmartComponents.Implementation.OpenDetailFormEventArgs
The OpenDetailFormEventArgs with the data for this event
Top

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

OnSmartFilterActiveChanged (EventArgs)
Purpose: Raises the SmartFilterActiveChanged
Notes:

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

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

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

PerformFilterRow ()
Purpose: Performs the Filter Row
Notes:

Top

ProcessFieldSecurity ()
Purpose: Processes field security from the IFieldAuthorizationProvider
Notes:

Top

ProcessFieldSecurity (UltraGridColumn, FieldRestrictionEnum)
Purpose: Processes field security from the IFieldAuthorizationProvider
Notes:

Parameters:
poColumn Infragistics.Win.UltraWinGrid.UltraGridColumn
The reference to the UltraGridColumn
poRestricted Consultingwerk.Framework.Authorization.FieldRestrictionEnum
The FieldRestrictionEnum defining the column's authorization
Top

LOGICAL RaiseToolbarAction (Object, ToolClickEventArgs, character)
Purpose: Executes a Toolbar Action
Notes:

Parameters:
sender System.Object
The reference to the control that raised the ToolClick event
e Infragistics.Win.UltraWinToolbars.ToolClickEventArgs
The ToolClickEventArgs with the data for the ToolClick event
pcToolbarAction CHARACTER
The name of the method to execute
Returns LOGICAL
Logical value indicating if the action was executed
Top

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

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

ResetGridSettings ()
Purpose: Resets stored grid settings
Notes: Re-applies the initial layout of the grid and wipes stored
settings in the user-profile

Top

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

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

Top

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

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

Top

ScrollToCurrentRow (logical)
Purpose: Scrolls to the BindingSource's position
Notes: Enforces reposition/scrolling 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

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.
plEnforceScroll 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 behavior
Top

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

Top

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

Top

SetDefaultFilterOperators ()
Purpose: Sets the default filter operators
Notes:

Top

SetDesignerProperties ()
Purpose: Set properties for ICustomTypeDescriptor
Notes:

Top

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

SetHasViewManagerAttached (logical)
Purpose: Sets logical value if a SmartDataBrowserViewManager control is attached
Notes: When a View Manager is attached, the Browser won't store it's settings to
the user profile (Windows registry)

Parameters:
plViewManagerAttached LOGICAL
Logical value indicating if a view manager is attached
Top

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

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

Top

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

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

Top

SubscribeControlEventHandler (Control, character, character)
Purpose: Subscribes a Control to an Event Handler in the Grid Logic Class
Notes: The event handler method needs to be PROTECTED in the Grid Logic Class

Parameters:
poControl System.Windows.Forms.Control
The Control contained in the Grid
pcEventName CHARACTER
The name of the event to subscribe
pcHandlerName CHARACTER
The name of the control event handler method
Top

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

Top

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
Top

UpdateSortIndicator (UltraGridSort)
Purpose: Updates the Sort Indicators of the SmartDataBrowser columns
Notes:

Parameters:
poSort Consultingwerk.Windows.Util.UltraGridSort
The UltraGridSort instance


Constructor Detail
Top

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



Event Detail
Top

CollectFilterValues (Object, BrowserCollectFilterValuesEventArgs)
Purpose: Raised when the SmartDataBrowser handles the SmartDataSource's
CollectFilterValues event
Notes:

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

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

EndInit DELEGATE System.EventHandler
Purpose: Raised when the SmartDataBrowser is initialized
Notes:

Delegate: System.EventHandler
Top

OpenDetailForm (Object, OpenDetailFormEventArgs)
Purpose: Raised to Launch the Detail Form
Notes:

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

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

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

CHARACTER BindableProperties

Returns CHARACTER
Top

Progress.Data.BindingSource BindingSource

Returns Progress.Data.BindingSource
Top

CHARACTER BrowserLogicClass

Returns CHARACTER
Top

Consultingwerk.SmartComponents.Interfaces.ISmartDataBrowserLogic BrowserLogicObject

Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataBrowserLogic
Top

CHARACTER CategorizedProperties

Returns CHARACTER
Top

CHARACTER CategoryProperties

Returns CHARACTER
Top

CHARACTER DescribedProperties

Returns CHARACTER
Top

CHARACTER DescriptionProperties

Returns CHARACTER
Top

CHARACTER DesignerVerbs

Returns CHARACTER
Top

CHARACTER DesignerVisibilityAttributes

Returns CHARACTER
Top

CHARACTER DesignerVisibilityProperties

Returns CHARACTER
Top

CHARACTER DetailForm

Returns CHARACTER
Top

CHARACTER DetailFormDataSources

Returns CHARACTER
Top

LOGICAL DetailFormForUpdates

Returns LOGICAL
Top

LOGICAL DetailFormModal

Returns LOGICAL
Top

LOGICAL EditInViewerOnDefaultAction

Returns LOGICAL
Top

LOGICAL FetchAllRecordsOnGroupBy

Returns LOGICAL
Top

CHARACTER HiddenProperties

Returns CHARACTER
Top

CHARACTER NonBrowsableProperties

Returns CHARACTER
Top

LOGICAL RaiseEventToLaunchDetailForm

Returns LOGICAL
Top

INTEGER RepositionedRow

Returns INTEGER
Top

LOGICAL SaveColumnSettings

Returns LOGICAL
Top

CHARACTER SecurityKey

Returns CHARACTER
Top

CHARACTER SettingsKey

Returns CHARACTER
Top

Consultingwerk.SmartComponents.Interfaces.ISmartExportSource SmartExportSource

Returns Consultingwerk.SmartComponents.Interfaces.ISmartExportSource
Top

LOGICAL SmartFilterActive

Returns LOGICAL
Top

CHARACTER SmartFilterOperators

Returns CHARACTER
Top

LOGICAL SmartFilterUseMatches

Returns LOGICAL
Top

LOGICAL SmartFilterUseOperators

Returns LOGICAL
Top

CHARACTER SmartFilterWordIndexColumns

Returns CHARACTER
Top

LOGICAL StoreVisibleGridColumns

Returns LOGICAL
Top

CHARACTER VisibleGridColumns

Returns CHARACTER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       30.03.2026 11:06:21