Click or drag to resize

FileOperation Class

Represents a Windows Shell file operation. This class cannot be inherited. This class requires an STA thread to operate properly. Interesting error results are located in Windows SKD's sherrors.h.
Inheritance Hierarchy
SystemObject
  ShellBoost.Core.UtilitiesFileOperation

Namespace:  ShellBoost.Core.Utilities
Assembly:  ShellBoost.Core (in ShellBoost.Core.dll) Version: 1.8.3.0
Syntax
C#
public sealed class FileOperation : IDisposable

The FileOperation type exposes the following members.

Constructors
  NameDescription
Public methodFileOperation
Initializes a new instance of the FileOperation class.
Top
Properties
  NameDescription
Public propertyEventsEnabled
Gets a value indicating whether events are enabled.
Public propertyHasAnyOperationsAborted
Gets a value that states whether any file operations initiated by a call to PerformOperations were stopped before they were complete. The operations could be stopped either by user action or silently by the system.
Public propertyNativeObject
Gets the underlying Shell native object.
Public propertyPerformOperationsOnDispose
Gets a value indicating whether events are enabled.
Top
Methods
  NameDescription
Public methodApplyPropertiesToItem(ShellItemIdList, Boolean)
Declares a single item whose property values are to be set.
Public methodApplyPropertiesToItem(String, Boolean)
Declares a single item whose property values are to be set.
Public methodApplyPropertiesToItems(IEnumerableShellItemIdList, Boolean)
Declares a set of items for which to apply a common set of property values.
Public methodApplyPropertiesToItems(IEnumerableString, Boolean)
Declares a set of items for which to apply a common set of property values.
Public methodCopyItem(ShellItemIdList, ShellItemIdList, String, Boolean)
Declares a single item that is to be copied to a specified destination.
Public methodCopyItem(String, String, String, Boolean)
Declares a single item that is to be copied to a specified destination.
Public methodCopyItems(IEnumerableShellItemIdList, ShellItemIdList, Boolean)
Declares a set of items that are to be copied to a specified destination.
Public methodCopyItems(IEnumerableString, String, Boolean)
Declares a set of items that are to be copied to a specified destination.
Public methodDeleteItem(ShellItemIdList, Boolean)
Declares a single item that is to be deleted.
Public methodDeleteItem(String, Boolean)
Declares a single item that is to be deleted.
Public methodDeleteItems(IEnumerableShellItemIdList, Boolean)
Declares a set of items that are to be deleted.
Public methodDeleteItems(IEnumerableString, Boolean)
Declares a set of items that are to be deleted.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodMoveItem(String, String, Boolean)
Declares a single item that is to be moved to a specified destination.
Public methodMoveItem(ShellItemIdList, ShellItemIdList, String, Boolean)
Declares a single item that is to be moved to a specified destination.
Public methodMoveItem(String, String, String, Boolean)
Declares a single item that is to be moved to a specified destination.
Public methodMoveItems(IEnumerableShellItemIdList, ShellItemIdList, Boolean)
Declares a set of items that are to be moved to a specified destination.
Public methodMoveItems(IEnumerableString, String, Boolean)
Declares a set of items that are to be moved to a specified destination.
Public methodNewItem(ShellItemIdList, FileAttributes, String, String, Boolean)
Declares a new item that is to be created in a specified location.
Public methodNewItem(String, FileAttributes, String, String, Boolean)
Declares a new item that is to be created in a specified location.
Public methodPerformOperations
Executes all selected operations.
Public methodRenameItem(ShellItemIdList, String, Boolean)
Declares a single item that is to be given a new display name.
Public methodRenameItem(String, String, Boolean)
Declares a single item that is to be given a new display name.
Public methodRenameItems(IEnumerableShellItemIdList, String, Boolean)
Declares a set of items that are to be given a new display name. All items are given the same name.
Public methodRenameItems(IEnumerableString, String, Boolean)
Declares a set of items that are to be given a new display name. All items are given the same name.
Public methodSetOperationFlags
Sets the operation flags.
Public methodSetOwnerWindow
Sets the owner window.
Public methodSetProperties
Declares a set of properties and values to be set on an item or items.
Top
Events
  NameDescription
Public eventFinishOperations
Occurs when performing caller-implemented actions after the last operation performed by the call to File Operation is complete.
Public eventPauseTimer
Not currently supported.
Public eventPostCopyItem
Occurs when performing caller-implemented actions after the copy process for each item is complete.
Public eventPostDeleteItem
Occurs when performing caller-implemented actions after the delete process for each item is complete.
Public eventPostMoveItem
Occurs when performing caller-implemented actions after the move process for each item is complete.
Public eventPostNewItem
Occurs when performing caller-implemented actions after the new item is created.
Public eventPostRenameItem
Occurs when performing caller-implemented actions after the rename process for each item is complete.
Public eventPreCopyItem
Occurs when performing caller-implemented actions before the copy process for each item begins.
Public eventPreDeleteItem
Occurs when performing caller-implemented actions before the delete process for each item begins.
Public eventPreMoveItem
Occurs when performing caller-implemented actions before the move process for each item begins.
Public eventPreNewItem
Occurs when performing caller-implemented actions before the process to create a new item begins.
Public eventPreRenameItem
Occurs when performing caller-implemented actions before the rename process for each item begins.
Public eventResetTimer
Not currently supported.
Public eventResumeTimer
Not currently supported.
Public eventStartOperations
Occurs when performing caller-implemented actions before any specific file operations are performed.
Public eventUpdateProgress
Occurs when an estimate of the total amount of work currently done in relation to the total amount of work is provided.
Top
See Also