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

Inherits: Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Implements: Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataTarget, IAfterRetrieveDataSubscriber, ICheckOkToClose, ICustomTypeDescriptor, IHasDesignerVerbs, ISmartDataBrowser, ISmartDataTarget, ISmartDataTargetWithBindingSource

File:SmartDynamicBrowser
Purpose:Implementation of a SmartDataBrowser (UltraGrid derived
Control) that receives it layout at runtime from a
repository service
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Mon Jul 15 14:58:27 CEST 2013

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ ActivateCurrentRow () Activates the current grid row during Update/Delete/Copy in a Viewer
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# AfterQueryPositionChangedHandler (Object, EventArgs) Activates the current query row (on add and delete)
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ AfterRetrieveDataCallback (ISmartDataSource) Invoked as a callback from DataAdapter, after Data has been retrieve.
Overrides Consultingwerk.SmartComponents.Implementation.SmartDataBrowser:AfterRetrieveDataCallback (ISmartDataSource)
+ ApplyGridSettings (character) Applies stored Grid Settings
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ 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
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# CollectFilterValuesHandler (Object, CollectFilterValuesEventArgs) Event handler for the CollectFilterValues event of the ISmartFilterTarget
Overrides Consultingwerk.SmartComponents.Implementation.SmartDataBrowser:CollectFilterValuesHandler (Object, CollectFilterValuesEventArgs)
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# 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
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# 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.Implementation.SmartDataBrowser:DisableForUpdate (ISmartDataTarget)
+ DisableMultiSelection () Disables selection of multiple rows in the SmartDataBrowser
Inherited from Consultingwerk.SmartComponents.Implementation.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
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# EnableSmartFilterUserInterface () Enables te SmartFilter UI
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# 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
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ CHARACTER ExportToExcel (IUltraGridExcelExportParameter) Exports the browsers contents to an Excel file using the UltraGrid Excel Exported
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# FormatColumnFilters () Assigns the default column filter type for numeric and date columns to GreaterThanOrEqualTo
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# 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.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# FormatGrid () Formats the Grid Appearance
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# FormatSmartColumns () Formats special columns supported by the SmartFramework functionality
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ AttributeCollection GetAttributes () Returns a collection of custom attributes for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ CHARACTER GetClassName () Returns the class name of this instance of a component.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ CHARACTER GetComponentName () Returns the name of this instance of a component.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ TypeConverter GetConverter () Returns a type converter for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ CHARACTER GetCurrentSettings () Returns a string with the current Grid settings
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ EventDescriptor GetDefaultEvent () Returns the default event for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ PropertyDescriptor GetDefaultProperty () Returns the default property for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ System.Object GetEditor (Type) Returns an editor of the specified type for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ EventDescriptorCollection GetEvents () Returns the events for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ EventDescriptorCollection GetEvents (Attribute[]) Returns the events for this instance of a component using the specified attribute array as a filter.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ PropertyDescriptorCollection GetProperties () Returns the properties for this instance of a component.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ PropertyDescriptorCollection GetProperties (Attribute[]) Returns the properties for this instance of a component using the attribute array as a filter.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ System.Object GetPropertyOwner (PropertyDescriptor) Returns an object that contains the property described by the specified property descriptor.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ GetSelectedRowsDataset (dataset-handle) Returns a ProDataset with a copy of the selected rows
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# HideNonVisibleColumns () Hides the non visible Columns from the Grid
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# InitializeColumnFilterOperatorItems () Initializes the Column Filer Operator DropDown Items
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# 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.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ 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
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# OnAfterDeleteRecord (EventArgs) Raises the AfterDeleteRecord event
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# OnAfterRowRegionScroll (RowScrollRegionEventArgs) Raises the OnAfterRowRegionScroll event
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# OnBeforeDeleteRecord (CancelEventArgs) Raises the BeforeDeleteRecord event
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# OnBeforeSortChange (BeforeSortChangeEventArgs) Raises the BeforeSortChange event
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# OnBeginInit () Invoked at the beginning of a Containers InitializeComponents method
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# OnCreateControl () Raises the CreateControl event
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# OnDefaultAction (EventArgs) Raises the DefaultAction event
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# OnDoubleClickRow (DoubleClickRowEventArgs) Raises the DoubleClickRow event
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# OnEndInit () Invoked at the end of a Containers InitializeComponents method
Overrides Consultingwerk.SmartComponents.Implementation.SmartDataBrowser:OnEndInit ()
# OnEnter (EventArgs) Raises the Enter event
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# OnGotFocus (EventArgs) Raises the GotFocus event.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# OnHandleCreated (EventArgs) Raises the HandleCreated event
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# OnInitializeLayout (InitializeLayoutEventArgs) Raises the InitializeLayout event
# OnKeyDown (KeyEventArgs) Raises the KeyDown Event
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# OnMouseUp (MouseEventArgs) Raises the MouseUp event
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# OnMouseWheel (MouseEventArgs) Raises the MouseWheel Event
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# OnSmartBrowserListChanged (SmartBrowserListChangedEventArgs) Raises the SmartBrowserListChanged
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# OnSmartDataBrowserActivated (Object, EventArgs) Raises the SmartDataBrowserActivated event
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# OnSmartFilterActiveChanged (EventArgs) Raises the SmartFilterActiveChanged
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# ParentFormClosedHandler (Object, FormClosedEventArgs) Event handler for the FormClosed event of the Parent Form
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# ParentFormDestroyedHandler (Object, EventArgs) Event handler for the FormDestroyed event of the owning Form
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# PerformFilterRow () Performs the Filter Row
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# RegisterBindingSourceEvents () Registers events of the BindingSource
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ RegisterDefaultActionSubscriber (IDefaultActionSubscriber) Register a new DefaultActionSubscriber (Class that implements IDefaultActionSubscriber).
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# RestoreSettings () Restores the actual browser column settings
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ ResumeRowSynchronizationAfterReposition () Resume row syncronization
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# SaveSettings () Stores a browsers column settings to the Registry
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# ScrollOffHome () Fetches the previous batch from the DataSource
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ ScrollToCurrentRow (logical) Scrolls to the BindingSource's position
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ ScrollToCurrentRow (logical, logical) Scrolls to the BindingSource's position
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ ScrollToFirstRow () Scrolls the Grid to the First Row
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ ScrollToLastRow () Scrolls the Grid to the Last Row
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ SetGridReadOnly () Set the entire Grid to Read-Only
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# SetMultiSelection (logical) Enables or Disables multi-selection in the Grid
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ StartEditModeInViewer () Invokes EnableFields (Update) in a Viewer linked to the same SmartDataAdapter
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# StoreSettings (character) Stores a browsers column settings to the Registry
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# StoreVisibleGridColumns () Stores the currently visible columns (of band 0) in the VisibleGridColumns property
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ SuspendRowSynchronizationForReposition () Suspends row syncronization
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ UpdateSortIndicator (character) Updates the Sort Indicators of the SmartDataBrowser columns
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser

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

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
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ 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.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ SmartFilterActiveChanged (Object, EventArgs) Raised when the SmartFilterActiveChanged property is changed
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser

