Namespace: Consultingwerk.WindowIntegrationKit.Controls
Class 
RenderedBrowseContext Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object

File:RenderedBrowseContext
Purpose:Parameter class for the constructor of the
RenderedBrowseControl class
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Tue Feb 14 12:24:09 CET 2012
Notes:Simplifies extension and customization as only a single
parameter is requred to the RenderedBrowseControl constructor


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

Top Property Summary
Options Name Purpose
+ 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 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 Gets and sets if the instance to the RenderedBrowseControl is using Batching
+ 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
+ HANDLE BrowseHandle Gets and sets the handle of the original browse widget
+ HANDLE CallBackProcedure Gets and sets the handle of the Procedure to use for call-backs
+ CHARACTER ColorCodingColumnNames Gets and sets a list of column keys to be used for the automatic processing of color coding (ROW-DISPLAY Trigger)
+ 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
+ Consultingwerk.WindowIntegrationKit.Controls.CursorKeyNavigationInEditEnum CursorKeyNavigationInEdit Get's and sets if the CursorKeyNavigation during update is used
+ CHARACTER CustomCalculatedColumnNames Gets and sets a list of column keys to be used for the additional automatic processing of of calculated fields (ROW-DISPLAY Trigger)
+ 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
+ System.Windows.Forms.DockStyle Dock Gets and sets the inital value for the Dock property of the grid
+ LOGICAL DynamicColumns Gets and sets of the Browser has dynamic columns
+ Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm EmbeddedWindowForm Gets and sets the reference to the IEmbeddedWindowForm that should contain the RenderedBrowseControl
+ LOGICAL EnableSearch Gets and sets if search capabilities should be enabled for the current browse instance.
+ CHARACTER GridName Gets and sets the name that should be set to the RenderedBrowseControl instance
+ INTEGER MaxDataGuess 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
+ System.Windows.Forms.Control Parent Gets and sets the reference to the .NET Control that should be used as the parent for the RenderedBrowseControl instance
+ CHARACTER SettingsKey Gets and sets key used as the base key when getting user settings from the ISettingsService implementation
+ 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


Constructor Detail
Top

PUBLIC RenderedBrowseContext ()

Purpose: Constructor for the RenderedBrowseContext class
Notes:



Property Detail
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 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: Gets and sets 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 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 HANDLE BrowseHandle

Purpose: Gets and sets the handle of the original browse widget
Notes:

Returns HANDLE
Top

PUBLIC HANDLE CallBackProcedure

Purpose: Gets and sets the handle of the Procedure to use for call-backs
Notes:

Returns HANDLE
Top

PUBLIC CHARACTER ColorCodingColumnNames

Purpose: Gets and sets 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 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 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: Gets and sets a list of column keys to be used for the additional
automatic processing of of calculated fields (ROW-DISPLAY Trigger)
Notes: "*" to process all columns IS NOT SUPPORTED!
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 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 System.Windows.Forms.DockStyle Dock

Purpose: Gets and sets the inital value for the Dock property of the grid
Notes: Allows to avoid need for repositioning the Grid during initalization
Only applied, when a valid value is assigned

Returns System.Windows.Forms.DockStyle
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

PUBLIC Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm EmbeddedWindowForm

Purpose: Gets and sets the reference to the IEmbeddedWindowForm that should
contain the RenderedBrowseControl
Notes:

Returns Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
Top

PUBLIC LOGICAL EnableSearch

Purpose: Gets and sets if search capabilities should be enabled for the
current browse instance.
Notes: This property is not passed to the actual RenderedBrowseControl
instance. However it does allow the calling program to know if for
the current browser an RenderedBrowseControl or
RenderedBrowseWithSearchControl instance should be created. Typically
assigned by a callback in the actual ABL GUI program.

Returns LOGICAL
Top

PUBLIC CHARACTER GridName

Purpose: Gets and sets the name that should be set to the RenderedBrowseControl
instance
Notes:

Returns CHARACTER
Top

PUBLIC INTEGER MaxDataGuess

Purpose: 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 System.Windows.Forms.Control Parent

Purpose: Gets and sets the reference to the .NET Control that should be used
as the parent for the RenderedBrowseControl instance
Notes:

Returns System.Windows.Forms.Control
Top

PUBLIC CHARACTER SettingsKey

Purpose: Gets and sets key used as the base key when getting user settings
from the ISettingsService implementation
Notes:

Returns CHARACTER
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


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