Namespace: Consultingwerk.WindowIntegrationKit.Controls
Class 
RenderedBrowseControl Copy to Clipboard
Parent classes:
Inherits: Infragistics.Win.UltraWinGrid.UltraGrid
Implements: Consultingwerk.WindowIntegrationKit.Controls.IOverlayControl
Inherited by: Consultingwerk.WindowIntegrationKit.Controls.RenderedBrowseWithSearchControl

File:RenderedBrowseControl
Purpose:Grid Control that can replace a Progress Browse Widget
Description:Class inheritings from the Infragistics UltraGrid
This class is part of the WinKit
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Dec 16 22:51:27 CET 2010



Top Method Summary
Options Name Purpose
ActivateCurrentBrowseColumn () Activates the current browse column in the Grid
HANDLE AlternativeQuery (handle) Creates an alternative query that contains alternative buffers to the tables used by the original query
AnchorBottom () Anchors the Grid at the bottom of it's container and takes all remaining space
ApplyValueChanged () Raises the VALUE-CHANGED Event to the Browse Widget
bindingSource1_PositionChanged (Object, EventArgs) Event handler for the PositionChanged event of the Progress.Data.BindingSource
F HANDLE BrowseColumnHandleFromGridColumnKey (character) Returns the handle of the browse column related to the UltraGridColumn
CloseQuery () Closes the query by opening it with a query string that matches no records
F CHARACTER ColumnKeyFromColumnHandle (handle) Returns the key of the UltraGridColumn that represents the given column of the browse
F CHARACTER ColumnKeyFromFieldName (character, character) Returns the key of the UltraGridColumn that represents the given buffer field
DefaultActionHandler (Object, EventArgs) Call all registered DefaultActionSubscriber to perform their action. Event handler for the DoubleClickRow event of the base class (UltraGrid).
DeleteAlternativeQuery (handle, handle[]) Deletes the alternative query and buffer
LOGICAL DESELECT-FOCUSED-ROW () Deselects the row with current focus.
DisplayCurrentRow () Re-Display's the current row
DisplayFromBrowse () Displays the current browse values on the Grid's current row
DisplayFromGrid () Displays the current Grid values on the BROWSE widgets current row
EnableDisableColumns () Enables and Disables the Columns in the RenderedBrowseControl based on the current state of the browser columns
EnterBrowseCell (handle) Call back procedure for the ENTRY event of the Browse Cells
FetchByRowid (rowid) Fetches a row/record by a ROWID
FetchByRowid (rowid[]) Fetches a row/record by a ROWID Array
FetchFirst () Fetches the first row
FetchLast () Fetches the last row
FetchNext () Fetches the next row
FetchPrevious () Fetches the previous row
LOGICAL FetchRow (integer) Moves a query objects result list pointer to the row corresponding to the specified sequence number.
FormDisposedHandler (Object, EventArgs) Event handler for the Dispose event of the containing Form
CHARACTER GetBrowseColumns () Returns an array describing every column of the browse widget
INTEGER GetRepositionedRow () Returns the row index of the browse viewport where the REPOSITION TO ROWID (or RECID) statement displays a repositioned record.
InitializeComponent ()
InitializeGrid (handle, logical) Initializes the Grid with the layout from the Progress Browse widget
InitializeGrid (RenderedBrowseContext) Initializes the Grid based on the RenderedBrowseContext instance
InitializeRowHandler (Object, InitializeRowEventArgs) Called when a row is initialized
InitializeUniqueKeys () Initializes the UniqueKeyDictionary
CHARACTER KeyFieldsForBuffer (handle) Returns the list of unqiue key fields for a buffer
ListChangedHandler (Object, ListChangedEventArgs) Event handler for the ListChanged event of the ProBindingSource
ListChangedHandler2 (Object, ListChangedEventArgs) Alternative event handler for the ListChanged event of the ProBindingSource
CHARACTER LoadSettings () Loads a browsers column settings from the Registry
NewUltraGridColumn (UltraGridColumn) Overloadable method, invoked whenever the Grid creates a new Column
OnAfterCellActivate () Called after a cell is activated
OnAfterCellUpdate (CellEventArgs) Raises the AfterCellUpdate event
OnAfterRowActivate () Called after a row is activated
OnBeforeCellDeactivate (CancelEventArgs) Called before a cell is deactivated
OnBeforeEnterEditMode (CancelEventArgs) Called before entering edit mode
OnBeforeRowDeactivate (CancelEventArgs) Called before a row is deactivated
OnBeforeSortChange (BeforeSortChangeEventArgs) Raises the BeforeSortChange event
OnDefaultAction (EventArgs) Raises the DefaultAction event
OnEnter (EventArgs) Raises the Enter event
OnFindRecordsForCalculatedFields (FindRecordsForCalculatedFieldsEventArgs) Raises the FindRecordsForCalculatedFields event
OnGotFocus (EventArgs) Invokes the GotFocus event.
OnInitializeLayout (InitializeLayoutEventArgs) Called when the layout is first initialized after the datasource has been set
OnKeyDown (KeyEventArgs) Raises the Key Down Event
OnLeave (EventArgs) Raises the Leave event
OnMouseClick (MouseEventArgs) Raises the MouseClick event
OnMouseWheel (MouseEventArgs) Raises the MouseWheel Event
OnOffHome (EventArgs) Raises the OffHome event
OnParentChanged (EventArgs) Raises the ParentChanged Event
OnVisibleChanged (EventArgs) Raises the VisibleChanged event
ProcessColorCodingAndCalculatedFields (UltraGridRow) Processes color coding and calculted fields for a single grid row
CHARACTER QueryExceptList (handle) Builds a list of Columns that need to be excluded from the BindingSource
ReGroupBy () Forces the Grid to update the row grouping (outlook group by)
RepositionControl () Positions the RenderedBrowseControl on top of the Progress Browse
RestoreDynamicBrowseColumns (character[]) Restores the columns of a dynamic browse widget after the query has been replaced with the alternative query
RestoreSettings () Restores the stored User settings for the RenderedBrowseControl instance
CHARACTER ReturnGridSettings () Returns the User Settings string for the RenderedBrowseControl instance
SaveCurrentRow () Saves the current row
SaveCurrentRow (logical) Saves the current row
ScrollToCurrentRow (logical) Scrolls to the BindingSource's position
SelectBrowseRow () Selects the (temporary row in the browse widget)
SetRepositionedRow (integer, character) Sets the row index where records positioned with the REPOSITION TO ROWID (or RECID) statement are displayed.
CHARACTER SetTableSchemaColumnsFromBrowse () Returns the comma delimited list of all field names in the browse widget
CHARACTER SetTableSchemaColumnsFromBrowseAndFields () Builds a list of fields for the BindingSource when the BindingSourceFields property is set to BindingSourceFieldsEnum:ListAndFields
StoreSettings () Stores the Column settings to the ISettingsService
SynchronizeCurrentColumn () Updates the current browse cell with the values from the Grid
SynchronizeVisibleColumns () Views and hides columns in the Grid based on the HIDDEN attribute of the browsers columns
CHARACTER UniqueFindPredicate (handle, UltraGridRow) Builds a QueryString predicate that can be used to (re)fetch a record based on equality of primary unique columns Based on the UniqueKeyDictionary values of predetermined unique key columns @param phBuffer The Handle to the buffer to return the FIND predicate for @param poRow The reference to the Row collection that contains the values @return The FIND predicate */
UpdateTitle () Updates the Text property of the Grid based on the TITLE property of the Progress browser
VerifyColorCodedColumnNames () Verifies that the value of the Property ColorCodedColumnNames matches the setting of UseFullFieldNames
VerifyCustomCalculatedColumnNames () Verifies that the value of the Property CustomCalculatedColumnNames matches the setting of UseFullFieldNames
ViewHideColumns () Views and hides columns based on the browsers columns and sets the column header captions