Top Property Summary
Options Name Purpose
# CHARACTER BindableProperties Property that is used to mark properties (comma-delimited list) that should be Data-Bindable
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ Progress.Data.BindingSource BindingSource Get the BindingSource of the current Class. This Property is used to get a possibly existing DesignTime BindingSource from the SmartDataBrowser Instance. A SmartDataAdapter derived Class gets registered as the SmartDataSource for the SmartDataBrowser and RegisterSmartDataTarget () is called to do the handshake between those two Classes.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ CHARACTER BrowserKey The key of the Browser's layout in the repository
# CHARACTER CategorizedProperties Property that is used to mark properties (comma-delimited list) that should receive a Category attribute
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# CHARACTER CategoryProperties Categories of the Property in the CategorizedProperty list
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# CHARACTER DescribedProperties Property that is used to mark properties (comma-delimited list) that should receive a Description attribute
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# CHARACTER DescriptionProperties Description of the Property in the DescribedProperties list
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ LOGICAL DeselectRowsOnActivate Propery flags if the currently selected Rows will be deselected before activating a new row. The default is TRUE.
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# CHARACTER DesignerVerbs Property that is used to generate Designer Verbs (actions for the Visual Designer)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# CHARACTER DesignerVisibilityAttributes The CHARACTER representation of the DesignerSerializationVisibiltiy attribute (Content/Visible/Hidden), see .NET Enumeration System.ComponentModel.DesignerSerializationVisibility
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# CHARACTER DesignerVisibilityProperties Property that is used to mark properties (comma-delimited list) that should receive a DesignerSerializationVisibility Attribute
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# LOGICAL DesignTime Propery flags if the current instance of the SmartBindingSource is running at design time or runtime.
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ LOGICAL EditInViewerOnDefaultAction Gets and sets if the DefaultAction (DoubleClickRow or Enter) in the SmartDataBrowser starts EnabledFields (Update) in a Viewer linked to the same SmartDataBrowser
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ LOGICAL FetchAllRecordsOnGroupBy Gets and sets if the SmartDataBrowser should invoke a "Fetch all" from it's data source when grouping by
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# CHARACTER HiddenProperties Property that is used to mark properties (comma-delimited list) that will be excluded from the .NET TypeDescriptor properties list
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ LOGICAL Initializing Indicated that the SmartDataAdapter is currrently being Initialized
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource LinkDataSource Represents the SmartDataSource property casted to a .NET Interface
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# CHARACTER NonBrowsableProperties Property that is used to mark properties (comma-delimited list) that should not show up in the Visual Designers Property Grid
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
# LOGICAL ParentFormDestroyed Returns if the FormDestroyed evengt of the containing Form has been subscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
# LOGICAL ParentFormDestroyedSubscribed Returns if the FormDestroyed evengt of the containing Form has been subscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ INTEGER RepositionedRow Gets and sets the demanded Visible Row Index that the ScrollToCurrentRow should set when scrollign to the current row
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ LOGICAL SaveColumnSettings Controls if SmartDataBrowsers should store the column settings when the containing Form is closed.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ CHARACTER SettingsKey Contains the key used to store settings of this Browser in the Registry
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ ISmartDataSource SmartDataSource Get/Set the SmartDataSource of the current Class. The SmartDataSource can be set to any class implementing the Interface ISmartDataSource. This Property is set by the developer when initializing a Control implementing the Interface ISmartDataTarget. Registers the SmartDataBrowser instance with the SmartDataSource (using the RegisterSmartDataTarget method in ISmartDataSource). When the browser is already attached to a BindingSource (in the Form Design), the bindingSource is introduced to the SmartDataSource by assigning it to the BindingSource property.
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
+ LOGICAL SmartFilterActive Gets and sets if the SmartFilter functioanlity should be used with a filter row of the UltraGrid
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ LOGICAL SmartFilterUseMatches Gets and sets if the SmartFilter functionality uses MATCHES
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ LOGICAL SmartFilterUseOperators Gets and sets if the SmartFilter functionality supports multiple operators
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ LOGICAL StoreVisibleGridColumns Depriciated property to invoke StoreVisibleGridColumns from the property grid.
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
+ CHARACTER VisibleGridColumns Stores the Columns of the Grid that should be visible
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser


