GetCellNoteDisplayRectangle(Int32,Int32,Int32,Int32) Method

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

Syntax

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

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

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

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

Parameters

viewportRowIndex: The RowIndex of the viewport.
viewportColumnIndex: The ColumnIndex of the viewport.
rowIndex: The row index for the desired cell note.
cellIndex: The cell index for the desired cell note.

Return Value

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

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 Cells 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.
System.InvalidOperationException	The specified Cell's CellNote is null.

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 Cells 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.

System.InvalidOperationException

The specified Cell's CellNote is null.

Example

This example uses the GetCellNoteDisplayRectangle method.

private void Form1_Load(object sender, EventArgs e)
        {
            GrapeCity.Win.MultiRow.CellNote cnote = new GrapeCity.Win.MultiRow.CellNote("Note");
            GrapeCity.Win.MultiRow.CellNoteStyle cstyle = new GrapeCity.Win.MultiRow.CellNoteStyle();
            cstyle.BackColor = Color.Bisque;
            cstyle.ForeColor = Color.Black;
            cstyle.LineStyle = GrapeCity.Win.MultiRow.CellNoteLineStyle.Dashed;
            cstyle.LineColor = Color.Purple;
            cstyle.LineWidth = 2;
            cnote.Style = cstyle;
            cnote.DisplayMode = GrapeCity.Win.MultiRow.CellNoteDisplayMode.AlwaysShown;
            GrapeCity.Win.MultiRow.TextBoxCell text1 = new GrapeCity.Win.MultiRow.TextBoxCell();
            GrapeCity.Win.MultiRow.CheckBoxCell check2 = new GrapeCity.Win.MultiRow.CheckBoxCell();
            GrapeCity.Win.MultiRow.Template template1 = GrapeCity.Win.MultiRow.Template.CreateGridTemplate(new GrapeCity.Win.MultiRow.Cell[] { text1, check2 }, 160, GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.ColumnHeader | GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.RowHeaderAutoNumber);
            template1.ColumnHeaders[0].Cells[0].Value = "Column1";
            gcMultiRow1.Template = template1;
            gcMultiRow1.RowCount = 3;
            gcMultiRow1[1, 0].Value = 5;
            gcMultiRow1[1, 1].Note = cnote;
        }

        private void button1_Click(object sender, EventArgs e)
        {
            listBox1.Items.Add(gcMultiRow1.GetCellNoteDisplayRectangle(1, 1).ToString());
            listBox1.Items.Add(gcMultiRow1.GetCellNoteDisplayRectangle(0, 0, 1, 1).ToString());
            listBox1.Items.Add(gcMultiRow1.GetCellNoteDisplayRectangle(GrapeCity.Win.MultiRow.CellScope.Row, 0, 0, 1, 1).ToString());
        }

VB.NET

Private Sub Form1_Load(sender As Object, e As EventArgs) Handles MyBase.Load
  Dim cnote As New GrapeCity.Win.MultiRow.CellNote("Note")
  Dim cstyle As New GrapeCity.Win.MultiRow.CellNoteStyle()
  cstyle.BackColor = Color.Bisque
  cstyle.ForeColor = Color.Black
  cstyle.LineStyle = GrapeCity.Win.MultiRow.CellNoteLineStyle.Dashed
  cstyle.LineColor = Color.Purple
  cstyle.LineWidth = 2
  cnote.Style = cstyle
  cnote.DisplayMode = GrapeCity.Win.MultiRow.CellNoteDisplayMode.AlwaysShown
  Dim text1 As New GrapeCity.Win.MultiRow.TextBoxCell()
  Dim check2 As New GrapeCity.Win.MultiRow.CheckBoxCell()
  Dim template1 As GrapeCity.Win.MultiRow.Template = GrapeCity.Win.MultiRow.Template.CreateGridTemplate(New GrapeCity.Win.MultiRow.Cell() {text1, check2}, 160, GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.ColumnHeader Or GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.RowHeaderAutoNumber)
  template1.ColumnHeaders(0).Cells(0).Value = "Column1"
  GcMultiRow1.Template = template1
  GcMultiRow1.RowCount = 3
  GcMultiRow1[1, 0].Value = 5
  GcMultiRow1(1, 1).Note = cnote
End Sub

Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click
  ListBox1.Items.Add(gcMultiRow1.GetCellNoteDisplayRectangle(1, 1).ToString())
  ListBox1.Items.Add(gcMultiRow1.GetCellNoteDisplayRectangle(0, 0, 1, 1).ToString())
  ListBox1.Items.Add(gcMultiRow1.GetCellNoteDisplayRectangle(GrapeCity.Win.MultiRow.CellScope.Row, 0, 0, 1, 1).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