GetCellCount(Int32,Int32,MultiRowElementStates) Method

Gets the number of cells that meet the provided filter criteria.

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#

<EditorBrowsableAttribute(EditorBrowsableState.Advanced)>
Public Overloads Function GetCellCount( _
   ByVal viewportRowIndex As Integer, _
   ByVal viewportColumnIndex As Integer, _
   ByVal includeFilter As MultiRowElementStates _
) As Integer

Dim instance As GcMultiRow
Dim viewportRowIndex As Integer
Dim viewportColumnIndex As Integer
Dim includeFilter As MultiRowElementStates
Dim value As Integer
 
value = instance.GetCellCount(viewportRowIndex, viewportColumnIndex, includeFilter)

[EditorBrowsable(EditorBrowsableState.Advanced)]
public int GetCellCount( 
   int viewportRowIndex,
   int viewportColumnIndex,
   MultiRowElementStates includeFilter
)

Parameters

viewportRowIndex: The row index of the specified viewport.
viewportColumnIndex: The column index of the specified viewport.
includeFilter: A bitwise combination of the MultiRowElementStates values that specify the cells to count.

Return Value

A System.Int32 value that represents the number of cells that match the includeFilter parameter in a specified viewport.

Exceptions

Exception	Description
System.ComponentModel.InvalidEnumArgumentException	The includeFilter parameter contains an invalid value for the MultiRowElementStates enumeration.
System.ArgumentOutOfRangeException	The viewportRowIndex is less than 0 or greater than the number of viewports in the vertical orientation minus 1. -or- The viewportColumnIndex is less than 0 or greater than the number of viewports in the horizontal orientation minus 1.

Exception

Description

System.ComponentModel.InvalidEnumArgumentException

The includeFilter parameter contains an invalid value for the MultiRowElementStates enumeration.

System.ArgumentOutOfRangeException

The viewportRowIndex is less than 0 or greater than the number of viewports in the vertical orientation minus 1.

-or-

The viewportColumnIndex is less than 0 or greater than the number of viewports in the horizontal orientation minus 1.

Remarks

This method is useful for determining the number of cells in a particular state. To retrieve the number of selected cells, use this method with the MultiRowElementStates.Selected value. This is typically more efficient than using the SelectedCells property when the current cell is in the row area.

Example

This example uses the GetCellCount method.

private void Form1_Load(object sender, EventArgs e)
        {
            GrapeCity.Win.MultiRow.TextBoxCell text1 = new GrapeCity.Win.MultiRow.TextBoxCell();
            GrapeCity.Win.MultiRow.TextBoxCell text2 = new GrapeCity.Win.MultiRow.TextBoxCell();
            GrapeCity.Win.MultiRow.Template template1 = GrapeCity.Win.MultiRow.Template.CreateGridTemplate(new GrapeCity.Win.MultiRow.Cell[] { text1, text2 }, 160, GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.ColumnHeader | GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.RowHeaderAutoNumber);
            template1.ColumnHeaders[0].Cells[0].Value = "Column1";
            template1.ColumnHeaders[0].Cells[1].Value = "Column2";            
            gcMultiRow1.Template = template1;
            gcMultiRow1.RowCount = 3;           
        }

        private void button1_Click(object sender, EventArgs e)
        {
          listBox1.Items.Add(GcMultiRow1.GetCellCount(0, 0, GrapeCity.Win.MultiRow.MultiRowElementStates.Visible).ToString());
        }

VB.NET

Private Sub Form1_Load(sender As Object, e As EventArgs) Handles MyBase.Load        
        Dim text1 As New GrapeCity.Win.MultiRow.TextBoxCell()
        Dim text2 As New GrapeCity.Win.MultiRow.TextBoxCell()
        Dim template1 As GrapeCity.Win.MultiRow.Template = GrapeCity.Win.MultiRow.Template.CreateGridTemplate(New GrapeCity.Win.MultiRow.Cell() {text1, text2}, 160, GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.ColumnHeader Or GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.RowHeaderAutoNumber)
        template1.ColumnHeaders(0).Cells(0).Value = "Column1"
        template1.ColumnHeaders(0).Cells(1).Value = "Column2"
        GcMultiRow1.Template = template1
        GcMultiRow1.RowCount = 3
    End Sub

    Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click
        ListBox1.Items.Add(GcMultiRow1.GetCellCount(0, 0, GrapeCity.Win.MultiRow.MultiRowElementStates.Visible).ToString())
    End Sub

Requirements

Target Platforms: 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

Reference

GcMultiRow Class
GcMultiRow Members
Overload List