Method Detail
Top

PUBLIC ActivateCurrentRow ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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.Implementation.SmartDataBrowser:AfterRetrieveDataCallback (ISmartDataSource)
Purpose: Invoked as a callback from DataAdapter, after Data has been retrieve.
Notes: Overridden in SmartDataBrowser to call FormatColumns ()

Parameters:
sender Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
The reference to the ISmartDataSource that invoked this callback
Top

PUBLIC ApplyGridSettings (character)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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.Implementation.SmartDataBrowser:CollectFilterValuesHandler (Object, CollectFilterValuesEventArgs)
Purpose: Event handler for the CollectFilterValues event of the ISmartFilterTarget
Notes:

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 ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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.Implementation.SmartDataBrowser: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 ISmartDataTarget
The ISmartDataTarget instance that is in update mode
Top

PUBLIC DisableMultiSelection ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Enabels selection of multiple rows in the SmartDataBrowser
Notes:

Top

PROTECTED EnableSmartFilterUserInterface ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Exports the browsers contents to an Excel file using the UltraGrid Excel Exported
Notes:

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

PROTECTED FormatColumnFilters ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Formats the Grid Appearance
Notes: Sets the Color of the ActiveRow Appearance if not yet set.

Top

PROTECTED FormatSmartColumns ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Formats special columns supported by the SmartFramework functionality
Notes:

Top

PUBLIC AttributeCollection GetAttributes ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Returns a collection of custom attributes for this instance of a
component.
Notes:

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

PUBLIC CHARACTER GetClassName ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Returns the class name of this instance of a component.
Notes:

Returns CHARACTER
The class name of the Component
Top

PUBLIC CHARACTER GetComponentName ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Returns the name of this instance of a component.
Notes:

Returns CHARACTER
The Component Name of this instance
Top

PUBLIC TypeConverter GetConverter ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Returns a type converter for this instance of a component.
Notes:

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

PUBLIC CHARACTER GetCurrentSettings ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Returns a string with the current Grid settings
Notes:

Returns CHARACTER
The string representing the current grid settings
Top

