Add Method (DefaultSheetSpanModel)

Adds a cell span to the collection.

Syntax

Visual Basic
C#

'Declaration
 
Public Overrides Function Add( _
   ByVal row As Integer, _
   ByVal column As Integer, _
   ByVal rowCount As Integer, _
   ByVal columnCount As Integer _
) As Boolean

'Usage
 
Dim instance As DefaultSheetSpanModel
Dim row As Integer
Dim column As Integer
Dim rowCount As Integer
Dim columnCount As Integer
Dim value As Boolean
 
value = instance.Add(row, column, rowCount, columnCount)

public override bool Add( 
   int row,
   int column,
   int rowCount,
   int columnCount
)

Parameters

row: Row index of cell at which to start span
column: Column index of cell at which to start span
rowCount: Number of rows in span
columnCount: Number of columns in span

Return Value

true if the cell span added successfully; false otherwise

Example

This example adds a span to the ColumnHeaderSpanModel of the active sheet. In the click event of a button, the span is removed.

private void Page_Load(object sender,System.EventArgs e)
{
if(this.IsPostBack)return;

bool b1;
FarPoint.Web.Spread.Model.CellRange range;
FpSpread1.ActiveSheetView.ColumnCount=10;
FpSpread1.ActiveSheetView.RowCount=10;
FpSpread1.ActiveSheetView.ColumnHeader.RowCount=3;
FarPoint.Web.Spread.Model.ISheetSpanModel model=FpSpread1.ActiveSheetView.ColumnHeaderSpanModel;
model.Add(0,0,3,3);
range=model.Find(2,2);
b1=model.IsEmpty();
ListBox1.Items.Add(range.ToString());
ListBox1.Items.Add(Convert.ToString(model.GetEnumerator(0,0,3,3)));
ListBox1.Items.Add(Convert.ToString(b1));
}

private void Button1_Click(object sender,System.EventArgs e)
{
FarPoint.Web.Spread.Model.ISheetSpanModel model=FpSpread1.ActiveSheetView.ColumnHeaderSpanModel;
model.Remove(0,0);
}

Visual Basic

Private Sub Page_Load(ByVal sender As System.Object,ByVal e As System.EventArgs)Handles MyBase.Load

If(IsPostBack)Then Return

Dim range As FarPoint.Web.Spread.Model.CellRange
Dim b1 As Boolean
FpSpread1.ActiveSheetView.ColumnCount=10
FpSpread1.ActiveSheetView.RowCount=10
FpSpread1.ActiveSheetView.ColumnHeader.RowCount=3
Dim model As FarPoint.Web.Spread.Model.ISheetSpanModel=FpSpread1.ActiveSheetView.ColumnHeaderSpanModel
model.Add(0,0,3,3)
range=model.Find(2,2)
b1=model.IsEmpty()
ListBox1.Items.Add(range.ToString)
ListBox1.Items.Add(Convert.ToString(model.GetEnumerator(0,0,3,3)))
ListBox1.Items.Add(b1)
End Sub

Private Sub Button1_Click(ByVal sender As System.Object,ByVal e As System.EventArgs)Handles Button1.Click
Dim model As FarPoint.Web.Spread.Model.ISheetSpanModel=FpSpread1.ActiveSheetView.ColumnHeaderSpanModel
model.Remove(0,0)
End Sub

Requirements

Target Platforms: Windows 7, Windows 8, Windows Vista, Windows Server 2000, Windows 2000 Professional, Windows XP Professional, Windows NT 4.0 Workstation, SP6, Windows NT 4.0 Server, SP6

Reference

DefaultSheetSpanModel Class
DefaultSheetSpanModel Members
Remove Method