Namespace: Consultingwerk.Windows.Util
Class 
UltraGridSummaryHelper Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Windows.Util.UltraGridSummaryHelper

Inherits: Progress.Lang.Object

File:UltraGridSummaryHelper
Purpose:Helper routines facilitating the use of the column Summary
feature of the UltraGrid
Syntax:Fluent Style API
UltraGridSummaryHelper:ForColumn(smartDataBrowser1, "SickDaysLeft")
:SetDisplayFormat("Durchschnitt: &1", ">>9.99")
:SetType(SummaryType:Average)
:SetToolTipText("Der Durchschnitt der Sick days") .
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Dec 01 17:59:38 CET 2018
Purpose: Returns the SummarySettings instance
Notes:

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
+ Clear (UltraGrid) Clears the Summaries collection
+ Consultingwerk.Windows.Util.UltraGridSummaryHelper ForColumn (UltraGrid, character) Creates an instance of the UltraGridSummaryHelper for the given column
+ Consultingwerk.Windows.Util.UltraGridSummaryHelper ForColumn (UltraGridColumn) Creates an instance of the UltraGridSummaryHelper for the given column
+ Consultingwerk.Windows.Util.UltraGridSummaryHelper SetDisplayArea (SummaryDisplayAreas) Sets the SummaryDisplayArea
+ Consultingwerk.Windows.Util.UltraGridSummaryHelper SetDisplayFormat (character) Sets the DisplayFormat
+ Consultingwerk.Windows.Util.UltraGridSummaryHelper SetDisplayFormat (character, character) Sets the DisplayFormat
+ Consultingwerk.Windows.Util.UltraGridSummaryHelper SetHAlign (HAlign) Sets the Text HAlign
+ Consultingwerk.Windows.Util.UltraGridSummaryHelper SetPosition (SummaryPosition) Sets the SummaryPosition
+ Consultingwerk.Windows.Util.UltraGridSummaryHelper SetPositionColumn (UltraGridColumn) Sets the SummaryPositionColumn
+ Consultingwerk.Windows.Util.UltraGridSummaryHelper SetToolTipText (character) Sets the ToolTipText
+ Consultingwerk.Windows.Util.UltraGridSummaryHelper SetType (SummaryType) Sets the SummaryType

Top Constructor Summary
Options Name Purpose
# UltraGridSummaryHelper (UltraGridColumn) Protected constructor for the UltraGridSummaryHelper class

Top Property Summary
Options Name Purpose
+ Infragistics.Win.UltraWinGrid.SummarySettings SummarySettings


Method Detail
Top

PUBLIC Clear (UltraGrid)
Purpose: Clears the Summaries collection
Notes:

Parameters:
poGrid Infragistics.Win.UltraWinGrid.UltraGrid
The reference to the Grid control
Top

PUBLIC Consultingwerk.Windows.Util.UltraGridSummaryHelper ForColumn (UltraGrid, character)
Purpose: Creates an instance of the UltraGridSummaryHelper for the given column
Notes: References the column of the first band

Parameters:
poGrid Infragistics.Win.UltraWinGrid.UltraGrid
The reference of the UltraGrid
pcColumnKey CHARACTER
The key of the UltraGrid Column
Returns Consultingwerk.Windows.Util.UltraGridSummaryHelper
The reference to the UltraGridSummaryHelper instance (for fluent style)
Top

PUBLIC Consultingwerk.Windows.Util.UltraGridSummaryHelper ForColumn (UltraGridColumn)
Purpose: Creates an instance of the UltraGridSummaryHelper for the given column
Notes:

Parameters:
poColumn Infragistics.Win.UltraWinGrid.UltraGridColumn
The reference to the UltraGrid Column
Returns Consultingwerk.Windows.Util.UltraGridSummaryHelper
The reference to the UltraGridSummaryHelper instance (for fluent style)
Top

PUBLIC Consultingwerk.Windows.Util.UltraGridSummaryHelper SetDisplayArea (SummaryDisplayAreas)
Purpose: Sets the SummaryDisplayArea
Notes:

