Namespace: Consultingwerk.WindowIntegrationKit.Controls
Class 
RenderedBrowseControl Copy to Clipboard
Parent classes:
Infragistics.Win.UltraWinGrid.UltraGrid
Consultingwerk.WindowIntegrationKit.Controls.RenderedBrowseControl

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

Navigate to: Methods | Constructors | Events | Properties



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).
+ 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 () Initializes the Visual Design
# InitializeGrid (handle, IEmbeddedWindowForm, Control, logical) Initializes the Grid with the layout from the Progress Browse widget
- 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 Returns if the Grid is anchored to the Bottom of the Form
+ Consultingwerk.WindowIntegrationKit.Controls.ApplyCellLeaveToBrowseEnum ApplyCellLeaveToBrowse Gets and sets if the LEAVE Event should be APPLY'd to the browse widget and if the leave event should be published on Deactivate or EndUpdate of the cell
+ LOGICAL ApplyEntryOnEnter Gets and sets if the Enter event of the RenderedBrowserControl will APPLY ENTRY to the Browse widget
+ Consultingwerk.WindowIntegrationKit.Controls.ApplyFunctionKeyEventsEnum ApplyFunctionKeyEvents Gets and sets where Function Key events will be APPLY'd to
+ LOGICAL ApplyingEntry Logical value indicating if the Grid is currently applying ENTRY to the browse widget
+ LOGICAL ApplyIterationChanged Gets and sets if the RenderedBrowseControl will APPLY the ITERATION-CHANGED event together with the VALUE-CHANGED Event
+ LOGICAL ApplyRowDisplayBeforeDisplayFields Gets and sets if the instance to the RenderedBrowseControl is should Apply the ROW-DISPLAY Evnt to the Browser before (TRUE) or after (FALSE) running the WindowDisplayFieldsIn... hook procedure
+ LOGICAL ApplyRowEntryOnBeforeEnterEditMode Gets and sets if the instance of the RenderedBrowseControl should APPLY ROW-ENTRY to the Progress Browse OnBeforeEnterEditMode
+ LOGICAL ApplyRowEntryOnRowActivate Gets and sets if the instance of the RenderedBrowseControl should APPLY ROW-ENTRY to the Progress Browse OnRowActivate
+ LOGICAL ApplyRowLeaveOnLeave Gets and sets if the instance of the RenderedBrowseControl should APPLY ROW-LEAVE to the Progress browse OnLeave
+ LOGICAL ApplyRowLeaveOnRowDeactivate Gets and sets if the instance of the RenderedBrowseControl should APPLY ROW-LEAVE to the Progress Browse OnBeforeRowDeactivate
+ LOGICAL AssignBindingSourceOnRowDeactivate Gets and sets if the BindingSource fields should be Assign-ed to the buffer during handling the OnRowDeactivate
+ LOGICAL Batching Returns if the instance to the RenderedBrowseControl is using Batching
+ Progress.Data.BindingSource BindingSource Returns the reference to the bound Progress.Data.BindingSource instance
+ CHARACTER BindingSourceFieldList Gets and sets the List of fields that will be exposed to the ProBindingSource used by the RenderedBrowseControl
+ Consultingwerk.WindowIntegrationKit.Controls.BindingSourceFieldsEnum BindingSourceFields Gets and sets the BindingSourceFieldsEnum value indicating which fields will be added to the ProBindingSource of the RenderedBrowseControl
+ WIDGET-HANDLE BrowseHandle Return the handle of the original browse widget
+ HANDLE CallbackProcedure Returns the handle of the Procedure to use for call-backs
+ CHARACTER ColorCodedColumnHandles Returns a list of the browse column handles matching the ColorCodedColumnNames, to be used for the automatic processing of color coding (ROW-DISPLAY Trigger)
+ CHARACTER ColorCodedColumnNames Returns a list of column keys to be used for the automatic processing of color coding (ROW-DISPLAY Trigger)
+ Consultingwerk.Windows.IColorTableConverter ColorTableConverter Gets and sets the reference to the IColorTableConverted used by this control
+ CHARACTER ColumnLabels Gets and sets the labels of the Visible Columns as an override to the currnetly visible browse columns
+ CHARACTER ColumnWidths Gets and sets the widths of the Visible Columns as an override to the currnetly visible browse columns
+ HANDLE CURRENT-COLUMN Returns the handle of the current browse column
+ Consultingwerk.WindowIntegrationKit.Controls.CursorKeyNavigationInEditEnum CursorKeyNavigationInEdit Get's and sets if the CursorKeyNavigation during update is used
+ CHARACTER CustomCalculatedColumnNames Returns the list of column keys to be used for the additional automatic processing of of calculated fields (ROW-DISPLAY Trigger)
+ LOGICAL DefaultActionHandled Gets and sets if the DEFAULT-ACTION event has been handled by an event handled from the recend APPLY "DEFAULT-ACTION"
+ LOGICAL DisableCalculatedFieldsAndColor Gets and sets if the InitializeRow and ListChanged events should execute code to handle ABL calculated fields and value based color based on synchronizing the ROW-DISPLAY trigger
+ LOGICAL DisableOutlookGroupBy Gets and sets if the RenderedBrowseControl should disable the OutlookGroupBy even when Batching is not used
+ LOGICAL DynamicColumns Gets and sets of the Browser has dynamic columns
# LOGICAL InConstructor Returns if the RenderedBrowseControl is still within the execution of the CONSTRUCTOR
+ CHARACTER LastActiveCell Gets and sets the Key of the last activated Grid cell
+ INTEGER MaxDataGuess Gets and sets the MaxDataGuess value for the RenderedBrowseControl instance, used only when batching
+ LOGICAL MonitorBrowseCellEntry Gets and sets if the RenderedBrowseControl should subscribe to the ENTRY event of the Browse Cells
+ INTEGER NUM-LOCKED-COLUMNS The number of visible leading columns locked in a browse widget.
+ HANDLE QUERY Returns the Query handle of the browse
+ Consultingwerk.WindowIntegrationKit.Controls.RepositionedRow RepositionedRow Returns the parameters for the
+ CHARACTER SettingsKey The key used as the base key when getting user settings from the ISettingsService implementation
+ LOGICAL SuspendEvents Gets and sets if this Control should suspend APPLY'ing evens to the Progress Browse Control
+ CHARACTER UnboundColumnHandles A comma-delimited list of unbound column handles
+ CHARACTER UnboundColumnNames A comma-delimited list of unbound column names
+ LOGICAL UseFullFieldNames Returns if grid column names are prefixed with the buffer name
+ LOGICAL ValueChangedSuspended Returns of the ValueChanged event is currently suspended
+ CHARACTER VisibleColumns Gets and sets the names of the browse columns that are supposed to be visible as an override to the currently visible browse columns
+ HANDLE WidgetHandle Returns a reference to the widget handle this Control is replacing on the screen