Top Constructor Summary
Options Name Purpose
RenderedBrowseControl (RenderedBrowseContext) Constructor of the RenderedBrowseControl class

Top Event Summary
Options Name Purpose
DefaultAction DELEGATE System.EventHandler EVent raised when the user double clicks a row or presses Enter
FindRecordsForCalculatedFields (Object, FindRecordsForCalculatedFieldsEventArgs) Event raised when the user double clicks a row or presses Enter
OffHome DELEGATE System.EventHandler Event raised when an attempt is made to scroll beyond the first row

Top Property Summary
Options Name Purpose
LOGICAL AnchoredBottom
Consultingwerk.WindowIntegrationKit.Controls.ApplyCellLeaveToBrowseEnum ApplyCellLeaveToBrowse
LOGICAL ApplyEntryOnEnter
Consultingwerk.WindowIntegrationKit.Controls.ApplyFunctionKeyEventsEnum ApplyFunctionKeyEvents
LOGICAL ApplyingEntry
LOGICAL ApplyIterationChanged
LOGICAL ApplyRowDisplayBeforeDisplayFields
LOGICAL ApplyRowEntryOnBeforeEnterEditMode
LOGICAL ApplyRowEntryOnRowActivate
LOGICAL ApplyRowLeaveOnLeave
LOGICAL ApplyRowLeaveOnRowDeactivate
LOGICAL AssignBindingSourceOnRowDeactivate
LOGICAL Batching
Progress.Data.BindingSource BindingSource
CHARACTER BindingSourceFieldList
Consultingwerk.WindowIntegrationKit.Controls.BindingSourceFieldsEnum BindingSourceFields
WIDGET-HANDLE BrowseHandle
HANDLE CallbackProcedure
CHARACTER ColorCodedColumnHandles
CHARACTER ColorCodedColumnNames
Consultingwerk.Windows.IColorTableConverter ColorTableConverter
CHARACTER ColumnLabels
CHARACTER ColumnWidths
HANDLE CURRENT-COLUMN
Consultingwerk.WindowIntegrationKit.Controls.CursorKeyNavigationInEditEnum CursorKeyNavigationInEdit
CHARACTER CustomCalculatedColumnNames
LOGICAL DefaultActionHandled
LOGICAL DisableCalculatedFieldsAndColor
LOGICAL DisableOutlookGroupBy
LOGICAL DynamicColumns
LOGICAL InConstructor
CHARACTER LastActiveCell
INTEGER MaxDataGuess
LOGICAL MonitorBrowseCellEntry
INTEGER NUM-LOCKED-COLUMNS
HANDLE QUERY
Consultingwerk.WindowIntegrationKit.Controls.RepositionedRow RepositionedRow
CHARACTER SettingsKey
LOGICAL SuspendEvents
CHARACTER UnboundColumnHandles
CHARACTER UnboundColumnNames
LOGICAL UseFullFieldNames
LOGICAL ValueChangedSuspended
CHARACTER VisibleColumns
HANDLE WidgetHandle


