ToString(Column,ReferenceStyle) Method

Gets a string that contains a relative reference to this column in the specified reference style.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function ToString( _
   ByVal relativeTo As Column, _
   ByVal referenceStyle As ReferenceStyle _
) As String

'Usage
 
Dim instance As Column
Dim relativeTo As Column
Dim referenceStyle As ReferenceStyle
Dim value As String
 
value = instance.ToString(relativeTo, referenceStyle)

public string ToString( 
   Column relativeTo,
   ReferenceStyle referenceStyle
)

Parameters

relativeTo: Column to use for computing the relative reference
referenceStyle: Reference style

Return Value

String containing a relative reference to this column in the specified reference style

Exceptions

Exception	Description
System.ArgumentNullException	Column is not specified or is not valid; must provide a valid Column object

Remarks

Header columns always return String.Empty because they cannot be referenced.

Example

This example uses the Formula property to sum two values and places the result in the appropriate cell.

FarPoint.Win.Spread.Column col, col1, col2;
col = fpSpread1.ActiveSheet.Columns[0];
col.CellType = new FarPoint.Win.Spread.CellType.NumberCellType();
col1 = fpSpread1.ActiveSheet.Columns[2];
col2 = fpSpread1.ActiveSheet.Columns[3];
fpSpread1.ActiveSheet.Cells[2, 3].Value = 10;
fpSpread1.ActiveSheet.Cells[2, 2].Value = 10;
col.Formula = "SUM(" + col1.ToString(col2, FarPoint.Win.Spread.Model.ReferenceStyle.A1) + "," + col2.ToString(col1, FarPoint.Win.Spread.Model.ReferenceStyle.A1)
+ ")";

Visual Basic

Dim col, col1, col2 As FarPoint.Win.Spread.Column
col = FpSpread1.ActiveSheet.Columns(0)
col.CellType = New FarPoint.Win.Spread.CellType.NumberCellType()
col1 = FpSpread1.ActiveSheet.Columns(2)
col2 = FpSpread1.ActiveSheet.Columns(3)
FpSpread1.ActiveSheet.Cells(2, 3).Value = 10
FpSpread1.ActiveSheet.Cells(2, 2).Value = 10
col.Formula = "SUM(" + col1.ToString(col2, FarPoint.Win.Spread.Model.ReferenceStyle.A1) + "," + col2.ToString(col1, FarPoint.Win.Spread.Model.ReferenceStyle.A1)
+ ")"

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

Column Class
Column Members
Overload List