Method Detail
Top

PUBLIC ActivateCurrentBrowseColumn ()
Purpose: Activates the current browse column in the Grid
Notes:

Top

PROTECTED 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

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

Top

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

Top

PRIVATE 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PRIVATE 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

PUBLIC 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

PUBLIC DisplayCurrentRow ()
Purpose: Re-Display's the current row
Notes:

Top

PUBLIC DisplayFromBrowse ()
Purpose: Displays the current browse values on the Grid's current row
Notes:

Top

PUBLIC DisplayFromGrid ()
Purpose: Displays the current Grid values on the BROWSE widgets current row
Notes:

Top

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

Top

PUBLIC 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

PUBLIC 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

PUBLIC FetchByRowid (rowid[])
Purpose: Fetches a row/record by a ROWID Array
Notes:

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

PUBLIC FetchFirst ()
Purpose: Fetches the first row
Notes:

Top

PUBLIC FetchLast ()
Purpose: Fetches the last row
Notes:

Top

PUBLIC FetchNext ()
Purpose: Fetches the next row
Notes:

Top

PUBLIC FetchPrevious ()
Purpose: Fetches the previous row
Notes:

Top

PUBLIC 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

PROTECTED 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

PUBLIC 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

PUBLIC 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

PRIVATE InitializeComponent ()
Purpose: Initializes the Visual Design
Notes:

Top

PROTECTED InitializeGrid (handle, IEmbeddedWindowForm, Control, logical)
Purpose: Initializes the Grid with the layout from the Progress Browse widget
Notes:

Parameters:
phBrowse HANDLE
The handle of the original browse widget
poEmbeddedWindowForm Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
The reference to the IEmbeddedWindowForm hosting the Window of the Progress browse widget
poParent System.Windows.Forms.Control
The parent .NET Control
plUseBatching LOGICAL
Controls the use of Batching of the ProBindingSource
Top

PRIVATE 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

PROTECTED InitializeUniqueKeys ()
Purpose: Initializes the UniqueKeyDictionary
Notes:

Top

PUBLIC 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

PRIVATE 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

PRIVATE 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

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

Returns CHARACTER
The current user settings
Top

PROTECTED 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

PROTECTED OnAfterCellActivate ()
Purpose: Called after a cell is activated
Notes:

Top

PROTECTED OnAfterCellUpdate (CellEventArgs)
Purpose: Raises the AfterCellUpdate event
Notes:

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

PROTECTED OnAfterRowActivate ()
Purpose: Called after a row is activated
Notes:

Top

PROTECTED 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

PROTECTED 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

PROTECTED 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

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

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

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

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

PROTECTED 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

PROTECTED OnFindRecordsForCalculatedFields (FindRecordsForCalculatedFieldsEventArgs)
Purpose: Raises the FindRecordsForCalculatedFields event
Notes:

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

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

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

PROTECTED 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

PROTECTED 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

PROTECTED OnLeave (EventArgs)
Purpose: Raises the Leave event
Notes:

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

PROTECTED OnMouseClick (MouseEventArgs)
Purpose: Raises the MouseClick event
Notes:

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

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

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

PROTECTED OnOffHome (EventArgs)
Purpose: Raises the OffHome event
Notes:

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

PROTECTED OnParentChanged (EventArgs)
Purpose: Raises the ParentChanged Event
Notes:

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

PROTECTED OnVisibleChanged (EventArgs)
Purpose: Raises the VisibleChanged event
Notes:

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

PROTECTED 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

PROTECTED 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

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

Top

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

Top

PROTECTED 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

PROTECTED RestoreSettings ()
Purpose: Restores the stored User settings for the RenderedBrowseControl instance
Notes:

Top

PUBLIC CHARACTER ReturnGridSettings ()
Purpose: Returns the User Settings string for the RenderedBrowseControl instance
Notes:

Returns CHARACTER
The serialized user settings of the current RenderedBrowseControl
Top

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

Top

PUBLIC 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

PUBLIC 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

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

Top

PUBLIC 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

PROTECTED 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

PROTECTED 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

PUBLIC 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

PUBLIC 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

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

Top

PROTECTED 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

PUBLIC 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

PROTECTED VerifyColorCodedColumnNames ()
Purpose: Verifies that the value of the Property ColorCodedColumnNames
matches the setting of UseFullFieldNames
Notes:

Top

PROTECTED VerifyCustomCalculatedColumnNames ()
Purpose: Verifies that the value of the Property CustomCalculatedColumnNames
matches the setting of UseFullFieldNames
Notes:

Top

PROTECTED ViewHideColumns ()
Purpose: Views and hides columns based on the browsers columns and sets
the column header captions
Notes:



Constructor Detail
Top

PUBLIC 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

PUBLIC DefaultAction DELEGATE System.EventHandler
Purpose: EVent raised when the user double clicks a row or presses Enter
Notes:

Delegate: System.EventHandler
Top

PUBLIC 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

PUBLIC 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

PUBLIC LOGICAL AnchoredBottom
Purpose: Returns if the Grid is anchored to the Bottom of the Form
Notes:

Returns LOGICAL
Top