Method Detail
Top

ActivateCurrentBrowseColumn ()

Purpose: Activates the current browse column in the Grid
Notes:

Top

HANDLE AlternativeQuery (handle)

Purpose: Creates an alternative query that contains alternative buffers to
the tables used by the original query
Notes: Used in the RenderedBrowseControl to assign to the query handle of
the original browse widget

Parameters:
phQuery HANDLE
The original browse handle
Returns HANDLE
The handle to the alternative query created by this routine
Top

AnchorBottom ()

Purpose: Anchors the Grid at the bottom of it's container and takes all remaining space
Notes:

Top

ApplyValueChanged ()

Purpose: Raises the VALUE-CHANGED Event to the Browse Widget
Notes: Conditionally raises the obsolete ITERATION-CHANGED Event as well

Top

bindingSource1_PositionChanged (Object, EventArgs)

Purpose: Event handler for the PositionChanged event of the Progress.Data.BindingSource
Notes:

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

HANDLE BrowseColumnHandleFromGridColumnKey (character)

Purpose: Returns the handle of the browse column related to the UltraGridColumn
Notes:

Parameters:
pcColumnKey CHARACTER
The key of the UltraGridColumn
Returns HANDLE
The handle of the browse column
Top

CloseQuery ()

Purpose: Closes the query by opening it with a query string that matches
no records
Notes: Closing a query that is attached to a binding source results in
runtime errors.

