Spread Windows Forms 6.0 Product Documentation
GetDataColumnName Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread.Model Namespace > DefaultSheetDataModel Class : GetDataColumnName Method


column
Column index for which name is requested

Glossary Item Box

Gets the column name at the specified position.

Syntax

Visual Basic (Declaration) 
Public Function GetDataColumnName( _
   ByVal column As Integer _
) As String
Visual Basic (Usage)Copy Code
Dim instance As DefaultSheetDataModel
Dim column As Integer
Dim value As String
 
value = instance.GetDataColumnName(column)
C# 
public string GetDataColumnName( 
   int column
)

Parameters

column
Column index for which name is requested

Return Value

String containing the name of the column of the bound data source

Exceptions

ExceptionDescription
System.IndexOutOfRangeException Specified index is out of range; must be between 0 and the total number of columns

Example

This example illustrates the use of this member by returning the data column name for the specified index
C#Copy Code
string s;
DataTable dt = new DataTable("Testing");
dt.Columns.Add("Number");
dt.Columns.Add("Letter");
dt.Rows.Add(new Object[]{"1", "One"});
dt.Rows.Add(new Object[] {"2", "Two"});
FarPoint.Win.Spread.Model.DefaultSheetDataModel dataModel = new FarPoint.Win.Spread.Model.DefaultSheetDataModel(dt);
fpSpread1.ActiveSheet.Models.Data = dataModel;
s = dataModel.GetDataColumnName(1);
listBox1.Items.Add(s);
Visual BasicCopy Code
Dim dt As New DataTable("Testing")
Dim s As String
dt.Columns.Add("Number")
dt.Columns.Add("Letter")
dt.Rows.Add(New Object() {"1", "One"})
dt.Rows.Add(New Object() {"2", "Two"})
Dim dataModel As New FarPoint.Win.Spread.Model.DefaultSheetDataModel(dt)
FpSpread1.ActiveSheet.Models.Data = dataModel
s = dataModel.GetDataColumnName(1)
ListBox1.Items.Add(s)

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

See Also

© 2002-2012 ComponentOne, a division of GrapeCity. All Rights Reserved.