FormulaRowIndexSource Enumeration

Enum used for specifying UltraGridOverride.FormulaRowIndexSource property.

Syntax

Visual Basic

'Declaration
 
Public Enum FormulaRowIndexSource 
   Inherits System.Enum

C#

public enum FormulaRowIndexSource : System.Enum 

Members

Member	Description
Default	Default. Resolves to VisibleIndex.
ListIndex	Row's list index. This is the index associated with UltraGridRow.ListIndex property.
RowIndex	Row's index in its parent rows collection. This is the index associated with UltraGridRow.Index property.
VisibleIndex	Row's visible index in the parent rows collection. This is the index associated with UltraGridRow.VisibleIndex property.

Remarks

See Override's UltraGridOverride.FormulaRowIndexSource property for more information.

Example

Following code shows how to use formulas in UltraWinGrid.

Visual Basic

Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinGrid


    Private Sub UltraGrid1_InitializeLayout(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinGrid.InitializeLayoutEventArgs) Handles ultraGrid1.InitializeLayout
        ' A valid UltraCalcManager instance must be assigned to the the CalcManager
        ' property of the UltraGrid in order to be able to use formulas. Typically
        ' you do this by simply putting an UltraCalcManager component on the form. If
        ' you have already put an UltraCalcManager on the form then you don't need to
        ' assign the CalcManager proeprty. NOTE: You must add UltraWinCalcManager
        ' assembly to the list of assembly references.
        Dim calcManager As Infragistics.Win.UltraWinCalcManager.UltraCalcManager
        calcManager = New Infragistics.Win.UltraWinCalcManager.UltraCalcManager(Me.Container)
        e.Layout.Grid.CalcManager = calcManager

        ' You can set formula on a column.
        e.Layout.Bands(0).Columns("Col1").Formula = "10 * [Col2]"

        ' You can create a formula summary. Following summary calculates the sum of
        ' Col1 column.
        e.Layout.Bands(0).Summaries.Add("Summary1", "sum( [Col1] )")

        ' FormulaErrorAppearance specifies the appearance of cells and summaries that
        ' contain formula errors.
        e.Layout.Override.FormulaErrorAppearance.BackColor = Color.Red

        ' FormulaRowIndexSource specifies which rows to use for calculations, all
        ' rows or just the visible rows. For example, if you have a summary "sum(
        ' [Column1] )" which sums up the values of Column1, VisibleIndex specifies
        ' that the values from only the visible rows should be used for calculating
        ' the sum.
        e.Layout.Override.FormulaRowIndexSource = FormulaRowIndexSource.ListIndex
    End Sub

C#

using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinGrid;
using System.Diagnostics;


		private void ultraGrid1_InitializeLayout(object sender, Infragistics.Win.UltraWinGrid.InitializeLayoutEventArgs e)
		{
			// A valid UltraCalcManager instance must be assigned to the the CalcManager
			// property of the UltraGrid in order to be able to use formulas. Typically
			// you do this by simply putting an UltraCalcManager component on the form. If
			// you have already put an UltraCalcManager on the form then you don't need to
			// assign the CalcManager proeprty. NOTE: You must add UltraWinCalcManager
			// assembly to the list of assembly references.
			Infragistics.Win.UltraWinCalcManager.UltraCalcManager calcManager;
			calcManager = new Infragistics.Win.UltraWinCalcManager.UltraCalcManager( this.Container );
			e.Layout.Grid.CalcManager = calcManager;

			// You can set formula on a column.
			e.Layout.Bands[0].Columns["Col1"].Formula = "10 * [Col2]";

			// You can create a formula summary. Following summary calculates the sum of
			// Col1 column.
			e.Layout.Bands[0].Summaries.Add( "Summary1", "sum( [Col1] )" );

			// FormulaErrorAppearance specifies the appearance of cells and summaries that
			// contain formula errors.
			e.Layout.Override.FormulaErrorAppearance.BackColor = Color.Red;			

			// FormulaRowIndexSource specifies which rows to use for calculations, all
			// rows or just the visible rows. For example, if you have a summary "sum(
			// [Column1] )" which sums up the values of Column1, VisibleIndex specifies
			// that the values from only the visible rows should be used for calculating
			// the sum.
			e.Layout.Override.FormulaRowIndexSource = FormulaRowIndexSource.ListIndex;
		}

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2