Top

CHARACTER ColumnKeyFromColumnHandle (handle)

Purpose: Returns the key of the UltraGridColumn that represents the given
column of the browse
Notes:

Parameters:
phColumn HANDLE
The handle of a browse column
Returns CHARACTER
The UltraGridColumn Key name (CHARACTER)
Top

CHARACTER ColumnKeyFromFieldName (character, character)

Purpose: Returns the key of the UltraGridColumn that represents the given
buffer field
Notes:

Parameters:
pcBufferName CHARACTER
The name of the buffer in the query
pcFieldName CHARACTER
The nae of the buffer field
Returns CHARACTER
The UltraGridColumn Key name (CHARACTER)
Top

DefaultActionHandler (Object, EventArgs)

Purpose: Call all registered DefaultActionSubscriber to perform their action.
Event handler for the DoubleClickRow event of the base class
(UltraGrid).
Notes:

Parameters:
sender System.Object
System.Object reference to the Object that raised the event (usually THIS-OBJECT)
e System.EventArgs
System.EventArgs, the default .NET empty parameter object
Top

DeleteAlternativeQuery (handle, handle[])

Purpose: Deletes the alternative query and buffer
Notes:

Parameters:
phQueryHandle HANDLE
The handle of the alternative query
phQueryBuffers HANDLE
The array of Query Buffer handles
Top

LOGICAL DESELECT-FOCUSED-ROW ()

Purpose: Deselects the row with current focus.
Notes: Returns TRUE for compability with the ABL built in method

Returns LOGICAL
Logical value, always TRUE
Top

DisplayCurrentRow ()

Purpose: Re-Display's the current row
Notes:

Top

DisplayFromBrowse ()

Purpose: Displays the current browse values on the Grid's current row
Notes:

Top

DisplayFromGrid ()

Purpose: Displays the current Grid values on the BROWSE widgets current row
Notes:

Top

EnableDisableColumns ()

Purpose: Enables and Disables the Columns in the RenderedBrowseControl based
on the current state of the browser columns
Notes:

Top

EnterBrowseCell (handle)

Purpose: Call back procedure for the ENTRY event of the Browse Cells
Notes: Invoked from the browse-event-handler.p Procedure

Parameters:
phColumn HANDLE
The Handle to the Browse Column
Top

FetchByRowid (rowid)

Purpose: Fetches a row/record by a ROWID
Notes: Creates an ROWID EXTENT 1 value and uses the FetchByRowid (ROWID EXTENT)
implementation

Parameters:
poRowid ROWID
The ROWID to reposition to
Top

FetchByRowid (rowid[])

Purpose: Fetches a row/record by a ROWID Array
Notes:

Parameters:
poRowid ROWID
The Array of ROWIDs to reposition to
Top

FetchFirst ()

Purpose: Fetches the first row
Notes:

Top

FetchLast ()

Purpose: Fetches the last row
Notes:

Top

FetchNext ()

Purpose: Fetches the next row
Notes:

Top

FetchPrevious ()

Purpose: Fetches the previous row
Notes:

Top

LOGICAL FetchRow (integer)

Purpose: Moves a query objects result list pointer to the row corresponding
to the specified sequence number.
Notes:

Parameters:
piRow INTEGER
An integer expression representing the sequence number.
Returns LOGICAL
Logical value, indicating the success of the operation
Top

FormDisposedHandler (Object, EventArgs)

Purpose: Event handler for the Dispose event of the containing 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

CHARACTER GetBrowseColumns ()

Purpose: Returns an array describing every column of the browse widget
Notes: Returns per Column Buffername.Fieldname or CALC:DATA-TYPE,FORMAT,INITIAL,LABEL

Returns CHARACTER
A dynamic array with the current browse columns
Top

INTEGER GetRepositionedRow ()

Purpose: Returns the row index of the browse viewport where the REPOSITION
TO ROWID (or RECID) statement displays a repositioned record.
Notes:

Returns INTEGER
The row index of the browse viewport where the REPOSITION TO ROWID (or RECID) statement displays a repositioned record.
Top

InitializeComponent ()


Top

InitializeGrid (handle, logical)

