Index Property (Column)

Gets the index of this column, or the starting index for this range of columns.

Syntax

Visual Basic
C#

'Declaration
 
Public ReadOnly Property Index As Integer

'Usage
 
Dim instance As Column
Dim value As Integer
 
value = instance.Index

public int Index {get;}

Property Value

Integer index (zero-based) of the column at the start of the range

Remarks

If you are specifying a range of columns, use the Index2 property to specify the end index for the range.

Column objects returned by the Columns object's Default property always have an index of -1.

Example

This example creates a Column object and adjusts the alignment of the text in the column. The height of the rows are changed so that the alignment changes can be easily seen. The index of the Column object is returned to a text box.

FpSpread1.ActiveSheetView.ColumnCount=10;
FpSpread1.ActiveSheetView.PageSize=20;
FpSpread1.ActiveSheetView.RowCount=20;
FarPoint.Web.Spread.Column mycol;
mycol=FpSpread1.ActiveSheetView.Columns[1];
mycol.HorizontalAlign=HorizontalAlign.Right;
mycol.VerticalAlign=VerticalAlign.Top;
for(int i=0;i<FpSpread1.ActiveSheetView.RowCount;i++)
{
FpSpread1.ActiveSheetView.SetValue(i,1,"Alignment");
FpSpread1.ActiveSheetView.Rows[i].Height=80;
}

TextBox1.Text=Convert.ToString(mycol.Index);

Visual Basic

FpSpread1.ActiveSheetView.ColumnCount=10
FpSpread1.ActiveSheetView.PageSize=20
FpSpread1.ActiveSheetView.RowCount=20
Dim mycol As FarPoint.Web.Spread.Column
Dim i As Integer
mycol=FpSpread1.ActiveSheetView.Columns(1)
mycol.HorizontalAlign=HorizontalAlign.Right
mycol.VerticalAlign=VerticalAlign.Top
For i=0 To FpSpread1.ActiveSheetView.RowCount-1
FpSpread1.ActiveSheetView.SetValue(i,1,"Alignment")
FpSpread1.ActiveSheetView.Rows(i).Height=80
Next i
TextBox1.Text=Convert.ToString(mycol.Index)

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

Column Class
Column Members
Default Property
Index2 Property