Parameters:
poSummaryDisplayArea Infragistics.Win.UltraWinGrid.SummaryDisplayAreas
The SummaryDisplayAreas value
Returns Consultingwerk.Windows.Util.UltraGridSummaryHelper
The reference to the UltraGridSummaryHelper instance (for fluent style)
Top

PUBLIC Consultingwerk.Windows.Util.UltraGridSummaryHelper SetDisplayFormat (character)
Purpose: Sets the DisplayFormat
Notes: The placeholder for the value can be passed as &1 or {0}

Parameters:
pcDisplayFormat CHARACTER
The value for the DisplayFormat property
Returns Consultingwerk.Windows.Util.UltraGridSummaryHelper
The reference to the UltraGridSummaryHelper instance (for fluent style)
Top

PUBLIC Consultingwerk.Windows.Util.UltraGridSummaryHelper SetDisplayFormat (character, character)
Purpose: Sets the DisplayFormat
Notes: The placeholder for the value can be passed as &1 or {0}

Parameters:
pcDisplayFormat CHARACTER
The value for the DisplayFormat property
pcAblFormatString CHARACTER
The ABL Format phrase to use to format the value
Returns Consultingwerk.Windows.Util.UltraGridSummaryHelper
The reference to the UltraGridSummaryHelper instance (for fluent style)
Top

PUBLIC Consultingwerk.Windows.Util.UltraGridSummaryHelper SetHAlign (HAlign)
Purpose: Sets the Text HAlign
Notes:

Parameters:
poHAlign Infragistics.Win.HAlign
The HAlign value
Returns Consultingwerk.Windows.Util.UltraGridSummaryHelper
The reference to the UltraGridSummaryHelper instance (for fluent style)
Top

PUBLIC Consultingwerk.Windows.Util.UltraGridSummaryHelper SetPosition (SummaryPosition)
Purpose: Sets the SummaryPosition
Notes:

Parameters:
poSummaryPosition Infragistics.Win.UltraWinGrid.SummaryPosition
The SummaryPosition value
Returns Consultingwerk.Windows.Util.UltraGridSummaryHelper
The reference to the UltraGridSummaryHelper instance (for fluent style)
Top

PUBLIC Consultingwerk.Windows.Util.UltraGridSummaryHelper SetPositionColumn (UltraGridColumn)
Purpose: Sets the SummaryPositionColumn
Notes:

Parameters:
poColumn Infragistics.Win.UltraWinGrid.UltraGridColumn
The SummaryPositionColumn value
Returns Consultingwerk.Windows.Util.UltraGridSummaryHelper
The reference to the UltraGridSummaryHelper instance (for fluent style)
Top

PUBLIC Consultingwerk.Windows.Util.UltraGridSummaryHelper SetToolTipText (character)
Purpose: Sets the ToolTipText
Notes:

Parameters:
pcToolTipText CHARACTER
The ToolTipText value
Returns Consultingwerk.Windows.Util.UltraGridSummaryHelper
The reference to the UltraGridSummaryHelper instance (for fluent style)
Top

PUBLIC Consultingwerk.Windows.Util.UltraGridSummaryHelper SetType (SummaryType)
Purpose: Sets the SummaryType
Notes:

Parameters:
poSummaryType Infragistics.Win.UltraWinGrid.SummaryType
The SummaryType value
Returns Consultingwerk.Windows.Util.UltraGridSummaryHelper
The reference to the UltraGridSummaryHelper instance (for fluent style)


Constructor Detail
Top

PROTECTED UltraGridSummaryHelper (UltraGridColumn)
Purpose: Protected constructor for the UltraGridSummaryHelper class
Notes:

Parameters:
poColumn Infragistics.Win.UltraWinGrid.UltraGridColumn
The reference to the UltraGrid Column


Property Detail
Top

PUBLIC Infragistics.Win.UltraWinGrid.SummarySettings SummarySettings

Returns Infragistics.Win.UltraWinGrid.SummarySettings


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 06:25:42