Vanara/Windows.Shell/AssemblyReport.md

19 KiB

Assembly report for Vanara.Windows.Shell.dll

Enumerations

Enum Description Values
Vanara.Windows.Shell.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 Specifies the executable file type. Nonexecutable, DOS, Win32Console, Windows
Vanara.Windows.Shell.FolderItemFilter A filter for the types of children to enumerate. Folders, NonFolders, IncludeHidden, Printers, Shareable, Storage, FastItems, FlatList, IncludeSuperHidden
Vanara.Windows.Shell.LibraryFolderFilter Defines options for filtering folder items. FileSystemOnly, StorageObjects, AllItems
Vanara.Windows.Shell.LibraryViewTemplate Defines the type of view assigned to a library folder. Documents, General, Music, Pictures, Videos, Custom
Vanara.Windows.Shell.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 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 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 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 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 Used to determine how to compare two Shell items. ShellItem.Compare uses this enumerated type. Display, Canonical, SecondaryFileSystemPath, AllFields
Vanara.Windows.Shell.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 Options for retrieving images from a Vanara.Windows.Shell.ShellItem. ResizeToFit, BiggerSizeOk, MemoryOnly, IconOnly, ThumbnailOnly, InCacheOnly, CropToSquare, WideThumbnails, IconBackground, ScaleUp
Vanara.Windows.Shell.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 State of the progress shown on a taskbar button. None, Indeterminate, Normal, Error, Paused
Vanara.Windows.Shell.TaskbarItemTabThumbnailOption Specifies taskbar button thumbnail tab properties. TabWindow, MainWindow, MainWindowWhenActive
Vanara.Windows.Shell.ShellFileOperations.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 A value that determines if a user can select a single item, multiple items, or a selection from an item. Unset, Player, Single, Document
Vanara.Windows.Shell.VerbPosition Determines the placement of a verb in a menu. Undefined, Top, Bottom
Vanara.Windows.Shell.VerbSelectionModel Determines menu location. Item, BackgroundShortcutMenu
Vanara.Windows.Shell.Visibility Visible, Hidden, Collapsed

Interfaces

Interface Description
Vanara.Windows.Shell.IComObject Exposed methods from Vanara.Windows.Shell.ComObject.
Vanara.Windows.Shell.IJumpListItem Represents a Jump List item.

Classes