PUBLIC EventDescriptor GetDefaultEvent ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Returns the default event for this instance of a component.
Notes:

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

PUBLIC PropertyDescriptor GetDefaultProperty ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Returns the default property for this instance of a component.
Notes:

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

PUBLIC System.Object GetEditor (Type)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 EventDescriptorCollection GetEvents ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Returns the events for this instance of a component.
Notes:

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

PUBLIC EventDescriptorCollection GetEvents (Attribute[])
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 EventDescriptorCollection
The System.ComponentModel.EventDescriptorCollection describing the events of the component
Top

PUBLIC PropertyDescriptorCollection GetProperties ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Returns the properties for this instance of a component.
Notes:

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

PUBLIC PropertyDescriptorCollection GetProperties (Attribute[])
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 PropertyDescriptorCollection
A System.ComponentModel.PropertyDescriptorCollection that represents the properties for this component instance.
Top

PUBLIC System.Object GetPropertyOwner (PropertyDescriptor)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Returns an object that contains the property described by the
specified property descriptor.
Notes:

Parameters:
pd 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)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Hides the non visible Columns from the Grid
Notes: Following the VisibleGridColumns Property

Top

PROTECTED InitializeColumnFilterOperatorItems ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Raises the CreateControl event
Notes: The OnCreateControl method is called when the control is first
created

Top

PROTECTED OnDefaultAction (EventArgs)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Raises the DefaultAction event
Notes:

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

PROTECTED OnDoubleClickRow (DoubleClickRowEventArgs)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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.Implementation.SmartDataBrowser: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)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 OnInitializeLayout (InitializeLayoutEventArgs)
Purpose: Raises the InitializeLayout event
Notes:

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

PROTECTED OnKeyDown (KeyEventArgs)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Raises the SmartFilterActiveChanged
Notes:

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

PUBLIC OnVerbClicked (character)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Register a new DefaultActionSubscriber (Class that implements
IDefaultActionSubscriber).
Notes:

Parameters:
poDefaultActionSubscriber IDefaultActionSubscriber
The IDefaultActionSubscriber instance to register
Top

PROTECTED RestoreSettings ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Scrolls the Grid to the First Row
Notes:

Top

PUBLIC ScrollToLastRow ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Scrolls the Grid to the Last Row
Notes:

Top

PUBLIC SetGridReadOnly ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Invokes EnableFields (Update) in a Viewer linked to the same
SmartDataAdapter
Notes:

Top

PROTECTED StoreSettings (character)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Stores the currently visible columns (of band 0) in the
VisibleGridColumns property
Notes: Only supported during DesignTime

Top

PUBLIC SuspendRowSynchronizationForReposition ()
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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 SmartDynamicBrowser ()
Purpose: Constructor for the SmartDynamicBrowser class
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
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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)
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
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
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Property that is used to mark properties (comma-delimited list) that
should be Data-Bindable
Notes: C# Annotation: [Bindable(true)]

Returns CHARACTER
Top

PUBLIC Progress.Data.BindingSource BindingSource
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Get the BindingSource of the current Class.
This Property is used to get a possibly existing DesignTime
BindingSource from the SmartDataBrowser Instance. A SmartDataAdapter
derived Class gets registered as the SmartDataSource for the
SmartDataBrowser and RegisterSmartDataTarget () is called to do the
handshake between those two Classes.
Notes:

Returns Progress.Data.BindingSource
Top

PUBLIC CHARACTER BrowserKey
Purpose: The key of the Browser's layout in the repository
Notes:

Returns CHARACTER
Top

PROTECTED CHARACTER CategorizedProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Property that is used to mark properties (comma-delimited list) that
should receive a Category attribute
Notes: C# Annotation: [Category("...")]
This is a comma delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER CategoryProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Categories of the Property in the CategorizedProperty list
Notes: C# Annotation: [Category("...")]
This is a comma delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER DescribedProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Property that is used to mark properties (comma-delimited list) that
should receive a Description attribute
Notes: C# Annotation: [Description("...")]
This is a comma delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER DescriptionProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Description of the Property in the DescribedProperties list
Notes: C# Annotation: [Description("...")]
This is a CHR(1) delimited list

Returns CHARACTER
Top

PUBLIC LOGICAL DeselectRowsOnActivate
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Propery flags if the currently selected Rows will be deselected
before activating a new row. The default is TRUE.
Notes: See BeforeRowActivateHandler for details

