GetState(Int32,Int32) Method

Retrieves the specified Cell's UI state.

Syntax

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

Public Overloads Function GetState( _
   ByVal rowIndex As Integer, _
   ByVal cellIndex As Integer _
) As MultiRowElementStates

Dim instance As GcMultiRow
Dim rowIndex As Integer
Dim cellIndex As Integer
Dim value As MultiRowElementStates
 
value = instance.GetState(rowIndex, cellIndex)

public MultiRowElementStates GetState( 
   int rowIndex,
   int cellIndex
)

Parameters

rowIndex: The row index used to locate a Row.
cellIndex: The cell index used to locate a Cell.

Return Value

One of the MultiRowElementStates values.

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	The rowIndex is less than 0 or greater than RowCount minus 1. -or- The cellIndex is less than 0 or greater than the number of Cells in the Row minus 1.

Exception

Description

System.ArgumentOutOfRangeException

The rowIndex is less than 0 or greater than RowCount minus 1.

-or-

The cellIndex is less than 0 or greater than the number of Cells in the Row minus 1.

Remarks

Initially, all cells and rows do not have instances in the GcMultiRow control. When you get a cell or row's instance, the cell creates an instance. This policy saves memory and improves performance. The cell or row creates an instance if you use the Cell.State or Row.State property. To avoid this state, you can call this method instead of getting the property directly. The method functions in a similar way to the Cell.State or Row.State property.

Example

This example uses the GetState 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();
            text1.Name = "text1";
            text2.Name = "text2";
            text2.Style.Format = "c";
            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;
            gcMultiRow1[1, 1].Value = 5;
        }

        private void button1_Click(object sender, EventArgs e)
        {
            listBox1.Items.Add(gcMultiRow1.GetState(0).ToString());
            listBox1.Items.Add(gcMultiRow1.GetState(0, 1).ToString());
            listBox1.Items.Add(gcMultiRow1.GetState(1, "text2").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()
        text1.Name = "text1"
        text2.Name = "text2"
        text2.Style.Format = "c"
        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
        GcMultiRow1(1, 1).Value = 5
End Sub

Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click
        ListBox1.Items.Add(GcMultiRow1.GetState(0).ToString())
        ListBox1.Items.Add(GcMultiRow1.GetState(0, 1).ToString())
        ListBox1.Items.Add(GcMultiRow1.GetState(1, "text2").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
GetInheritedState(Int32,Int32) Method
GetInheritedState(Int32,String) Method
State Property
InheritedState Property