|
1421 | 1421 | <param name="eventHandler">EventHandler<EventArgs> to raise</param> |
1422 | 1422 | <param name="sender">Event sender</param> |
1423 | 1423 | </member> |
1424 | | - <member name="T:Microsoft.WindowsAPICodePack.Shell.FileInfo"> |
1425 | | - <summary> |
1426 | | - Contains information about a file object. |
1427 | | - </summary> |
1428 | | - <remarks>This structure is used with the <see cref="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.GetFileInfo(System.String@,Microsoft.WindowsAPICodePack.Win32Native.Shell.FileAttributes@,Microsoft.WindowsAPICodePack.Win32Native.Shell.GetFileInfoOptions@)"/> function.</remarks> |
1429 | | - </member> |
1430 | | - <member name="P:Microsoft.WindowsAPICodePack.Shell.FileInfo.Icon"> |
1431 | | - <summary> |
1432 | | - Gets or sets the icon that represents the file. When the <see cref="M:Microsoft.WindowsAPICodePack.Shell.FileInfo.Dispose"/> method of this struct is called, that method calls the <see cref="M:Microsoft.WindowsAPICodePack.Shell.FileInfo.Dispose"/> method on the current <see cref="P:Microsoft.WindowsAPICodePack.Shell.FileInfo.Icon"/>. |
1433 | | - </summary> |
1434 | | - </member> |
1435 | | - <member name="P:Microsoft.WindowsAPICodePack.Shell.FileInfo.IconIndex"> |
1436 | | - <summary> |
1437 | | - Gets or sets the index of the icon image within the system image list. |
1438 | | - </summary> |
1439 | | - </member> |
1440 | | - <member name="P:Microsoft.WindowsAPICodePack.Shell.FileInfo.Attributes"> |
1441 | | - <summary> |
1442 | | - Gets or sets an array of values that indicates the attributes of the file object. For information about these values, see the <see cref="M:Microsoft.WindowsAPICodePack.COMNative.Shell.IShellFolder.GetAttributesOf(System.UInt32,System.IntPtr,System.UInt32@)"/> method. |
1443 | | - </summary> |
1444 | | - </member> |
1445 | | - <member name="P:Microsoft.WindowsAPICodePack.Shell.FileInfo.DisplayName"> |
1446 | | - <summary> |
1447 | | - Gets or sets a string that contains the name of the file as it appears in the Windows Shell, or the path and file name of the file that contains the icon representing the file. |
1448 | | - </summary> |
1449 | | - </member> |
1450 | | - <member name="P:Microsoft.WindowsAPICodePack.Shell.FileInfo.TypeName"> |
1451 | | - <summary> |
1452 | | - Gets or sets a string that describes the type of file. |
1453 | | - </summary> |
1454 | | - </member> |
1455 | | - <member name="M:Microsoft.WindowsAPICodePack.Shell.FileInfo.#ctor(System.Drawing.Icon,System.Int32,Microsoft.WindowsAPICodePack.Win32Native.Shell.ShellFileGetAttributesOptions,System.String,System.String)"> |
1456 | | - <summary> |
1457 | | - Initializes a new instance of the <see cref="T:Microsoft.WindowsAPICodePack.Shell.FileInfo"/> structure. |
1458 | | - </summary> |
1459 | | - <param name="icon">The icon of the file represented by this structure.</param> |
1460 | | - <param name="iconIndex">The icon index of the retrieved icon.</param> |
1461 | | - <param name="attributes">The attributes of the file represented by this structure.</param> |
1462 | | - <param name="displayName">The display name of the file represented by this structure.</param> |
1463 | | - <param name="typeName">The type name of the file represented by this structure.</param> |
1464 | | - </member> |
1465 | | - <member name="M:Microsoft.WindowsAPICodePack.Shell.FileInfo.Dispose"> |
1466 | | - <summary> |
1467 | | - Calls the <see cref="M:System.Drawing.Icon.Dispose"/> method from the <see cref="P:Microsoft.WindowsAPICodePack.Shell.FileInfo.Icon"/> property. |
1468 | | - </summary> |
1469 | | - </member> |
1470 | | - <member name="T:Microsoft.WindowsAPICodePack.Shell.FileOperation"> |
1471 | | - <summary> |
1472 | | - Provides methods to perform file system operations. |
1473 | | - </summary> |
1474 | | - </member> |
1475 | | - <member name="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.#ctor"> |
1476 | | - <summary> |
1477 | | - Initializes a new instance of the <see cref="T:Microsoft.WindowsAPICodePack.Shell.FileOperation"/> class. |
1478 | | - </summary> |
1479 | | - </member> |
1480 | | - <member name="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.Advise(Microsoft.WindowsAPICodePack.COMNative.Shell.IFileOperationProgressSink@)"> |
1481 | | - <summary> |
1482 | | - Enables a handler to provide status and error information for all operations. |
1483 | | - </summary> |
1484 | | - <param name="pfops">An <see cref="T:Microsoft.WindowsAPICodePack.COMNative.Shell.IFileOperationProgressSink"/> object to be used for progress status and error notifications.</param> |
1485 | | - <returns>A returned token that uniquely identifies this connection. The calling application uses this token later to delete the connection by passing it to <see cref="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.Unadvise(System.UInt32@)"/>.</returns> |
1486 | | - <remarks>Several individual methods have the ability to declare their own progress sinks, which are redundant to the one set here. They are used when you only want to be given progress and error information for a specific operation.</remarks> |
1487 | | - <exception cref="T:System.ArgumentNullException">Exception thrown when a parameter is null.</exception> |
1488 | | - <exception cref="T:System.ObjectDisposedException">Exception thrown when this object is disposed.</exception> |
1489 | | - <exception cref="T:System.ComponentModel.Win32Exception">Exception thrown when this method fails because of an error in the Win32 COM API implementation.</exception> |
1490 | | - </member> |
1491 | | - <member name="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.Unadvise(System.UInt32@)"> |
1492 | | - <summary> |
1493 | | - Terminates an advisory connection previously established through <see cref="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.Advise(Microsoft.WindowsAPICodePack.Shell.IFileOperationProgressSinkProvider@)"/>. |
1494 | | - </summary> |
1495 | | - <param name="dwCookie">The connection token that identifies the connection to delete. This value was originally retrieved by <see cref="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.Advise(Microsoft.WindowsAPICodePack.Shell.IFileOperationProgressSinkProvider@)"/> when the connection was made.</param> |
1496 | | - <exception cref="T:System.ObjectDisposedException">Exception thrown when this object is disposed.</exception> |
1497 | | - <exception cref="T:System.ComponentModel.Win32Exception">Exception thrown when this method fails because of an error in the Win32 COM API implementation.</exception> |
1498 | | - </member> |
1499 | | - <member name="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.SetOperationFlags(Microsoft.WindowsAPICodePack.COMNative.Shell.ShellOperationFlags@)"> |
1500 | | - <summary> |
1501 | | - Sets parameters for the current operation. |
1502 | | - </summary> |
1503 | | - <param name="flags">Flags that control the file operation. FOF flags are defined in Shellapi.h and FOFX flags are defined in Shobjidl.h. Note : If this method is not called, the default value used by the operation is <see cref="!: ShellOperationFlags.FOF_ALLOWUNDO"/> | <see cref="!:ShellOperationFlags.FOF_NOCONFIRMMKDIR"/>.</param> |
1504 | | - <remarks>Set these flags before you call <see cref="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.PerformOperations"/> to define the parameters for whatever operations are being performed, such as copy, delete, or rename.</remarks> |
1505 | | - <exception cref="T:System.ObjectDisposedException">Exception thrown when this object is disposed.</exception> |
1506 | | - <exception cref="T:System.PlatformNotSupportedException">Exception thrown when a requested flag is not supported by the current platform.</exception> |
1507 | | - <exception cref="T:System.ComponentModel.Win32Exception">Exception thrown when this method fails because of an error in the Win32 COM API implementation.</exception> |
1508 | | - </member> |
1509 | | - <member name="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.SetProgressDialog(Microsoft.WindowsAPICodePack.COMNative.Shell.IOperationsProgressDialog@)"> |
1510 | | - <summary> |
1511 | | - Specifies a dialog box used to display the progress of the operation. |
1512 | | - </summary> |
1513 | | - <param name="popd">An <see cref="T:Microsoft.WindowsAPICodePack.COMNative.Shell.IOperationsProgressDialog"/> object that represents the dialog box.</param> |
1514 | | - <exception cref="T:System.ArgumentNullException">Exception thrown when a parameter is null.</exception> |
1515 | | - <exception cref="T:System.ComponentModel.Win32Exception">Exception thrown when this method fails because of an error in the Win32 COM API implementation.</exception> |
1516 | | - </member> |
1517 | | - <member name="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.SetProperties(Microsoft.WindowsAPICodePack.COMNative.Shell.PropertySystem.IPropertyChangeArray@)"> |
1518 | | - <summary> |
1519 | | - Declares a set of properties and values to be set on an item or items. |
1520 | | - </summary> |
1521 | | - <param name="pproparray">An <see cref="T:Microsoft.WindowsAPICodePack.COMNative.Shell.PropertySystem.IPropertyChangeArray"/>, which accesses a collection of <see cref="T:Microsoft.WindowsAPICodePack.COMNative.Shell.PropertySystem.IPropertyChange"/> objects that specify the properties to be set and their new values.</param> |
1522 | | - <remarks>This method does not set the new property values, it merely declares them. To set property values on an item or a group of items, you must make at least the sequence of calls detailed here: |
1523 | | - <ol><li>Call <see cref="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.SetProperties(Microsoft.WindowsAPICodePack.COMNative.Shell.PropertySystem.IPropertyChangeArray@)"/> to declare the specific properties to be set and their new values.</li> |
1524 | | - <li>Call <see cref="!:ApplyPropertiesToItem(ShellObject)"/> or <see cref="!:ApplyPropertiesToItem(IShellItem)"/> to declare the item or items whose properties are to be set.</li> |
1525 | | - <li>Call <see cref="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.PerformOperations"/> to apply the properties to the item or items.</li></ol></remarks> |
1526 | | - <exception cref="T:System.ArgumentNullException">Exception thrown when a parameter is null.</exception> |
1527 | | - <exception cref="T:System.ObjectDisposedException">Exception thrown when this object is disposed.</exception> |
1528 | | - <exception cref="T:System.ComponentModel.Win32Exception">Exception thrown when this method fails because of an error in the Win32 COM API implementation.</exception> |
1529 | | - </member> |
1530 | | - <member name="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.GetFileInfo(System.String@,Microsoft.WindowsAPICodePack.Win32Native.Shell.FileAttributes@,Microsoft.WindowsAPICodePack.Win32Native.Shell.GetFileInfoOptions@)"> |
1531 | | - <summary> |
1532 | | - Retrieves information about an object in the file system, such as a file, folder, directory, or drive root. |
1533 | | - </summary> |
1534 | | - <param name="path"><para>A string of maximum length <see cref="!:MaxPath"/> that contains the path and file name. Both absolute and relative paths are valid.</para> |
1535 | | - <para>If the <b>uFlags</b> parameter includes the <see cref="F:Microsoft.WindowsAPICodePack.Win32Native.Shell.GetFileInfoOptions.PIDL"/> flag, this parameter must be the address of an ITEMIDLIST(PIDL) structure that contains the list of item identifiers that uniquely identifies the file within the Shell's namespace. The PIDL must be a fully qualified PIDL. Relative PIDLs are not allowed.</para> |
1536 | | - <para>If the <b>uFlags</b> parameter includes the <see cref="F:Microsoft.WindowsAPICodePack.Win32Native.Shell.GetFileInfoOptions.UseFileAttributes"/> flag, this parameter does not have to be a valid file name. The function will proceed as if the file exists with the specified name and with the file attributes passed in the <b>dwFileAttributes</b> parameter. This allows you to obtain information about a file type by passing just the extension for <b>pszPath</b> and passing <see cref="F:Microsoft.WindowsAPICodePack.Win32Native.Shell.FileAttributes.Normal"/> in <b>dwFileAttributes</b>.</para> |
1537 | | - <para>This string can use either short (the 8.3 form) or long file names.</para></param> |
1538 | | - <param name="fileAttributes">A combination of one or more <see cref="T:Microsoft.WindowsAPICodePack.Win32Native.Shell.FileAttributes"/> flags. If <b>uFlags</b> does not include the <see cref="F:Microsoft.WindowsAPICodePack.Win32Native.Shell.GetFileInfoOptions.UseFileAttributes"/> flag, this parameter is ignored.</param> |
1539 | | - <param name="options">The flags that specify the file information to retrieve. This parameter can be a combination of the values of the <see cref="T:Microsoft.WindowsAPICodePack.Win32Native.Shell.GetFileInfoOptions"/> enum.</param> |
1540 | | - <returns>A <see cref="T:Microsoft.WindowsAPICodePack.Shell.FileInfo"/> structure that contains the file information.</returns> |
1541 | | - </member> |
1542 | | - <member name="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.GetFileInfo(System.String@,Microsoft.WindowsAPICodePack.Win32Native.Shell.FileAttributes@,Microsoft.WindowsAPICodePack.Win32Native.Shell.GetFileInfoOptions@,System.Int32@)"> |
1543 | | - <summary> |
1544 | | - Retrieves information about an object in the file system, such as a file, folder, directory, or drive root and a value that indicates the exe type. |
1545 | | - </summary> |
1546 | | - <param name="path"><para>A string of maximum length <see cref="!:MaxPath"/> that contains the path and file name. Both absolute and relative paths are valid.</para> |
1547 | | - <para>If the <b>uFlags</b> parameter includes the <see cref="F:Microsoft.WindowsAPICodePack.Win32Native.Shell.GetFileInfoOptions.PIDL"/> flag, this parameter must be the address of an ITEMIDLIST(PIDL) structure that contains the list of item identifiers that uniquely identifies the file within the Shell's namespace. The PIDL must be a fully qualified PIDL. Relative PIDLs are not allowed.</para> |
1548 | | - <para>If the <b>uFlags</b> parameter includes the <see cref="F:Microsoft.WindowsAPICodePack.Win32Native.Shell.GetFileInfoOptions.UseFileAttributes"/> flag, this parameter does not have to be a valid file name. The function will proceed as if the file exists with the specified name and with the file attributes passed in the <b>dwFileAttributes</b> parameter. This allows you to obtain information about a file type by passing just the extension for <b>pszPath</b> and passing <see cref="F:Microsoft.WindowsAPICodePack.Win32Native.Shell.FileAttributes.Normal"/> in <b>dwFileAttributes</b>.</para> |
1549 | | - <para>This string can use either short (the 8.3 form) or long file names.</para></param> |
1550 | | - <param name="fileAttributes">A combination of one or more <see cref="T:Microsoft.WindowsAPICodePack.Win32Native.Shell.FileAttributes"/> flags. If <b>uFlags</b> does not include the <see cref="F:Microsoft.WindowsAPICodePack.Win32Native.Shell.GetFileInfoOptions.UseFileAttributes"/> flag, this parameter is ignored.</param> |
1551 | | - <param name="options">The flags that specify the file information to retrieve. This parameter can be a combination of the values of the <see cref="T:Microsoft.WindowsAPICodePack.Win32Native.Shell.GetFileInfoOptions"/> enum.</param> |
1552 | | - <param name="exeType">The exe type. In order to this method retrieves the exe type, you need to use the <see cref="F:Microsoft.WindowsAPICodePack.Win32Native.Shell.GetFileInfoOptions.ExeType"/> flag in the <b>options</b> parameter.</param> |
1553 | | - <returns>A <see cref="T:Microsoft.WindowsAPICodePack.Shell.FileInfo"/> structure that contains the file information.</returns> |
1554 | | - </member> |
1555 | | - <member name="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.QueryRecycleBinInfo(System.String@,Microsoft.WindowsAPICodePack.Shell.RecycleBinInfo@)"> |
1556 | | - <summary> |
1557 | | - Queries the size and the number of items in the Recycle Bin. |
1558 | | - </summary> |
1559 | | - <param name="drivePath">The path to the Recycle Bin drive. Leave this parameter null or empty if you want to get the info for the Recycle Bins for all drives.</param> |
1560 | | - <param name="recycleBinInfo">The out Recycle Bin info</param> |
1561 | | - <returns><see langword="true"/> if the drive supports the Recycle Bin, otherwise <see langword="false"/>.</returns> |
1562 | | - <exception cref="T:System.ComponentModel.Win32Exception">Exception thrown if a Win32 exception has occurred during thr process.</exception> |
1563 | | - </member> |
1564 | | - <member name="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.EmptyRecycleBin(System.IntPtr@,System.String@,Microsoft.WindowsAPICodePack.Win32Native.Shell.EmptyRecycleBinFlags@)"> |
1565 | | - <summary> |
1566 | | - Empties the Recycle Bin. |
1567 | | - </summary> |
1568 | | - <param name="windowHandle">A handle to the owner window</param> |
1569 | | - <param name="drivePath">The path to the Recycle Bin drive. Leave this parameter null or empty if you want to get the info for the Recycle Bins for all drives.</param> |
1570 | | - <param name="emptyRecycleBinFlags">Flags to describe the behavior for the process.</param> |
1571 | | - <returns><see langword="true"/> if the drive supports the Recycle Bin, otherwise <see langword="false"/>.</returns> |
1572 | | - <exception cref="T:System.ComponentModel.Win32Exception">Exception thrown if a Win32 exception has occurred during thr process.</exception> |
1573 | | - </member> |
1574 | | - <member name="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.EmptyRecycleBin(System.Windows.Forms.Form@,System.String@,Microsoft.WindowsAPICodePack.Win32Native.Shell.EmptyRecycleBinFlags@)"> |
1575 | | - <summary> |
1576 | | - Empties the Recycle Bin. |
1577 | | - </summary> |
1578 | | - <param name="window">The owner window</param> |
1579 | | - <param name="drivePath">The path to the Recycle Bin drive. Leave this parameter null or empty if you want to get the info for the Recycle Bins for all drives.</param> |
1580 | | - <param name="emptyRecycleBinFlags">Flags to describe the behavior for the process.</param> |
1581 | | - <returns><see langword="true"/> if the drive supports the Recycle Bin, otherwise <see langword="false"/>.</returns> |
1582 | | - <exception cref="T:System.ComponentModel.Win32Exception">Exception thrown if a Win32 exception has occurred during thr process.</exception> |
1583 | | - </member> |
1584 | | - <member name="M:Microsoft.WindowsAPICodePack.Shell.FileOperation.EmptyRecycleBin(System.Windows.Window@,System.String@,Microsoft.WindowsAPICodePack.Win32Native.Shell.EmptyRecycleBinFlags@)"> |
1585 | | - <summary> |
1586 | | - Empties the Recycle Bin. |
1587 | | - </summary> |
1588 | | - <param name="window">The owner window</param> |
1589 | | - <param name="drivePath">The path to the Recycle Bin drive. Leave this parameter null or empty if you want to get the info for the Recycle Bins for all drives.</param> |
1590 | | - <param name="emptyRecycleBinFlags">Flags to describe the behavior for the process.</param> |
1591 | | - <returns><see langword="true"/> if the drive supports the Recycle Bin, otherwise <see langword="false"/>.</returns> |
1592 | | - <exception cref="T:System.ComponentModel.Win32Exception">Exception thrown if a Win32 exception has occurred during thr process.</exception> |
1593 | | - </member> |
1594 | | - <member name="P:Microsoft.WindowsAPICodePack.Shell.FileOperationProgressSink.StartOperations"> |
1595 | | - <summary> |
1596 | | - Gets or sets a delegate to call in the <see cref="T:Microsoft.WindowsAPICodePack.Shell.FileOperation"/> class when file operations are starting. |
1597 | | - </summary> |
1598 | | - </member> |
1599 | 1424 | <member name="T:Microsoft.WindowsAPICodePack.Shell.FileLockFinder"> |
1600 | 1425 | <summary> |
1601 | 1426 | This class contains all the functions to find out which are the processes are locking a file. |
|
0 commit comments