Returns LOGICAL
Top

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

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityAttributes
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: The CHARACTER representation of the DesignerSerializationVisibiltiy
attribute (Content/Visible/Hidden), see .NET Enumeration
System.ComponentModel.DesignerSerializationVisibility
Notes: C# Annotation: [DesignerSerializationVisibility(...)]
This is a comma delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityProperties
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Property that is used to mark properties (comma-delimited list) that
should receive a DesignerSerializationVisibility Attribute
Notes: C# Annotation: [DesignerSerializationVisibility(...)]
This is a comma delimited list

Returns CHARACTER
Top

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

Returns LOGICAL
Top

PUBLIC LOGICAL EditInViewerOnDefaultAction
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Gets and sets if the DefaultAction (DoubleClickRow or Enter) in the
SmartDataBrowser starts EnabledFields (Update) in a Viewer linked to
the same SmartDataBrowser
Notes:

Returns LOGICAL
Top

PUBLIC LOGICAL FetchAllRecordsOnGroupBy
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Gets and sets if the SmartDataBrowser should invoke a "Fetch all"
from it's data source when grouping by
Notes: Ensures proper group by, as the UltraGrid requires all data for group
by

Returns LOGICAL
Top

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

Returns CHARACTER
Top

PUBLIC LOGICAL Initializing
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Indicated that the SmartDataAdapter is currrently being
Initialized
Notes:

Returns LOGICAL
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource LinkDataSource
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Represents the SmartDataSource property casted to a .NET Interface
Notes: Implementation of Interface in Consultingwerk.SmartComponents.dll
SCL-725 - code moved from LinkDataSource.i directly into class file

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource
Top

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

Returns CHARACTER
Top

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

Returns LOGICAL
Top

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

Returns LOGICAL
Top

PUBLIC INTEGER RepositionedRow
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Gets and sets the demanded Visible Row Index that the ScrollToCurrentRow
should set when scrollign to the current row
Notes: Zero based version of the ABL Browse widget SET-REPOSITIONED-ROW

Returns INTEGER
Top

PUBLIC LOGICAL SaveColumnSettings
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Controls if SmartDataBrowsers should store the column settings
when the containing Form is closed.
Notes: This static property is not present when the NoStaticsInHybrids
preprocessor switch is set in Consultingwerk/products.i - instead
the preprocessor

Returns LOGICAL
Top

PUBLIC CHARACTER SettingsKey
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Contains the key used to store settings of this Browser in the
Registry
Notes:

Returns CHARACTER
Top

PUBLIC ISmartDataSource SmartDataSource
Inherited from Consultingwerk.SmartComponents.Base.SmartBrowserControl
Purpose: Get/Set the SmartDataSource of the current Class. The SmartDataSource
can be set to any class implementing the Interface ISmartDataSource.
This Property is set by the developer when initializing a Control
implementing the Interface ISmartDataTarget.
Registers the SmartDataBrowser instance with the SmartDataSource
(using the RegisterSmartDataTarget method in ISmartDataSource).
When the browser is already attached to a BindingSource (in the Form
Design), the bindingSource is introduced to the SmartDataSource by
assigning it to the BindingSource property.
Notes: Enforced by Interface ISmartDataTarget.

Returns ISmartDataSource
Top

PUBLIC LOGICAL SmartFilterActive
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Gets and sets if the SmartFilter functioanlity should be used with
a filter row of the UltraGrid
Notes:

Returns LOGICAL
Top

PUBLIC LOGICAL SmartFilterUseMatches
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Gets and sets if the SmartFilter functionality uses MATCHES
Notes: MATCHES uses a flexible combination with BEGINS based on entered text
or BEGINS for character fields

Returns LOGICAL
Top

PUBLIC LOGICAL SmartFilterUseOperators
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Gets and sets if the SmartFilter functionality supports multiple
operators
Notes: When set to TRUE the SmartFilter will support all operators that
are reasonable for the column data type
The use of the SmartFilterUseOperators feature overrides the
SmartFilterUseMatches setting as the user has full control over the
filter comparison used.

Returns LOGICAL
Top

PUBLIC LOGICAL StoreVisibleGridColumns
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Depriciated property to invoke StoreVisibleGridColumns from the
property grid.
Notes: Protected GET to remain compability with old InitializeComponents
code that assigns a value. There is no need to GET and SET this
property anymore

Returns LOGICAL
Top

PUBLIC CHARACTER VisibleGridColumns
Inherited from Consultingwerk.SmartComponents.Implementation.SmartDataBrowser
Purpose: Stores the Columns of the Grid that should be visible
Notes: All other columns will be hidden

Returns CHARACTER


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