Purpose: Initializes the Grid with the layout from the Progress Browse widget
Notes:

Parameters:
phBrowse HANDLE
The handle of the original browse widget
plUseBatching LOGICAL
Controls the use of Batching of the ProBindingSource
Top

InitializeGrid (RenderedBrowseContext)

Purpose: Initializes the Grid based on the RenderedBrowseContext instance
Notes: Invoked from the Constructor. Allows to re-initialize the Grid when
either the Query or the Browse columns have changed

Parameters:
poContext Consultingwerk.WindowIntegrationKit.Controls.RenderedBrowseContext
An instance of a Consultingwerk.WindowIntegrationKit.Controls.RenderedBrowseContext that contains the settings for this RenderedBrowseControl instance
Top

InitializeRowHandler (Object, InitializeRowEventArgs)

Purpose: Called when a row is initialized
Notes: Best match for the ROW-DISPLAY Event of the Progress Browser
Previously we used to override the OnInitializeRow method which is
generally best practice for handling events of the Control itself.
However in this situation, subscribing to the Event itself allows to
conditionally subscribe to the event which is not possible with the
OnInitializeRow method override

Parameters:
sender System.Object
The reference to the object that raised the event
e Infragistics.Win.UltraWinGrid.InitializeRowEventArgs
An InitializeRowEventArgs instance that contains the event data
Top

InitializeUniqueKeys ()

Purpose: Initializes the UniqueKeyDictionary
Notes:

Top

CHARACTER KeyFieldsForBuffer (handle)

Purpose: Returns the list of unqiue key fields for a buffer
Notes: This is a seperate method to allow customer specific overrides

Parameters:
phBuffer HANDLE
The handle of the buffer
Returns CHARACTER
The comma delimited list of field column names
Top

ListChangedHandler (Object, ListChangedEventArgs)

Purpose: Event handler for the ListChanged event of the ProBindingSource
Notes: The ListChangedType of Reset is typically raised after opening the
query. Calling ProcessColorCodingAndCalculatedFields makes sure that
the original Progress browser shows the first row. This might be
releavent if the ROW-ENTRY event handler requires the first row to
be displayed.

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

ListChangedHandler2 (Object, ListChangedEventArgs)

Purpose: Alternative event handler for the ListChanged event of the ProBindingSource
Notes: Re-Evaluate GroupBy when reopeninig the Query

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

CHARACTER LoadSettings ()

Purpose: Loads a browsers column settings from the Registry
Notes:

Returns CHARACTER
The current user settings
Top

NewUltraGridColumn (UltraGridColumn)

Purpose: Overloadable method, invoked whenever the Grid creates a new Column
Notes: Suitable place to attach ValueBasedAppearance's to the Grid Column

Parameters:
poColumn Infragistics.Win.UltraWinGrid.UltraGridColumn
The reference to the new UltraGridColumn
Top

OnAfterCellActivate ()

Purpose: Called after a cell is activated
Notes:

Top

OnAfterCellUpdate (CellEventArgs)

Purpose: Raises the AfterCellUpdate event
Notes:

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

OnAfterRowActivate ()

Purpose: Called after a row is activated
Notes:

Top

OnBeforeCellDeactivate (CancelEventArgs)

Purpose: Called before a cell is deactivated
Notes:

Parameters:
e System.ComponentModel.CancelEventArgs
An System.ComponentModel.CancelEventArgs instance that contains the event data.
Top

OnBeforeEnterEditMode (CancelEventArgs)

Purpose: Called before entering edit mode
Notes:

Parameters:
e System.ComponentModel.CancelEventArgs
An System.ComponentModel.CancelEventArgs instance that contains the event data.
Top

OnBeforeRowDeactivate (CancelEventArgs)

Purpose: Called before a row is deactivated
Notes:

Parameters:
e System.ComponentModel.CancelEventArgs
An System.ComponentModel.CancelEventArgs instance that contains the event data.
Top

OnBeforeSortChange (BeforeSortChangeEventArgs)

Purpose: Raises the BeforeSortChange event
Notes:

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

OnDefaultAction (EventArgs)

Purpose: Raises the DefaultAction event
Notes:

Parameters:
e System.EventArgs
An System.EventArgs that contains the event data.
Top

OnEnter (EventArgs)

Purpose: Raises the Enter event
Notes: Applies ENTRY to the Progress Browse Widget when ApplyEntryOnEnter is
true

Parameters:
e System.EventArgs
The System.EventArgs that contains the event data
Top

OnFindRecordsForCalculatedFields (FindRecordsForCalculatedFieldsEventArgs)

Purpose: Raises the FindRecordsForCalculatedFields event
Notes:

Parameters:
e Consultingwerk.WindowIntegrationKit.Controls.FindRecordsForCalculatedFieldsEventArgs
The FindRecordsForCalculatedFieldsEventArgs with the data for this event
Top

OnGotFocus (EventArgs)

Purpose: Invokes the GotFocus event.
Notes:

Parameters:
e System.EventArgs
An System.EventArgs instance that contains the event data.
Top

OnInitializeLayout (InitializeLayoutEventArgs)

Purpose: Called when the layout is first initialized after the datasource
has been set
Notes: Used to update the Grid's layout with the layout of the underlying
Progress Browser after the Grid has build Grid Columns for the
Binding Source (query) columns

Parameters:
e Infragistics.Win.UltraWinGrid.InitializeLayoutEventArgs
An System.EventArgs that contains the event data.
Top

OnKeyDown (KeyEventArgs)

Purpose: Raises the Key Down Event
Notes: Bug 2640: Enable Excel-like navigation during update

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

OnLeave (EventArgs)

Purpose: Raises the Leave event
Notes:

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

OnMouseClick (MouseEventArgs)

Purpose: Raises the MouseClick event
Notes:

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

OnOffHome (EventArgs)

Purpose: Raises the OffHome event
Notes:

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

OnParentChanged (EventArgs)

Purpose: Raises the ParentChanged Event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs instance that contains the event data
Top

OnVisibleChanged (EventArgs)

Purpose: Raises the VisibleChanged event
Notes:

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

ProcessColorCodingAndCalculatedFields (UltraGridRow)

Purpose: Processes color coding and calculted fields for a single grid row
Notes: Invoked from OnInitializeRow

Parameters:
poRow Infragistics.Win.UltraWinGrid.UltraGridRow
The currently initialized Grid Row
Top

CHARACTER QueryExceptList (handle)

Purpose: Builds a list of Columns that need to be excluded from the BindingSource
Notes: Prior to 10.2B Service Pack 5 the BindingSource was not able to
distinguish between columns with the same name from two joined
buffers. This method was used to build a list of columns that had
to be excluded from the binding source to avoid issues with the
UltraGrid caused by duplicate column key values

Parameters:
phQuery HANDLE
The handle of the Query widget
Returns CHARACTER
The list of columns to be excluded from the Query
Top

ReGroupBy ()

Purpose: Forces the Grid to update the row grouping (outlook group by)
Notes: Performs re-GroupBy only when there are GroupBy Columns

Top

RepositionControl ()

Purpose: Positions the RenderedBrowseControl on top of the Progress Browse
Notes: Set's Location and Size properties

Top

RestoreDynamicBrowseColumns (character[])

Purpose: Restores the columns of a dynamic browse widget after the query has
been replaced with the alternative query
Notes: The column description has been built by GetBrowseColumns

Parameters:
pcColumns CHARACTER
An array of browse column descriptions
Top

RestoreSettings ()

Purpose: Restores the stored User settings for the RenderedBrowseControl instance
Notes:

Top

CHARACTER ReturnGridSettings ()

Purpose: Returns the User Settings string for the RenderedBrowseControl instance
Notes:

Returns CHARACTER
The serialized user settings of the current RenderedBrowseControl
Top

SaveCurrentRow ()

Purpose: Saves the current row
Notes: Defaults to APPLY ROW-LEAVE to the ABL Browse Widget

Top

SaveCurrentRow (logical)

Purpose: Saves the current row
Notes:

Parameters:
plApplyRowLeave LOGICAL
Logical value indicating if ROW-LEAVE should be applied to the ABL Browse Widget
Top

