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 HierarchyNamespace: callback.ShellBoost.Core.Utilities
Assembly: callback.CBFSShell (in callback.CBFSShell.dll) Version: 22.0.0.0
SyntaxC#
public sealed class FileOperation : IDisposable
The FileOperation type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FileOperation |
Initializes a new instance of the FileOperation class.
|
Properties| Name | Description | |
|---|---|---|
 | EventsEnabled |
Gets a value indicating whether events are enabled.
|
| HasAnyOperationsAborted |
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.
|
| NativeObject |
Gets the underlying Shell native object.
|
| PerformOperationsOnDispose |
Gets a value indicating whether events are enabled.
|
Methods| Name | Description | |
|---|---|---|
| ApplyPropertiesToItem(ShellItemIdList, Boolean) |
Declares a single item whose property values are to be set.
|
| ApplyPropertiesToItem(String, Boolean) |
Declares a single item whose property values are to be set.
|
| ApplyPropertiesToItems(IEnumerableShellItemIdList, Boolean) |
Declares a set of items for which to apply a common set of property values.
|
| ApplyPropertiesToItems(IEnumerableString, Boolean) |
Declares a set of items for which to apply a common set of property values.
|
| CopyItem(ShellItemIdList, ShellItemIdList, String, Boolean) |
Declares a single item that is to be copied to a specified destination.
|
| CopyItem(String, String, String, Boolean) |
Declares a single item that is to be copied to a specified destination.
|
| CopyItems(IEnumerableShellItemIdList, ShellItemIdList, Boolean) |
Declares a set of items that are to be copied to a specified destination.
|
| CopyItems(IEnumerableString, String, Boolean) |
Declares a set of items that are to be copied to a specified destination.
|
| DeleteItem(ShellItemIdList, Boolean) |
Declares a single item that is to be deleted.
|
| DeleteItem(String, Boolean) |
Declares a single item that is to be deleted.
|
| DeleteItems(IEnumerableShellItemIdList, Boolean) |
Declares a set of items that are to be deleted.
|
| DeleteItems(IEnumerableString, Boolean) |
Declares a set of items that are to be deleted.
|
| Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MoveItem(String, String, Boolean) |
Declares a single item that is to be moved to a specified destination.
|
| MoveItem(ShellItemIdList, ShellItemIdList, String, Boolean) |
Declares a single item that is to be moved to a specified destination.
|
| MoveItem(String, String, String, Boolean) |
Declares a single item that is to be moved to a specified destination.
|
| MoveItems(IEnumerableShellItemIdList, ShellItemIdList, Boolean) |
Declares a set of items that are to be moved to a specified destination.
|
| MoveItems(IEnumerableString, String, Boolean) |
Declares a set of items that are to be moved to a specified destination.
|
| NewItem(ShellItemIdList, FileAttributes, String, String, Boolean) |
Declares a new item that is to be created in a specified location.
|
| NewItem(String, FileAttributes, String, String, Boolean) |
Declares a new item that is to be created in a specified location.
|
| PerformOperations |
Executes all selected operations.
|
| RenameItem(ShellItemIdList, String, Boolean) |
Declares a single item that is to be given a new display name.
|
| RenameItem(String, String, Boolean) |
Declares a single item that is to be given a new display name.
|
| RenameItems(IEnumerableShellItemIdList, String, Boolean) |
Declares a set of items that are to be given a new display name. All items are given the same name.
|
| RenameItems(IEnumerableString, String, Boolean) |
Declares a set of items that are to be given a new display name. All items are given the same name.
|
| SetOperationFlags |
Sets the operation flags.
|
| SetOwnerWindow |
Sets the owner window.
|
| SetProperties |
Declares a set of properties and values to be set on an item or items.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | FinishOperations |
Occurs when performing caller-implemented actions after the last operation performed by the call to File Operation is complete.
|
| PauseTimer |
Not currently supported.
|
| PostCopyItem |
Occurs when performing caller-implemented actions after the copy process for each item is complete.
|
| PostDeleteItem |
Occurs when performing caller-implemented actions after the delete process for each item is complete.
|
| PostMoveItem |
Occurs when performing caller-implemented actions after the move process for each item is complete.
|
| PostNewItem |
Occurs when performing caller-implemented actions after the new item is created.
|
| PostRenameItem |
Occurs when performing caller-implemented actions after the rename process for each item is complete.
|
| PreCopyItem |
Occurs when performing caller-implemented actions before the copy process for each item begins.
|
| PreDeleteItem |
Occurs when performing caller-implemented actions before the delete process for each item begins.
|
| PreMoveItem |
Occurs when performing caller-implemented actions before the move process for each item begins.
|
| PreNewItem |
Occurs when performing caller-implemented actions before the process to create a new item begins.
|
| PreRenameItem |
Occurs when performing caller-implemented actions before the rename process for each item begins.
|
| ResetTimer |
Not currently supported.
|
| ResumeTimer |
Not currently supported.
|
| StartOperations |
Occurs when performing caller-implemented actions before any specific file operations are performed.
|
| UpdateProgress |
Occurs when an estimate of the total amount of work currently done in relation to the total amount of work is provided.
|
See Also