GetCellDisplayRectangle(Int32,Int32,Int32,Int32,Boolean) Method

Retrieves the rectangle that represents the display area for the specified cell.

Syntax

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

<EditorBrowsableAttribute(EditorBrowsableState.Advanced)>
Public Overloads Function GetCellDisplayRectangle( _
   ByVal viewportRowIndex As Integer, _
   ByVal viewportColumnIndex As Integer, _
   ByVal rowIndex As Integer, _
   ByVal cellIndex As Integer, _
   ByVal cutOverflow As Boolean _
) As Rectangle

Dim instance As GcMultiRow
Dim viewportRowIndex As Integer
Dim viewportColumnIndex As Integer
Dim rowIndex As Integer
Dim cellIndex As Integer
Dim cutOverflow As Boolean
Dim value As Rectangle
 
value = instance.GetCellDisplayRectangle(viewportRowIndex, viewportColumnIndex, rowIndex, cellIndex, cutOverflow)

[EditorBrowsable(EditorBrowsableState.Advanced)]
public Rectangle GetCellDisplayRectangle( 
   int viewportRowIndex,
   int viewportColumnIndex,
   int rowIndex,
   int cellIndex,
   bool cutOverflow
)

Parameters

viewportRowIndex: The RowIndex of the viewport.
viewportColumnIndex: The ColumnIndex of the viewport.
rowIndex: The row index for the desired cell.
cellIndex: The cell index for the desired cell.
cutOverflow: true to return the displayed portion of the cell only; false to return the entire cell bounds.

Return Value

A System.Drawing.Rectangle that represents the display rectangle of the cell.

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	The rowIndex is less than 0 or greater than the number of Row minus 1. -or- The cellIndex is less than 0 or greater than the number of Cell in the Row minus 1. -or- 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.ArgumentOutOfRangeException

The rowIndex is less than 0 or greater than the number of Row minus 1.

-or-

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

-or-

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 returns the entire cell bounds or the displayed portion only. To get the bounds of the cell contents only, use the cell ContentBounds property.

Example

This example uses the GetCellDisplayRectangle 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.GetCellDisplayRectangle(0, 0, true).ToString());
         listBox1.Items.Add(gcMultiRow1.GetCellDisplayRectangle(0, 0, 0, 0, true).ToString());
         listBox1.Items.Add(gcMultiRow1.GetCellDisplayRectangle(GrapeCity.Win.MultiRow.CellScope.Row, 0, 0, 0, 0, true).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.GetCellDisplayRectangle(0, 0, True).ToString())
        ListBox1.Items.Add(GcMultiRow1.GetCellDisplayRectangle(0, 0, 0, 0, True).ToString())
        ListBox1.Items.Add(GcMultiRow1.GetCellDisplayRectangle(GrapeCity.Win.MultiRow.CellScope.Row, 0, 0, 0, 0, True).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