PUBLIC Consultingwerk.WindowIntegrationKit.Controls.ApplyCellLeaveToBrowseEnum ApplyCellLeaveToBrowse
Purpose: Gets and sets if the LEAVE Event should be APPLY'd to the browse widget
and if the leave event should be published on Deactivate or EndUpdate
of the cell
Notes: EndUpdate is only fired, when the cell value actually has changed

Returns Consultingwerk.WindowIntegrationKit.Controls.ApplyCellLeaveToBrowseEnum
Top

PUBLIC LOGICAL ApplyEntryOnEnter
Purpose: Gets and sets if the Enter event of the RenderedBrowserControl will
APPLY ENTRY to the Browse widget
Notes:

Returns LOGICAL
Top

PUBLIC Consultingwerk.WindowIntegrationKit.Controls.ApplyFunctionKeyEventsEnum ApplyFunctionKeyEvents
Purpose: Gets and sets where Function Key events will be APPLY'd to
Notes: Controls if F1..F12 events on the Grid will result in an APPLY "Fn"
TO the CURRENT-COLUMN or the BROWSE widget

Returns Consultingwerk.WindowIntegrationKit.Controls.ApplyFunctionKeyEventsEnum
Top

PUBLIC LOGICAL ApplyingEntry
Purpose: Logical value indicating if the Grid is currently applying ENTRY
to the browse widget
Notes:

Returns LOGICAL
Top

PUBLIC LOGICAL ApplyIterationChanged
Purpose: Gets and sets if the RenderedBrowseControl will APPLY the ITERATION-CHANGED
event together with the VALUE-CHANGED Event
Notes:

Returns LOGICAL
Top

PUBLIC LOGICAL ApplyRowDisplayBeforeDisplayFields
Purpose: Gets and sets if the instance to the RenderedBrowseControl is should
Apply the ROW-DISPLAY Evnt to the Browser before (TRUE) or after (FALSE)
running the WindowDisplayFieldsIn... hook procedure
Notes: In programs, where the ROW-DISPLAY Trigger of a browse widget changes
the value of fields (e.g. a linked temp-table) or variables and expects
the automatic display of those the ROW-DISPLAY Trigger is expected
to execute before the WinKitDisplayFieldsIn... hook.
In programs, where the ROW-DISPLAY Trigger of a browse modifies the
SCREEN-VALUE of certain columns ten the WinKitDisplayFieldsIn... hook
needs to run before
This property is mainly relevant when using the CustomCalculatedColumnNames

Returns LOGICAL
Top

PUBLIC LOGICAL ApplyRowEntryOnBeforeEnterEditMode
Purpose: Gets and sets if the instance of the RenderedBrowseControl should
APPLY ROW-ENTRY to the Progress Browse OnBeforeEnterEditMode
Notes: Typically applying ROW-ENTRY during OnBeforeEnterEditMode may cause
issues with ADM1 based updatable browser

Returns LOGICAL
Top

PUBLIC LOGICAL ApplyRowEntryOnRowActivate
Purpose: Gets and sets if the instance of the RenderedBrowseControl should
APPLY ROW-ENTRY to the Progress Browse OnRowActivate
Notes:

Returns LOGICAL
Top

PUBLIC LOGICAL ApplyRowLeaveOnLeave
Purpose: Gets and sets if the instance of the RenderedBrowseControl should
APPLY ROW-LEAVE to the Progress browse OnLeave
Notes:

Returns LOGICAL
Top

PUBLIC LOGICAL ApplyRowLeaveOnRowDeactivate
Purpose: Gets and sets if the instance of the RenderedBrowseControl should
APPLY ROW-LEAVE to the Progress Browse OnBeforeRowDeactivate
Notes:

Returns LOGICAL
Top

PUBLIC LOGICAL AssignBindingSourceOnRowDeactivate
Purpose: Gets and sets if the BindingSource fields should be Assign-ed to the
buffer during handling the OnRowDeactivate
Notes:

Returns LOGICAL
Top

PUBLIC LOGICAL Batching
Purpose: Returns if the instance to the RenderedBrowseControl is using Batching
Notes: Tied to the MaxDataGuess property of the bound Progress.Data.BindingSource
components

