Spread Windows Forms 10.0 Product Documentation
GetClipValue Method (ColumnFooter)
Example 


Starting column footer row index, or -1 for all column footer rows
Starting column index, or -1 for all columns
Number of column footer rows, or -1 for all column footer rows
Number of columns, or -1 for all columns
Gets a tab-delimited string that contains the unformatted text in a range.
Syntax
'Declaration
 
Public Function GetClipValue( _
   ByVal row As Integer, _
   ByVal column As Integer, _
   ByVal rowCount As Integer, _
   ByVal columnCount As Integer _
) As String
'Usage
 
Dim instance As ColumnFooter
Dim row As Integer
Dim column As Integer
Dim rowCount As Integer
Dim columnCount As Integer
Dim value As String
 
value = instance.GetClipValue(row, column, rowCount, columnCount)
public string GetClipValue( 
   int row,
   int column,
   int rowCount,
   int columnCount
)

Parameters

row
Starting column footer row index, or -1 for all column footer rows
column
Starting column index, or -1 for all columns
rowCount
Number of column footer rows, or -1 for all column footer rows
columnCount
Number of columns, or -1 for all columns
Exceptions
ExceptionDescription
System.ArgumentOutOfRangeException Specified row index is out of range; must be between -1 and the total number of rows
System.ArgumentOutOfRangeException Specified column index is out of range; must be between -1 and the total number of columns
Example
This example uses the GetClipValue method in the column footer.
fpSpread1.Sheets[0].RowCount = 10;
fpSpread1.Sheets[0].ColumnCount = 15;
// Show the column footer.
fpSpread1.Sheets[0].ColumnFooter.Visible = true;
fpSpread1.Sheets[0].ColumnFooter.RowCount = 2;
fpSpread1.Sheets[0].ColumnFooter.AlternatingRows[0].BackColor = Color.PowderBlue;
fpSpread1.Sheets[0].ColumnFooter.DefaultStyle.ForeColor = Color.Purple;
fpSpread1.Sheets[0].ColumnFooter.Columns[12].HorizontalAlignment = FarPoint.Win.Spread.CellHorizontalAlignment.Left;
fpSpread1.Sheets[0].ColumnFooter.Cells[0, 12].RowSpan = 2;
fpSpread1.Sheets[0].ColumnFooter.Cells[0, 0].Value = "test";

fpSpread1.ActiveSheet.ColumnFooter.SetClipValue(0, 0, 2, 4, "one\ttwo\tthree\tfour\r\nfive\tsix\tseven\teight");
string s;
s = fpSpread1.ActiveSheet.ColumnFooter.GetClipValue(0, 0, 2, 4);
listBox1.Items.Add(s);
FpSpread1.Sheets(0).RowCount = 10
FpSpread1.Sheets(0).ColumnCount = 15
' Show the column footer.
FpSpread1.Sheets(0).ColumnFooter.Visible = True
FpSpread1.Sheets(0).ColumnFooter.RowCount = 2
FpSpread1.Sheets(0).ColumnFooter.AlternatingRows(0).BackColor = Color.PowderBlue
FpSpread1.Sheets(0).ColumnFooter.DefaultStyle.ForeColor = Color.Purple
FpSpread1.Sheets(0).ColumnFooter.Columns(12).HorizontalAlignment = FarPoint.Win.Spread.CellHorizontalAlignment.Left
FpSpread1.Sheets(0).ColumnFooter.Cells(0, 12).RowSpan = 2
FpSpread1.Sheets(0).ColumnFooter.Cells(0, 0).Value = "test"

FpSpread1.ActiveSheet.ColumnFooter.SetClipValue(0, 0, 2, 4, "one" + Chr(9) + "two" + Chr(9) + "three" + Chr(9) + "four" + vbCrLf + "five" + Chr(9) + "six" + Chr(9) + "seven" + Chr(9) + "eight")
Dim s As String
s = FpSpread1.ActiveSheet.ColumnFooter.GetClipValue(0, 0, 2, 4)
ListBox1.Items.Add(s)
Requirements

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

See Also

Reference

ColumnFooter Class
ColumnFooter Members

 

 


Copyright © GrapeCity, inc. All rights reserved.