ScrollToCurrentRow (logical)

Purpose: Scrolls to the BindingSource's position
Notes:

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

SelectBrowseRow ()

Purpose: Selects the (temporary row in the browse widget)
Notes:

Top

SetRepositionedRow (integer, character)

Purpose: Sets the row index where records positioned with the REPOSITION TO
ROWID (or RECID) statement are displayed.
Notes: Currently not yet supports

Parameters:
piRowIndex INTEGER
Indicates the row number where the new record is displayed, 1 being the first row.
pcRepositionMode CHARACTER
ALWAYS or CONDITIONAL
Top

CHARACTER SetTableSchemaColumnsFromBrowse ()

Purpose: Returns the comma delimited list of all field names in the browse
widget
Notes:

Returns CHARACTER
The comma delimited list of all field names in the browse
Top

CHARACTER SetTableSchemaColumnsFromBrowseAndFields ()

Purpose: Builds a list of fields for the BindingSource when the BindingSourceFields
property is set to BindingSourceFieldsEnum:ListAndFields
Notes:

Returns CHARACTER
The list of BindingSource fields
Top

StoreSettings ()

Purpose: Stores the Column settings to the ISettingsService
Notes: This method should be called when settings should be explicitly
stored or when te Parent Forms closes

Top

SynchronizeCurrentColumn ()

Purpose: Updates the current browse cell with the values from the Grid
Notes: Used to make sure that the updatable ABL browse widget is up
to date during event handlers

Top

SynchronizeVisibleColumns ()

Purpose: Views and hides columns in the Grid based on the HIDDEN attribute
of the browsers columns
Notes:

Top

CHARACTER UniqueFindPredicate (handle, UltraGridRow)

Purpose: Builds a QueryString predicate that can be used to (re)fetch a
record based on equality of primary unique columns
Based on the UniqueKeyDictionary values of predetermined unique key
columns

Parameters:
phBuffer HANDLE
The Handle to the buffer to return the FIND predicate for
poRow Infragistics.Win.UltraWinGrid.UltraGridRow
The reference to the Row collection that contains the values
Returns CHARACTER
The FIND predicate
Top

UpdateTitle ()

Purpose: Updates the Text property of the Grid based on the TITLE property
of the Progress browser
Notes: May be used in the triggerend.i include files.

Top

VerifyColorCodedColumnNames ()

Purpose: Verifies that the value of the Property ColorCodedColumnNames
matches the setting of UseFullFieldNames
Notes:

Top

VerifyCustomCalculatedColumnNames ()

Purpose: Verifies that the value of the Property CustomCalculatedColumnNames
matches the setting of UseFullFieldNames
Notes:

Top

ViewHideColumns ()

Purpose: Views and hides columns based on the browsers columns and sets
the column header captions
Notes:



Constructor Detail
Top

RenderedBrowseControl (RenderedBrowseContext)

Purpose: Constructor of the RenderedBrowseControl class
Notes:

Parameters:
poContext Consultingwerk.WindowIntegrationKit.Controls.RenderedBrowseContext
An instance of a Consultingwerk.WindowIntegrationKit.Controls.RenderedBrowseContext that contains the settings for this RenderedBrowseControl instance


Event Detail
Top

DefaultAction DELEGATE System.EventHandler

Purpose: EVent raised when the user double clicks a row or presses Enter
Notes:

Delegate: System.EventHandler
Top

FindRecordsForCalculatedFields (Object, FindRecordsForCalculatedFieldsEventArgs)

Purpose: Event raised when the user double clicks a row or presses Enter
Notes:

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.WindowIntegrationKit.Controls.FindRecordsForCalculatedFieldsEventArgs
The FindRecordsForCalculatedFieldsEventArgs with the data for this event
Top

OffHome DELEGATE System.EventHandler

Purpose: Event raised when an attempt is made to scroll beyond the first row
Notes:

Delegate: System.EventHandler


Property Detail
Top

LOGICAL AnchoredBottom


Returns LOGICAL
Top

Consultingwerk.WindowIntegrationKit.Controls.ApplyCellLeaveToBrowseEnum ApplyCellLeaveToBrowse


