GetColumnHeaderSpanCell Method

Gets the range of cells that are spanned at a specified cell on the column header of this sheet.

Syntax

Visual Basic
C#

'Declaration
 
Public Overridable Function GetColumnHeaderSpanCell( _
   ByVal row As Integer, _
   ByVal column As Integer _
) As CellRange

'Usage
 
Dim instance As SheetView
Dim row As Integer
Dim column As Integer
Dim value As CellRange
 
value = instance.GetColumnHeaderSpanCell(row, column)

public virtual CellRange GetColumnHeaderSpanCell( 
   int row,
   int column
)

Parameters

row: Row index of the specified cell
column: Column index of the specified cell

Return Value

CellRange object that contains the span information, or null if no span exists

Example

This example uses the GetColumnHeaderSpanCell method.

private void Form1_Load(object sender, EventArgs e)
        {
            // Set the number of rows in the column header.
            fpSpread1.ActiveSheet.ColumnHeader.RowCount = 3;
            // Set the number of columns in the row header.
            fpSpread1.ActiveSheet.RowHeader.ColumnCount = 2;
            // Define the labels for the spanned column header cells.
            fpSpread1.ActiveSheet.ColumnHeader.Cells[2, 0].Text = "East";
            fpSpread1.ActiveSheet.ColumnHeader.Cells[2, 1].Text = "West";
            fpSpread1.ActiveSheet.ColumnHeader.Cells[2, 2].Text = "East";
            fpSpread1.ActiveSheet.ColumnHeader.Cells[2, 3].Text = "West";
            fpSpread1.ActiveSheet.ColumnHeader.Cells[2, 4].Text = "East";
            fpSpread1.ActiveSheet.ColumnHeader.Cells[2, 5].Text = "West";
            fpSpread1.ActiveSheet.ColumnHeader.Cells[2, 6].Text = "East";
            fpSpread1.ActiveSheet.ColumnHeader.Cells[2, 7].Text = "West";
            fpSpread1.ActiveSheet.ColumnHeader.Cells[1, 0].Text = "1st Quarter";
            fpSpread1.ActiveSheet.ColumnHeader.Cells[1, 2].Text = "2nd Quarter";
            fpSpread1.ActiveSheet.ColumnHeader.Cells[1, 4].Text = "3rd Quarter";
            fpSpread1.ActiveSheet.ColumnHeader.Cells[1, 6].Text = "4th Quarter";
            fpSpread1.ActiveSheet.ColumnHeader.Cells[0, 0].Text = "Fiscal Year 2004";
            // Define the column header cell spans.
            fpSpread1.ActiveSheet.AddColumnHeaderSpanCell(1, 0, 1, 2);
            fpSpread1.ActiveSheet.AddColumnHeaderSpanCell(1, 2, 1, 2);
            fpSpread1.ActiveSheet.AddColumnHeaderSpanCell(1, 4, 1, 2);
            fpSpread1.ActiveSheet.AddColumnHeaderSpanCell(1, 6, 1, 2);
            fpSpread1.ActiveSheet.AddColumnHeaderSpanCell(0, 0, 1, 8);
            // Define the label for the spanned row header cells.
            fpSpread1.ActiveSheet.RowHeader.Cells[0, 0].Text = "Branch #";
            // Define the row header cell span.
            fpSpread1.ActiveSheet.AddRowHeaderSpanCell(0, 0, 12, 1);
        }               

        private void button1_Click(object sender, EventArgs e)
        {
        FarPoint.Win.Spread.Model.CellRange cr;
        cr = fpSpread1.Sheets[0].GetColumnHeaderSpanCell(0, 0);
        listBox1.Items.Add(cr.ColumnCount.ToString());            
        }

VB.NET

Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load       
        ' Set the number of rows in the column header.
        FpSpread1.ActiveSheet.ColumnHeader.RowCount = 3
        ' Set the number of columns in the row header.
        FpSpread1.ActiveSheet.RowHeader.ColumnCount = 2
        ' Define the labels for the spanned column header cells.
        FpSpread1.ActiveSheet.ColumnHeader.Cells(2, 0).Text = "East"
        FpSpread1.ActiveSheet.ColumnHeader.Cells(2, 1).Text = "West"
        FpSpread1.ActiveSheet.ColumnHeader.Cells(2, 2).Text = "East"
        FpSpread1.ActiveSheet.ColumnHeader.Cells(2, 3).Text = "West"
        FpSpread1.ActiveSheet.ColumnHeader.Cells(2, 4).Text = "East"
        FpSpread1.ActiveSheet.ColumnHeader.Cells(2, 5).Text = "West"
        FpSpread1.ActiveSheet.ColumnHeader.Cells(2, 6).Text = "East"
        FpSpread1.ActiveSheet.ColumnHeader.Cells(2, 7).Text = "West"
        FpSpread1.ActiveSheet.ColumnHeader.Cells(1, 0).Text = "1st Quarter"
        FpSpread1.ActiveSheet.ColumnHeader.Cells(1, 2).Text = "2nd Quarter"
        FpSpread1.ActiveSheet.ColumnHeader.Cells(1, 4).Text = "3rd Quarter"
        FpSpread1.ActiveSheet.ColumnHeader.Cells(1, 6).Text = "4th Quarter"
        FpSpread1.ActiveSheet.ColumnHeader.Cells(0, 0).Text = "Fiscal Year 2004"
        ' Define the column header cell spans.
        FpSpread1.ActiveSheet.AddColumnHeaderSpanCell(1, 0, 1, 2)
        FpSpread1.ActiveSheet.AddColumnHeaderSpanCell(1, 2, 1, 2)
        FpSpread1.ActiveSheet.AddColumnHeaderSpanCell(1, 4, 1, 2)
        FpSpread1.ActiveSheet.AddColumnHeaderSpanCell(1, 6, 1, 2)
        FpSpread1.ActiveSheet.AddColumnHeaderSpanCell(0, 0, 1, 8)
        ' Define the label for the spanned row header cells.
        FpSpread1.ActiveSheet.RowHeader.Cells(0, 0).Text = "Branch #"
        ' Define the row header cell span.
        FpSpread1.ActiveSheet.AddRowHeaderSpanCell(0, 0, 12, 1)
    End Sub

    Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
        Dim cr As FarPoint.Win.Spread.Model.CellRange
        cr = FpSpread1.Sheets(0).GetColumnHeaderSpanCell(0, 0)
        ListBox1.Items.Add(cr.ColumnCount.ToString())
    End Sub

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

Reference

SheetView Class
SheetView Members