Xceed .NET Libraries Documentation
Xceed.FileSystem Assembly / Xceed.FileSystem Namespace / FileSystemItem Class / MoveTo Method / MoveTo(FileSystemEvents,Object,AbstractFolder,Boolean) Method
A FileSystemEvents object that will be used to raise events. Cannot be a null reference (Nothing in Visual Basic).
Opaque data that will be passed back to the event handler when an event is raised.
An AbstractFolder object into which the item will be moved. Cannot be a null reference (Nothing in Visual Basic).
true if existing items in the destination should be replaced; false otherwise.


In This Topic
    MoveTo(FileSystemEvents,Object,AbstractFolder,Boolean) Method
    In This Topic
    Moves the item to another folder, and raises events during the process.
    Syntax
    'Declaration
     
    Public Overloads Function MoveTo( _
       ByVal events As FileSystemEvents, _
       ByVal userData As Object, _
       ByVal destinationFolder As AbstractFolder, _
       ByVal replaceExistingFiles As Boolean _
    ) As FileSystemItem
    'Usage
     
    Dim instance As FileSystemItem
    Dim events As FileSystemEvents
    Dim userData As Object
    Dim destinationFolder As AbstractFolder
    Dim replaceExistingFiles As Boolean
    Dim value As FileSystemItem
     
    value = instance.MoveTo(events, userData, destinationFolder, replaceExistingFiles)

    Parameters

    events
    A FileSystemEvents object that will be used to raise events. Cannot be a null reference (Nothing in Visual Basic).
    userData
    Opaque data that will be passed back to the event handler when an event is raised.
    destinationFolder
    An AbstractFolder object into which the item will be moved. Cannot be a null reference (Nothing in Visual Basic).
    replaceExistingFiles
    true if existing items in the destination should be replaced; false otherwise.

    Return Value

    A FileSystemItem object that represents the newly moved item.
    Remarks

    If the physical folder specified by destinationFolder does not exist, it is created.

    If this FileSystemItem object represents a file, the physical file is immediately moved to the destination folder.

    If it represents a folder, the folder and all it's content (files and subfolders) is immediately moved to the destination.

    When replaceExistingFiles is true, any item in the destination that has the same name as an item being moved is automatically replaced.

    When replaceExistingFiles is false, an exception is thrown whenever the destination contains an item with the same name as an item being moved.

    ApplyPropertiesTo(FileSystemItem) is called on the destination item; therefore, the attributes and dates of the original item are applied to the destination item.

    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