Class Description
Vanara.Windows.ExtenderProviderBase.AddExtenderEventArgs Arguments for the Vanara.Windows.ExtenderProviderBase1.AddingExtender` event.
Vanara.Windows.Shell.Registration.AppRegistration Represents the registration entries for an application.
Vanara.Windows.Shell.ComClassFactory An implementation of Vanara.PInvoke.Ole32.IClassFactory to be used in conjunction with Vanara.Windows.Shell.IComObject derivatives.
Vanara.Windows.Shell.CommandVerb Encapsulates a shortcut menu verb in the registry.
Vanara.Windows.Shell.CommandVerbDictionary A dictionary of Command Verbs defined in the Windows Registry.
Vanara.Windows.Shell.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 Provides a means to open Control Panel items and get their paths.
Vanara.Windows.ExtenderProviderBase A generic base to implement System.ComponentModel.IExtenderProvider for a single extender type.
Vanara.Windows.Shell.Registration.FileTypeAssociation Manages registry entries related to file types and file associations.
Vanara.Windows.Shell.IconLocation Wraps the icon location string used by some Shell classes.
Vanara.Windows.Shell.IndirectResource Wraps a resource reference used by some Shell classes.
Vanara.Windows.Shell.IndirectString Wraps a string resource reference used by some Shell classes.
Vanara.Windows.Shell.JumpList Provides access to the jump list on the application's task bar icon.
Vanara.Windows.Shell.JumpListDestination A file-based destination for a jumplist with an associated category.
Vanara.Windows.Shell.JumpListItem An item in a Jump List.
Vanara.Windows.Shell.JumpListSeparator A separator which can be inserted into a custom list or task list.
Vanara.Windows.Shell.JumpListTask A task for a jumplist.
Vanara.PInvoke.MessageLoop.MessageEventArgs Holds a copy of the MSG instance retrieved by GetMessage.
Vanara.PInvoke.MessageLoop 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. 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.
Vanara.Windows.Shell.ProgId Represents a programmatic identifier in the registry for an application.
Vanara.Windows.Shell.PropertyBag Encapsulates an Vanara.PInvoke.OleAut32.IPropertyBag instance.
Vanara.Windows.Shell.PropertyDescription Enumerate and retrieve individual property description details. Wraps the Vanara.PInvoke.PropSys.IPropertyDescription shell interface
Vanara.Windows.Shell.PropertyDescriptionList Exposes methods that extract information from a collection of property descriptions presented as a list.
Vanara.Windows.Shell.PropertyStore Encapsulates the IPropertyStore object.
Vanara.Windows.Shell.PropertyType Exposes methods that extract data from enumeration information.
Vanara.Windows.Shell.PropertyTypeList Exposes methods that enumerate the possible values for a property.
Vanara.Windows.Shell.RegBasedDictionary A virtual dictionary that is based on values in the Windows Registry.
Vanara.Windows.Shell.RegBasedSettings Base class for registry based settings.
Vanara.Windows.Shell.SearchCondition Provides properties and methods for retrieving information about a search condition.
Vanara.Windows.Shell.ShellAssociation Represents a Shell file association defined in the Windows Registry. Wraps Vanara.PInvoke.ShlwApi.IQueryAssociations.
Vanara.Windows.Shell.ShellCommand Wraps the functionality of IInitializeCommand. When deriving, handling the Vanara.Windows.Shell.ShellCommand.InitializeCommand event is optional.
Vanara.Windows.Shell.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 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.
Vanara.Windows.Shell.ShellFileInfo Information and icons for any shell file.
Vanara.Windows.Shell.ShellFileOperations.ShellFileNewOpEventArgs Arguments supplied to the Vanara.Windows.Shell.ShellFileOperations.PostNewItem event.
Vanara.Windows.Shell.ShellFileOperations Queued and static file operations using the Shell.
Vanara.Windows.Shell.ShellFileOperations.ShellFileOpEventArgs Arguments supplied to events from Vanara.Windows.Shell.ShellFileOperations. Depending on the event, some properties may not be set.
Vanara.Windows.Shell.ShellFolder A folder or container of Vanara.Windows.Shell.ShellItem instances.
Vanara.Windows.Shell.ShellImageList Represents the System Image List holding images for all shell icons.
Vanara.Windows.Shell.ShellItem Encapsulates an item in the Windows Shell.
Vanara.Windows.Shell.ShellItemArray A folder or container of Vanara.Windows.Shell.ShellItem instances.
Vanara.Windows.Shell.ShellItemChangeWatcher.ShellItemChangeEventArgs Provides data for Vanara.Windows.Shell.ShellItemChangeWatcher events.
Vanara.Windows.Shell.ShellItemChangeWatcher Listens to the shell item change notifications and raises events when a folder, or item in a folder, changes.
Vanara.Windows.Shell.ShellItemPropertyStore A property store for a Vanara.Windows.Shell.ShellItem.
Vanara.Windows.Shell.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 Shell library encapsulation.
Vanara.Windows.Shell.ShellLibrary.ShellLibraryFolders Folders of a Vanara.Windows.Shell.ShellLibrary.
Vanara.Windows.Shell.ShellLink Represents a Shell Shortcut (.lnk) file.
Vanara.Windows.Shell.ShellRegistrar Contains static methods used to register and unregister shell items in the Windows Registry.
Vanara.Windows.Shell.ShellSearch Represents functionality of the Windows Search Service.
Vanara.Windows.Shell.ShellSearchViewSettings Settings that change the folder view of a search.
Vanara.Windows.Shell.TaskbarButton Provides access to the functionality of the taskbar button.
Vanara.Windows.Shell.TaskbarButtonThumbnail
Vanara.Windows.Shell.TaskbarButtonThumbnails The list of thumbnails to be displayed on the taskbar button.
Vanara.Windows.Shell.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.
Vanara.Windows.Shell.ThumbnailToolbar The toolbar associated with thumbnails shown when hovering over an application's taskbar button.
Vanara.Windows.Shell.ThumbnailToolbarButton A button in the toolbar associated with thumbnails displayed on a taskbar button.
Vanara.Windows.Shell.ThumbnailToolbarButtonCollection A collection of thumbnail toolbar buttons.