Returns Consultingwerk.WindowIntegrationKit.Controls.ApplyCellLeaveToBrowseEnum
Top

LOGICAL ApplyEntryOnEnter


Returns LOGICAL
Top

Consultingwerk.WindowIntegrationKit.Controls.ApplyFunctionKeyEventsEnum ApplyFunctionKeyEvents


Returns Consultingwerk.WindowIntegrationKit.Controls.ApplyFunctionKeyEventsEnum
Top

LOGICAL ApplyingEntry


Returns LOGICAL
Top

LOGICAL ApplyIterationChanged


Returns LOGICAL
Top

LOGICAL ApplyRowDisplayBeforeDisplayFields


Returns LOGICAL
Top

LOGICAL ApplyRowEntryOnBeforeEnterEditMode


Returns LOGICAL
Top

LOGICAL ApplyRowEntryOnRowActivate


Returns LOGICAL
Top

LOGICAL ApplyRowLeaveOnLeave


Returns LOGICAL
Top

LOGICAL ApplyRowLeaveOnRowDeactivate


Returns LOGICAL
Top

LOGICAL AssignBindingSourceOnRowDeactivate


Returns LOGICAL
Top

LOGICAL Batching


Returns LOGICAL
Top

Progress.Data.BindingSource BindingSource


Returns Progress.Data.BindingSource
Top

CHARACTER BindingSourceFieldList


Returns CHARACTER
Top

Consultingwerk.WindowIntegrationKit.Controls.BindingSourceFieldsEnum BindingSourceFields


Returns Consultingwerk.WindowIntegrationKit.Controls.BindingSourceFieldsEnum
Top

WIDGET-HANDLE BrowseHandle


Returns WIDGET-HANDLE
Top

HANDLE CallbackProcedure


Returns HANDLE
Top

CHARACTER ColorCodedColumnHandles


Returns CHARACTER
Top

CHARACTER ColorCodedColumnNames


Returns CHARACTER
Top

Consultingwerk.Windows.IColorTableConverter ColorTableConverter


Returns Consultingwerk.Windows.IColorTableConverter
Top

CHARACTER ColumnLabels


Returns CHARACTER
Top

CHARACTER ColumnWidths


Returns CHARACTER
Top

HANDLE CURRENT-COLUMN


Returns HANDLE
Top

Consultingwerk.WindowIntegrationKit.Controls.CursorKeyNavigationInEditEnum CursorKeyNavigationInEdit


Returns Consultingwerk.WindowIntegrationKit.Controls.CursorKeyNavigationInEditEnum
Top

CHARACTER CustomCalculatedColumnNames


Returns CHARACTER
Top

LOGICAL DefaultActionHandled


Returns LOGICAL
Top

LOGICAL DisableCalculatedFieldsAndColor


Returns LOGICAL
Top

LOGICAL DisableOutlookGroupBy


Returns LOGICAL
Top

LOGICAL DynamicColumns


Returns LOGICAL
Top

LOGICAL InConstructor


Returns LOGICAL
Top

CHARACTER LastActiveCell


Returns CHARACTER
Top

INTEGER MaxDataGuess


Returns INTEGER
Top

LOGICAL MonitorBrowseCellEntry


Returns LOGICAL
Top

INTEGER NUM-LOCKED-COLUMNS


Returns INTEGER
Top

HANDLE QUERY


Returns HANDLE
Top

Consultingwerk.WindowIntegrationKit.Controls.RepositionedRow RepositionedRow


Returns Consultingwerk.WindowIntegrationKit.Controls.RepositionedRow
Top

CHARACTER SettingsKey


Returns CHARACTER
Top

LOGICAL SuspendEvents


Returns LOGICAL
Top

CHARACTER UnboundColumnHandles


Returns CHARACTER
Top

CHARACTER UnboundColumnNames


Returns CHARACTER
Top

LOGICAL UseFullFieldNames


Returns LOGICAL
Top

LOGICAL ValueChangedSuspended


Returns LOGICAL
Top

CHARACTER VisibleColumns


Returns CHARACTER
Top

HANDLE WidgetHandle


Returns HANDLE


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