Vanara/Windows.Shell/AssemblyReport.md

74 lines
16 KiB
Markdown
Raw Normal View History

## Assembly report for Vanara.Windows.Shell.dll
### Enumerations
2019-09-05 23:03:18 -04:00
Enum | Description | Values
---- | ---- | ----
2019-09-05 23:03:18 -04:00
[Vanara.Windows.Shell.ChangeFilters](https://github.com/dahall/Vanara/search?l=C%23&q=ChangeFilters) | Changes that might occur to a shell item or folder. | ItemRenamed, ItemCreated, ItemDeleted, FolderCreated, FolderDeleted, MediaInserted, MediaRemoved, DriveRemoved, DriveAdded, FolderShared, FolderUnshared, Attributes, FolderUpdated, ItemUpdated, ServerDisconnected, SystemImageUpdated, DriveAddedInteractive, FolderRenamed, AllDiskEvents, DriveFreeSpaceChanged, FileAssociationChanged, AllGlobalEvents, AllEvents
[Vanara.Windows.Shell.ExecutableType](https://github.com/dahall/Vanara/search?l=C%23&q=ExecutableType) | Specifies the executable file type. | Nonexecutable, DOS, Win32Console, Windows
[Vanara.Windows.Shell.FolderItemFilter](https://github.com/dahall/Vanara/search?l=C%23&q=FolderItemFilter) | A filter for the types of children to enumerate. | Folders, NonFolders, IncludeHidden, Printers, Shareable, Storage, FastItems, FlatList, IncludeSuperHidden
[Vanara.Windows.Shell.LibraryFolderFilter](https://github.com/dahall/Vanara/search?l=C%23&q=LibraryFolderFilter) | Defines options for filtering folder items. | FileSystemOnly, StorageObjects, AllItems
[Vanara.Windows.Shell.LibraryViewTemplate](https://github.com/dahall/Vanara/search?l=C%23&q=LibraryViewTemplate) | Defines the type of view assigned to a library folder. | Documents, General, Music, Pictures, Videos, Custom
[Vanara.Windows.Shell.LinkResolution](https://github.com/dahall/Vanara/search?l=C%23&q=LinkResolution) | Flags determining how the links with missing targets are resolved. | None, NoUI, AnyMatch, Update, NoUpdate, NoSearch, NoTrack, NoLinkInfo, InvokeMSI, NoUIWithMsgPump, OfferDeleteWithoutFile, KnownFolder, MachineInLocalTarget, UpdateMachineAndSid, NoObjectID
[Vanara.Windows.Shell.ShellFileOperations.OperationFlags](https://github.com/dahall/Vanara/search?l=C%23&q=OperationFlags) | Flags that control the file operation. | MultiDestFiles, Silent, RenameOnCollision, NoConfirmation, WantMappingHandle, AllowUndo, FilesOnly, SimpleProgress, NoConfirmMkDir, NoErrorUI, NoCopySecurityAttribs, NoRecursion, NoConnectedElements, WantNukeWarning, NoSkipJunctions, PreferHardLink, ShowElevationPrompt, EarlyFailure, PreserveFileExtensions, KeepNewerFile, NoCopyHooks, NoMinimizeBox, MoveACLsAcrossVolumes, DontDisplaySourcePath, DontDisplayDestPath, RequireElevation, AddUndoRecord, CopyAsDownload, DontDisplayLocations
[Vanara.Windows.Shell.ShellIconType](https://github.com/dahall/Vanara/search?l=C%23&q=ShellIconType) | The type of icon to be returned from `Vanara.Windows.Shell.ShellFileInfo.GetIcon(Vanara.Windows.Shell.ShellIconType)`. | Large, Small, Open, ShellDefinedSize, LinkOverlay, Selected
[Vanara.Windows.Shell.ShellImageSize](https://github.com/dahall/Vanara/search?l=C%23&q=ShellImageSize) | Used to determine the size of the icon returned by `Vanara.Windows.Shell.ShellImageList.GetSystemIcon(System.String,Vanara.Windows.Shell.ShellImageSize)`. | Large, Small, ExtraLarge, Jumbo
[Vanara.Windows.Shell.ShellItemAttribute](https://github.com/dahall/Vanara/search?l=C%23&q=ShellItemAttribute) | Attributes that can be retrieved on an item (file or folder) or set of items using `Vanara.Windows.Shell.ShellItem.Attributes`. | CanCopy, CanMove, CanLink, Storage, CanRename, CanDelete, HasPropSheet, DropTarget, CapabilityMask, System, Encrypted, IsSlow, Ghosted, Link, Share, ReadOnly, Hidden, DisplayAttrMask, NonEnumerated, NewContent, CanMoniker, HasStorage, Stream, StorageAncestor, Validate, Removable, Compressed, Browsable, FileSysAncestor, Folder, FileSystem, StorageCapMask, HasSubfolder, ContentsMask, PKEYMask
[Vanara.Windows.Shell.ShellItemComparison](https://github.com/dahall/Vanara/search?l=C%23&q=ShellItemComparison) | Used to determine how to compare two Shell items. ShellItem.Compare uses this enumerated type. | Display, Canonical, SecondaryFileSystemPath, AllFields
[Vanara.Windows.Shell.ShellItemDisplayString](https://github.com/dahall/Vanara/search?l=C%23&q=ShellItemDisplayString) | Requests the form of an item's display name to retrieve through `Vanara.Windows.Shell.ShellItem.GetDisplayName(Vanara.Windows.Shell.ShellItemDisplayString)`. | NormalDisplay, ParentRelativeParsing, DesktopAbsoluteParsing, ParentRelativeEditing, DesktopAbsoluteEditing, FileSysPath, Url, ParentRelativeForAddressBar, ParentRelative, ParentRelativeForUI
[Vanara.Windows.Shell.ShellItemGetImageOptions](https://github.com/dahall/Vanara/search?l=C%23&q=ShellItemGetImageOptions) | Options for retrieving images from a `Vanara.Windows.Shell.ShellItem`. | ResizeToFit, BiggerSizeOk, MemoryOnly, IconOnly, ThumbnailOnly, InCacheOnly, CropToSquare, WideThumbnails, IconBackground, ScaleUp
[Vanara.Windows.Shell.ShellItemToolTipOptions](https://github.com/dahall/Vanara/search?l=C%23&q=ShellItemToolTipOptions) | Flags that direct the handling of the item from which you're retrieving the info tip text. | Default, Name, LinkNotTarget, LinkTarget, AllowDelay, SingleLine
[Vanara.Windows.Shell.TaskbarButtonProgressState](https://github.com/dahall/Vanara/search?l=C%23&q=TaskbarButtonProgressState) | State of the progress shown on a taskbar button. | None, Indeterminate, Normal, Error, Paused
[Vanara.Windows.Shell.ShellFileOperations.TransferFlags](https://github.com/dahall/Vanara/search?l=C%23&q=TransferFlags) | Used by methods of the ITransferSource and ITransferDestination interfaces to control their file operations. | Normal, FailExist, RenameExist, OverwriteExist, AllowDecryption, NoSecurity, CopyCreationTime, CopyWriteTime, UseFullAccess, DeleteRecycleIfPossible, CopyHardLink, CopyLocalizedName, MoveAsCopyDelete, SuspendShellEvents
[Vanara.Windows.Shell.VerbMultiSelectModel](https://github.com/dahall/Vanara/search?l=C%23&q=VerbMultiSelectModel) | | Unset, Player, Single, Document
[Vanara.Windows.Shell.VerbPosition](https://github.com/dahall/Vanara/search?l=C%23&q=VerbPosition) | | Unset, Top, Bottom
[Vanara.Windows.Shell.VerbSelectionModel](https://github.com/dahall/Vanara/search?l=C%23&q=VerbSelectionModel) | | Item, BackgroundShortcutMenu
### Interfaces
Interface | Description
---- | ----
[Vanara.Windows.Shell.IComObject](https://github.com/dahall/Vanara/search?l=C%23&q=IComObject) | Exposed methods from `Vanara.Windows.Shell.ComObject`.
### Classes
2019-09-05 23:03:18 -04:00
Class | Description
---- | ----
[Vanara.Windows.Shell.ComClassFactory](https://github.com/dahall/Vanara/search?l=C%23&q=ComClassFactory) | An implementation of `Vanara.PInvoke.Ole32.IClassFactory` to be used in conjunction with `Vanara.Windows.Shell.IComObject` derivatives.
[Vanara.Windows.Shell.CommandVerb](https://github.com/dahall/Vanara/search?l=C%23&q=CommandVerb) | Encapsulates a shortcut menu verb in the registry.
[Vanara.Windows.Shell.CommandVerbDictionary](https://github.com/dahall/Vanara/search?l=C%23&q=CommandVerbDictionary) | A dictionary of Command Verbs defined in the Windows Registry.
[Vanara.Windows.Shell.ComObject](https://github.com/dahall/Vanara/search?l=C%23&q=ComObject) | Base class for all COM objects which handles calling AddRef and Release for the assembly, connection to IClassFactory, implements IObjectWithSite, using an internal message loop, and a mechanism to issue a non-blocking call to itself. Once implemented, you only need to implement your own interfaces. The IClassFactory implementation can get any derived interfaces through casting for calls to its QueryInterface method. If you want more control, override the QueryInterface method in this class.
[Vanara.Windows.Shell.ControlPanel](https://github.com/dahall/Vanara/search?l=C%23&q=ControlPanel) | Provides a means to open Control Panel items and get their paths.
[Vanara.Windows.Shell.IconLocation](https://github.com/dahall/Vanara/search?l=C%23&q=IconLocation) | Wraps the icon location string used by some Shell classes.
[Vanara.Windows.Shell.IndirectResource](https://github.com/dahall/Vanara/search?l=C%23&q=IndirectResource) | Wraps a resource reference used by some Shell classes.
[Vanara.Windows.Shell.IndirectString](https://github.com/dahall/Vanara/search?l=C%23&q=IndirectString) | Wraps a string resource reference used by some Shell classes.
[Vanara.PInvoke.MessageLoop.MessageEventArgs](https://github.com/dahall/Vanara/search?l=C%23&q=MessageEventArgs) | Holds a copy of the MSG instance retrieved by GetMessage.
[Vanara.PInvoke.MessageLoop](https://github.com/dahall/Vanara/search?l=C%23&q=MessageLoop) | <para> This class encapsulates the management of a message loop for an application. It supports queuing a callback to the application via the message loop to enable the app to return from a call and continue processing that call later. This behavior is needed when implementing a shell verb as verbs must not block the caller. </para> <note type="note">The ComObject derived class should call QueueNonBlockingCallback in its invoke function, for example IExecuteCommand::Execute() or IDropTarget::Drop() passing a method that will complete the initialization work.</note>
[Vanara.Windows.Shell.ProgId](https://github.com/dahall/Vanara/search?l=C%23&q=ProgId) | Represents a programmatic identifier in the registry for an application.
2019-11-08 10:29:33 -05:00
[Vanara.Windows.Shell.PropertyBag](https://github.com/dahall/Vanara/search?l=C%23&q=PropertyBag) | Encapsulates an `Vanara.PInvoke.OleAut32.IPropertyBag` instance.
2019-09-05 23:03:18 -04:00
[Vanara.Windows.Shell.PropertyDescription](https://github.com/dahall/Vanara/search?l=C%23&q=PropertyDescription) | Enumerate and retrieve individual property description details. Wraps the `Vanara.PInvoke.PropSys.IPropertyDescription` shell interface
[Vanara.Windows.Shell.PropertyDescriptionList](https://github.com/dahall/Vanara/search?l=C%23&q=PropertyDescriptionList) | Exposes methods that extract information from a collection of property descriptions presented as a list.
[Vanara.Windows.Shell.PropertyStore](https://github.com/dahall/Vanara/search?l=C%23&q=PropertyStore) | Encapsulates the IPropertyStore object.
[Vanara.Windows.Shell.PropertyType](https://github.com/dahall/Vanara/search?l=C%23&q=PropertyType) | Exposes methods that extract data from enumeration information.
[Vanara.Windows.Shell.PropertyTypeList](https://github.com/dahall/Vanara/search?l=C%23&q=PropertyTypeList) | Exposes methods that enumerate the possible values for a property.
[Vanara.Windows.Shell.RegBasedSettings](https://github.com/dahall/Vanara/search?l=C%23&q=RegBasedSettings) | Base class for registry based settings.
[Vanara.Windows.Shell.RegistryBasedVirtualDictionary<T>](https://github.com/dahall/Vanara/search?l=C%23&q=RegistryBasedVirtualDictionary<T>) | A virtual dictionary that is based on values in the Windows Registry.
2019-11-04 08:49:29 -05:00
[Vanara.Windows.Shell.SearchCondition](https://github.com/dahall/Vanara/search?l=C%23&q=SearchCondition) | Provides properties and methods for retrieving information about a search condition.
2019-09-05 23:03:18 -04:00
[Vanara.Windows.Shell.ShellAssociation](https://github.com/dahall/Vanara/search?l=C%23&q=ShellAssociation) | Represents a Shell file association defined in the Windows Registry. Wraps `Vanara.PInvoke.ShlwApi.IQueryAssociations`.
2019-11-25 09:02:08 -05:00
[Vanara.Windows.Shell.ShellCommand](https://github.com/dahall/Vanara/search?l=C%23&q=ShellCommand) | Wraps the functionality of IInitializeCommand. When deriving, handling the `Vanara.Windows.Shell.ShellCommand.InitializeCommand` event is optional.
[Vanara.Windows.Shell.ShellDropTarget](https://github.com/dahall/Vanara/search?l=C%23&q=ShellDropTarget) | COM object that implements IDropTarget. Solves race problem on drop and simplifies interface calls. All IDropTarget methods call their equivalent On[MethodName] equivalents. To specialize their handling, simply override the On[MethodName] method or hook an event to the corresponding event.
[Vanara.Windows.Shell.ShellExecuteCommand](https://github.com/dahall/Vanara/search?l=C%23&q=ShellExecuteCommand) | Wraps the functionality of IExecuteCommand. To implement, derive from this class and override the `Vanara.Windows.Shell.ShellExecuteCommand.OnExecute` method. All Shell items passed to the command are available through the `Vanara.Windows.Shell.ShellExecuteCommand.SelectedItems` property.
2019-09-05 23:03:18 -04:00
[Vanara.Windows.Shell.ShellFileInfo](https://github.com/dahall/Vanara/search?l=C%23&q=ShellFileInfo) | Information and icons for any shell file.
[Vanara.Windows.Shell.ShellFileOperations.ShellFileNewOpEventArgs](https://github.com/dahall/Vanara/search?l=C%23&q=ShellFileNewOpEventArgs) | Arguments supplied to the `Vanara.Windows.Shell.ShellFileOperations.PostNewItem` event.
[Vanara.Windows.Shell.ShellFileOperations](https://github.com/dahall/Vanara/search?l=C%23&q=ShellFileOperations) | Queued and static file operations using the Shell.
[Vanara.Windows.Shell.ShellFileOperations.ShellFileOpEventArgs](https://github.com/dahall/Vanara/search?l=C%23&q=ShellFileOpEventArgs) | Arguments supplied to events from `Vanara.Windows.Shell.ShellFileOperations`. Depending on the event, some properties may not be set.
[Vanara.Windows.Shell.ShellFolder](https://github.com/dahall/Vanara/search?l=C%23&q=ShellFolder) | A folder or container of `Vanara.Windows.Shell.ShellItem` instances.
[Vanara.Windows.Shell.ShellImageList](https://github.com/dahall/Vanara/search?l=C%23&q=ShellImageList) | Represents the System Image List holding images for all shell icons.
[Vanara.Windows.Shell.ShellItem](https://github.com/dahall/Vanara/search?l=C%23&q=ShellItem) | Encapsulates an item in the Windows Shell.
[Vanara.Windows.Shell.ShellItemArray](https://github.com/dahall/Vanara/search?l=C%23&q=ShellItemArray) | A folder or container of `Vanara.Windows.Shell.ShellItem` instances.
[Vanara.Windows.Shell.ShellItemChangeWatcher.ShellItemChangeEventArgs](https://github.com/dahall/Vanara/search?l=C%23&q=ShellItemChangeEventArgs) | Provides data for `Vanara.Windows.Shell.ShellItemChangeWatcher` events.
[Vanara.Windows.Shell.ShellItemChangeWatcher](https://github.com/dahall/Vanara/search?l=C%23&q=ShellItemChangeWatcher) | Listens to the shell item change notifications and raises events when a folder, or item in a folder, changes.
[Vanara.Windows.Shell.ShellItemPropertyStore](https://github.com/dahall/Vanara/search?l=C%23&q=ShellItemPropertyStore) | A property store for a `Vanara.Windows.Shell.ShellItem`.
[Vanara.Windows.Shell.ShellItemPropertyUpdates](https://github.com/dahall/Vanara/search?l=C%23&q=ShellItemPropertyUpdates) | A dictionary of properties that can be used to set or update property values on Shell items via the `Vanara.Windows.Shell.ShellFileOperations.QueueApplyPropertiesOperation(Vanara.Windows.Shell.ShellItem,Vanara.Windows.Shell.ShellItemPropertyUpdates)` method. This class wraps the `Vanara.Windows.Shell.ShellItemPropertyUpdates.IPropertyChangeArray` COM interface.
[Vanara.Windows.Shell.ShellLibrary](https://github.com/dahall/Vanara/search?l=C%23&q=ShellLibrary) | Shell library encapsulation.
[Vanara.Windows.Shell.ShellLibrary.ShellLibraryFolders](https://github.com/dahall/Vanara/search?l=C%23&q=ShellLibraryFolders) | Folders of a `Vanara.Windows.Shell.ShellLibrary`.
[Vanara.Windows.Shell.ShellLink](https://github.com/dahall/Vanara/search?l=C%23&q=ShellLink) | Represents a Shell Shortcut (.lnk) file.
[Vanara.Windows.Shell.ShellRegistrar](https://github.com/dahall/Vanara/search?l=C%23&q=ShellRegistrar) | Contains static methods used to register and unregister shell items in the Windows Registry.
2019-11-04 08:49:29 -05:00
[Vanara.Windows.Shell.ShellSearch](https://github.com/dahall/Vanara/search?l=C%23&q=ShellSearch) | Represents functionality of the Windows Search Service.
[Vanara.Windows.Shell.ShellSearchViewSettings](https://github.com/dahall/Vanara/search?l=C%23&q=ShellSearchViewSettings) | Settings that change the folder view of a search.
2019-09-05 23:03:18 -04:00
[Vanara.Windows.Shell.TaskbarList](https://github.com/dahall/Vanara/search?l=C%23&q=TaskbarList) | Methods that control the Windows taskbar. It allows you to dynamically add, remove, and activate items on the taskbar. This wraps all of the ITaskbarListX interfaces.