Returns LOGICAL
Top

PUBLIC Progress.Data.BindingSource BindingSource
Purpose: Returns the reference to the bound Progress.Data.BindingSource instance
Notes:

Returns Progress.Data.BindingSource
Top

PUBLIC CHARACTER BindingSourceFieldList
Purpose: Gets and sets the List of fields that will be exposed to the
ProBindingSource used by the RenderedBrowseControl
Notes: See BindingSourceFields property for details

Returns CHARACTER
Top

PUBLIC Consultingwerk.WindowIntegrationKit.Controls.BindingSourceFieldsEnum BindingSourceFields
Purpose: Gets and sets the BindingSourceFieldsEnum value indicating which
fields will be added to the ProBindingSource of the RenderedBrowseControl
Notes: With AllFields (default) all fields that are available though the
browsers query will be added to the ProBindingSource, with BrowserFields
only those fields that are displayed in the original Progerss Browse
widget will be shown, with UseList The BindingSourceFieldList property
will be used to determine which fields should be exposed to the
GUI for .NET

Returns Consultingwerk.WindowIntegrationKit.Controls.BindingSourceFieldsEnum
Top

PUBLIC WIDGET-HANDLE BrowseHandle
Purpose: Return the handle of the original browse widget
Notes:

Returns WIDGET-HANDLE
Top

PUBLIC HANDLE CallbackProcedure
Purpose: Returns the handle of the Procedure to use for call-backs
Notes:

Returns HANDLE
Top

PUBLIC CHARACTER ColorCodedColumnHandles
Purpose: Returns a list of the browse column handles matching the
ColorCodedColumnNames, to be used for the automatic processing
of color coding (ROW-DISPLAY Trigger)
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER ColorCodedColumnNames
Purpose: Returns a list of column keys to be used for the automatic processing
of color coding (ROW-DISPLAY Trigger)
Notes: Pass in "*" to process all columns

Returns CHARACTER
Top

PUBLIC Consultingwerk.Windows.IColorTableConverter ColorTableConverter
Purpose: Gets and sets the reference to the IColorTableConverted used by
this control
Notes:

Returns Consultingwerk.Windows.IColorTableConverter
Top

PUBLIC CHARACTER ColumnLabels
Purpose: Gets and sets the labels of the Visible Columns as an override to
the currnetly visible browse columns
Notes: Used in RenderedBrowseControl:ViewHideColumns in combination with
VisibleColumns

Returns CHARACTER
Top

PUBLIC CHARACTER ColumnWidths
Purpose: Gets and sets the widths of the Visible Columns as an override to
the currnetly visible browse columns
Notes: Used in RenderedBrowseControl:ViewHideColumns in combination with
VisibleColumns

Returns CHARACTER
Top

PUBLIC HANDLE CURRENT-COLUMN
Purpose: Returns the handle of the current browse column
Notes: Used during the START-SEARCH trigger

Returns HANDLE
Top

PUBLIC Consultingwerk.WindowIntegrationKit.Controls.CursorKeyNavigationInEditEnum CursorKeyNavigationInEdit
Purpose: Get's and sets if the CursorKeyNavigation during update is used
Notes:

Returns Consultingwerk.WindowIntegrationKit.Controls.CursorKeyNavigationInEditEnum
Top

PUBLIC CHARACTER CustomCalculatedColumnNames
Purpose: Returns the list of column keys to be used for the additional
automatic processing of of calculated fields (ROW-DISPLAY Trigger)
Notes: Pass in "*" to process all columns
By default only "unbound" columns in the UltraGrid are handled as
calcuolated columns. Use this property when regular query columns
for database or temp-tables are used as a placeholder for a calculated
field

Returns CHARACTER
Top

PUBLIC LOGICAL DefaultActionHandled
Purpose: Gets and sets if the DEFAULT-ACTION event has been handled by an
event handled from the recend APPLY "DEFAULT-ACTION"
Notes:

Returns LOGICAL
Top

