ShellFilePreview Class

A control for displaying file previews.

Inheritance Hierarchy

SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.Windows.MediaVisual
        System.WindowsUIElement
          System.WindowsFrameworkElement
            System.Windows.ControlsControl
              Jam.Shell.WPF.ControlsShellFilePreview

Namespace: Jam.Shell.WPF.Controls
Assembly: ShellBrowserWPF (in ShellBrowserWPF.dll) Version: 1.3.1

Syntax

C++

Copy

public class ShellFilePreview : Control, 
	ICommonPreviewHandlerHost, IDisposable, IShellControlConnectorTarget

Public Class ShellFilePreview
	Inherits Control
	Implements ICommonPreviewHandlerHost, IDisposable, IShellControlConnectorTarget

public ref class ShellFilePreview : public Control, 
	ICommonPreviewHandlerHost, IDisposable, IShellControlConnectorTarget

type ShellFilePreview =  
    class
        inherit Control
        interface ICommonPreviewHandlerHost
        interface IDisposable
        interface IShellControlConnectorTarget
    end

The ShellFilePreview type exposes the following members.

Constructors

	Name	Description
	ShellFilePreview	Default constructor.

Top

Properties

	Name	Description
	AutomaticRefresh	Gets or sets a value indicating whether the ShellFilePreview will be reloaded automatically when the file changes or is deleted. This is a dependency property.
	Location	The location of the folder to be displayed.
	NoPreviewAvailableMessage	Gets or sets a message to be displayed if the item to be previewed is not supported.
	Path	Gets or sets the full pathname of the file/shell item to be displayed.
	PreviewNotPossibleMessage	Gets or sets a message to be displayed if loading the preview failed.
	SelectFileMessage	Gets or sets a message to be displayed when no item is active.
	ShellControlConnector	Gets or sets a ShellControlConnector.
	StateMessage	Gets or sets the message that is printed in the component if no preview is currently visible or an error occured.
	Version	The current version of ShellBrowser Components WPF.

Top

Methods

	Name	Description
	Clear	Clears the contents of the preview.
	Dispose	Unloads any pending files and finishes running threads.
	Dispose(Boolean)	Unloads any pending files and finishes running threads.
	FolderChanged	Preview is cleared if a new folder has been set.
	GetDisplayRect	Gets display rectangle.
	GetSynchronizationContext	PreviewHost must provide its SynchronizationContext to be used by async events.
	GetWindowHandle	Gets window handle of the main window.
	OnAfterPreviewLoaded	Calls the AfterPreviewLoaded event.
	OnApplyTemplate	When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate. (Overrides FrameworkElementOnApplyTemplate.)
	OnCommonPreviewHandlerLoaded	Controls implementing this interface must implement this eventhandler, which is called after the preview has been loaded.
	OnLoadPreview	Calls the LoadPreview event.
	OnPropertyChanged	Invoked whenever the effective value of any dependency property on this FrameworkElement has been updated. The specific dependency property that changed is reported in the arguments parameter. Overrides OnPropertyChanged(DependencyPropertyChangedEventArgs). (Overrides FrameworkElementOnPropertyChanged(DependencyPropertyChangedEventArgs).)
	OnRenderSizeChanged	Raises the SizeChanged event, using the specified information as part of the eventual event data. (Overrides FrameworkElementOnRenderSizeChanged(SizeChangedInfo).)
	Open	Opens the given file.
	RemoveCustomPreviewHandler	Removes the visual elements that were added using SetCustomPreviewHandler(UIElement). This is typically called in Unload
	SelectedFileChange	Tries to display the preview or thumbnail of the file.
	SetCustomPreviewHandler	Use this method to add the UI elements representing a custom preview to the ShellFilePreview control.

Top

Events

	Name	Description
	AfterPreviewLoaded	Event that occurs after the preview has been loaded.
	LoadPreview	Event is thrown when a file is previewed. It can be implemented to control some aspects of the ShellFilePreview based on the current file or to set a custom preview control.

Top

Fields

	Name	Description
	AutomaticRefreshProperty	Identifies the AutomaticRefresh dependency property.
	LocationProperty	The DependencyProperty for ItemIdList.

Top

Remarks

Use this component to display a preview of a file. Depending on the installed PreviewHandlers not all files types support a preview. If no preview is registered, a thumbnail of the file is shown. You may use the Location dependency property to set a path to a file to load the preview of. The component is using the Preview Handlers registered in the system to display the files, so that normally the same files that Windows Explorer can preview should be supported. There are occasional problems concerning the bitness of the application using the ShellFilePreview vs. the bitness of the PreviewHandler registered for a filetype.

Reference

Jam.Shell.WPF.Controls Namespace