CursorButtons.CopyTo Method

Article
12/12/2007

Copies all of the elements of the current CursorButtons collection to the specified one-dimensional array, starting at the specified destination array index.

Namespace: Microsoft.Ink
Assembly: Microsoft.Ink (in microsoft.ink.dll)

Syntax

'Declaration
Public Sub CopyTo ( _
    array As Array, _
    index As Integer _
)
'Usage
Dim instance As CursorButtons
Dim array As Array
Dim index As Integer

instance.CopyTo(array, index)

public void CopyTo (
    Array array,
    int index
)

public:
virtual void CopyTo (
    Array^ array, 
    int index
) sealed

public final void CopyTo (
    Array array, 
    int index
)

public final function CopyTo (
    array : Array, 
    index : int
)

Not applicable.

Parameters

array
The one-dimensional array that is the destination of elements copied from the collection. The array must have zero-based indexing.

index
The zero-based index in the array parameter at which copying begins.

Remarks

The elements are copied to the Array object in the same order in which the enumerator iterates through the CursorButtons.

An exception is thrown if:

The array parameter is a a null reference (Nothing in Visual Basic) (Nothing in Microsoft® Visual Basic® .NET) reference.
The index parameter is less than zero.
The array parameter is multidimensional.
The index parameter is equal to or greater than the length of the array parameter.
The number of elements in the collection is higher than the available space from the index parameter to the end of the destination array parameter.

The type of the collection is cast automatically to the type of the destination array parameter. However, this method only copies elements to arrays of the same type as the elements of the collection or arrays of type Object. Attempting to copy to another type of array causes an InvalidCastException exception to be thrown.

This method is synchronized.

Example

This C# example fills part of an array of CursorButton objects with the entire contents of the Cursor.Buttons collection, starting at element 1 (the second element in a zero-based array) of the destination array theCopies and leaving the first element of the destination array (with an index of 0) empty.

CursorButton[] theCopies = new CursorButton[theCursor.Buttons.Count + 1];
theCursor.Buttons.CopyTo(theCopies, 1);

This Visual Basic .NET example fills part of an array of CursorButton objects with the entire contents of the Cursor.Buttons collection, starting at element 1 (the second element in a zero-based array) of the destination array theCopies and leaving the first element of the destination array (with an index of 0) empty.

Dim theCopies(theCursor.Buttons.Count) As CursorButton
theCursor.Buttons.CopyTo(theCopies, 1)

Platforms

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

Version Information

.NET Framework

Supported in: 3.0

Share via