PUBLIC LOGICAL DisableCalculatedFieldsAndColor
Purpose: Gets and sets if the InitializeRow and ListChanged events should
execute code to handle ABL calculated fields and value based color
based on synchronizing the ROW-DISPLAY trigger
Notes: Turning these features off may greatly improve the performance of
the RenderedBrowseControl

Returns LOGICAL
Top

PUBLIC LOGICAL DisableOutlookGroupBy
Purpose: Gets and sets if the RenderedBrowseControl should disable the
OutlookGroupBy even when Batching is not used
Notes: By default Grids that do not use batching to allow the OutlookGroupBy

Returns LOGICAL
Top

PUBLIC LOGICAL DynamicColumns
Purpose: Gets and sets of the Browser has dynamic columns
Notes: Dynamic columns need to be stored and restored by the RenderedBrowseControl
because the browser will loose those columns when the browsers
Query is replaced

Returns LOGICAL
Top

PROTECTED LOGICAL InConstructor
Purpose: Returns if the RenderedBrowseControl is still within the execution
of the CONSTRUCTOR
Notes: Used to avoid raising the VALUE-CHANGED event too early

Returns LOGICAL
Top

PUBLIC CHARACTER LastActiveCell
Purpose: Gets and sets the Key of the last activated Grid cell
Notes:

Returns CHARACTER
Top

PUBLIC INTEGER MaxDataGuess
Purpose: Gets and sets the MaxDataGuess value for the RenderedBrowseControl
instance, used only when batching
Notes: Default value is set by WinKitControls:DefaultMaxDataGuess

Returns INTEGER
Top

PUBLIC LOGICAL MonitorBrowseCellEntry
Purpose: Gets and sets if the RenderedBrowseControl should subscribe to the
ENTRY event of the Browse Cells
Notes:

Returns LOGICAL
Top

PUBLIC INTEGER NUM-LOCKED-COLUMNS
Purpose: The number of visible leading columns locked in a browse widget.
Notes: If a locked column is hidden, the next visible non-locked column in
the browse will then become locked.
When you use the horizontal scrollbar to scroll columns in the browse,
locked columns do not move. For example, if NUM-LOCKED-COLUMNS is 3,
then the three leftmost columns in the browse are locked.

Returns INTEGER
Top

PUBLIC HANDLE QUERY
Purpose: Returns the Query handle of the browse
Notes:

Returns HANDLE
Top

PUBLIC Consultingwerk.WindowIntegrationKit.Controls.RepositionedRow RepositionedRow
Purpose: Returns the parameters for the
Notes: Currently only supported as a holder class. The reposition methods
to not yet use these values

Returns Consultingwerk.WindowIntegrationKit.Controls.RepositionedRow
Top

PUBLIC CHARACTER SettingsKey
Purpose: The key used as the base key when getting user settings from the
ISettingsService implementation
Notes:

Returns CHARACTER
Top

PUBLIC LOGICAL SuspendEvents
Purpose: Gets and sets if this Control should suspend APPLY'ing evens to the
Progress Browse Control
Notes:

Returns LOGICAL
Top

PUBLIC CHARACTER UnboundColumnHandles
Purpose: A comma-delimited list of unbound column handles
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER UnboundColumnNames
Purpose: A comma-delimited list of unbound column names
Notes:

Returns CHARACTER
Top

PUBLIC LOGICAL UseFullFieldNames
Purpose: Returns if grid column names are prefixed with the buffer name
Notes:

Returns LOGICAL
Top

PUBLIC LOGICAL ValueChangedSuspended
Purpose: Returns of the ValueChanged event is currently suspended
Notes:

Returns LOGICAL
Top

PUBLIC CHARACTER VisibleColumns
Purpose: Gets and sets the names of the browse columns that are supposed to
be visible as an override to the currently visible browse columns
Notes: See RenderedBrowseControl:ViewHideColumns

Returns CHARACTER
Top

PUBLIC HANDLE WidgetHandle
Purpose: Returns a reference to the widget handle this Control is replacing
on the screen
Notes: Required by the Consultingwerk.WindowIntegrationKit.Controls.IOverlayControl
Interface

Returns HANDLE


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