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


array
The one-dimensional System.Array that is the destination of the elements copied from ICollection. The System.Array must have zero-based indexing.
arrayIndex
The zero-based index in array at which copying begins.

Glossary Item Box

Copies the elements of the ICollection to a System.Array, starting at a particular System.Array index.

Syntax

Visual Basic (Declaration) 
Public Sub CopyTo( _
   ByVal array() As ISparkline, _
   ByVal arrayIndex As Integer _
)
Visual Basic (Usage)Copy Code
Dim instance As ExcelSparklineGroup
Dim array() As ISparkline
Dim arrayIndex As Integer
 
instance.CopyTo(array, arrayIndex)
C# 
public void CopyTo( 
   ISparkline[] array,
   int arrayIndex
)

Parameters

array
The one-dimensional System.Array that is the destination of the elements copied from ICollection. The System.Array must have zero-based indexing.
arrayIndex
The zero-based index in array at which copying begins.

Exceptions

ExceptionDescription
System.ArgumentNullExceptionarray is null.
System.ArgumentOutOfRangeExceptionarrayIndex is less than 0.
System.ArgumentExceptionarray is multidimensional or arrayIndex is equal to or greater than the length of array or the number of elements in the source ICollection is greater than the available space from arrayIndex to the end of the destination array or the type ISparkline cannot be cast automatically to the type of the destination array.

Example

This example creates and copies sparklines.
C#Copy Code
fpSpread1.Sheets[0].SetClip(0, 0, 1, 5, "1\t2\t3\t4\t5");
fpSpread1.Sheets[0].SetClip(1, 0, 1, 5, "5\t4\t3\t2\t1");
fpSpread1.Sheets[0].SetClip(2, 0, 1, 5, "1\t2\t3\t2\t1");

FarPoint.Win.Spread.ExcelSparkline es = new FarPoint.Win.Spread.ExcelSparkline(0, 6, fpSpread1.Sheets[0], new FarPoint.Win.Spread.Model.CellRange(0, 0, 1, 5));
FarPoint.Win.Spread.ExcelSparkline es1 = new FarPoint.Win.Spread.ExcelSparkline(1, 6, fpSpread1.Sheets[0], new FarPoint.Win.Spread.Model.CellRange(1, 0, 1, 5));
FarPoint.Win.Spread.ExcelSparkline es2 = new FarPoint.Win.Spread.ExcelSparkline(2, 6, fpSpread1.Sheets[0], new FarPoint.Win.Spread.Model.CellRange(2, 0, 1, 5));

FarPoint.Win.Spread.ExcelSparklineGroup esg = new FarPoint.Win.Spread.ExcelSparklineGroup(new FarPoint.Win.Spread.ExcelSparklineSetting(), FarPoint.Win.Spread.SparklineType.Column);

esg.Add(es);
esg.Add(es1);
esg.Add(es2);
esg.Clear();
fpSpread1.Sheets[0].SparklineContainer.Add(esg);

FarPoint.Win.Spread.ISparkline[] dest = new FarPoint.Win.Spread.ISparkline[3];
int startIndex = 0;
esg.CopyTo(dest, startIndex);

FarPoint.Win.Spread.ExcelSparkline esl;
FarPoint.Win.Spread.ExcelSparkline esl1;
for (int i = 0; i < 3; i++)
{
    esl = (FarPoint.Win.Spread.ExcelSparkline)esg[i];
    esl1 = (FarPoint.Win.Spread.ExcelSparkline)dest[i];
    listBox1.Items.Add(esl.Row.ToString());
    listBox1.Items.Add(esl1.Row.ToString());
    listBox1.Items.Add(esl.Column.ToString());
    listBox1.Items.Add(esl1.Column.ToString());
    listBox1.Items.Add(esl.Formula.ToString());
    listBox1.Items.Add(esl1.Formula.ToString());
}
Visual BasicCopy Code
FpSpread1.Sheets(0).SetClip(0, 0, 1, 5, "1" + Chr(9) + "2" + Chr(9) + "3" + Chr(9) + "4" + Chr(9) + "5")
FpSpread1.Sheets(0).SetClip(1, 0, 1, 5, "5" + Chr(9) + "4" + Chr(9) + "3" + Chr(9) + "2" + Chr(9) + "1")
FpSpread1.Sheets(0).SetClip(2, 0, 1, 5, "1" + Chr(9) + "2" + Chr(9) + "3" + Chr(9) + "2" + Chr(9) + "1")

Dim es As New FarPoint.Win.Spread.ExcelSparkline(0, 6, FpSpread1.Sheets(0), New FarPoint.Win.Spread.Model.CellRange(0, 0, 1, 5))
Dim es1 As New FarPoint.Win.Spread.ExcelSparkline(1, 6, FpSpread1.Sheets(0), New FarPoint.Win.Spread.Model.CellRange(1, 0, 1, 5))
Dim es2 As New FarPoint.Win.Spread.ExcelSparkline(2, 6, FpSpread1.Sheets(0), New FarPoint.Win.Spread.Model.CellRange(2, 0, 1, 5))

Dim esg As New FarPoint.Win.Spread.ExcelSparklineGroup(New FarPoint.Win.Spread.ExcelSparklineSetting(), FarPoint.Win.Spread.SparklineType.Column)

esg.Add(es)
esg.Add(es1)
esg.Add(es2)
esg.Clear()
FpSpread1.Sheets(0).SparklineContainer.Add(esg)

Dim dest As FarPoint.Win.Spread.ISparkline() = New FarPoint.Win.Spread.ISparkline(2) {}
Dim startIndex As Integer = 0
esg.CopyTo(dest, startIndex)

Dim esl As FarPoint.Win.Spread.ExcelSparkline
Dim esl1 As FarPoint.Win.Spread.ExcelSparkline
For i As Integer = 0 To 2
    esl = DirectCast(esg(i), FarPoint.Win.Spread.ExcelSparkline)
    esl1 = DirectCast(dest(i), FarPoint.Win.Spread.ExcelSparkline)
    listBox1.Items.Add(esl.Row.ToString())
    listBox1.Items.Add(esl1.Row.ToString())
    listBox1.Items.Add(esl.Column.ToString())
    listBox1.Items.Add(esl1.Column.ToString())
    listBox1.Items.Add(esl.Formula.ToString())
    listBox1.Items.Add(esl1.Formula.ToString())
Next

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.