JamFilePreview.TJamFilePreview

The TJamFilePreview component allows you to show a preview of a file

Syntax

Pascal

TJamFilePreview = class(TCustomPanel, IJamShellControl);

Remarks

Use this component to preview a file. Like in Windows Explorer registered PreviewHandlers are used to render the preview so the results will vary depending on installed previewHandlers.

You may either set the Path property to set a path to a file for which the preview should be displayed. Or you may synchronize it to a TJamShellList or TJamShellTree component using the ShellLink property.

Use the TJamFilePreview.OnLoadPreview event for ways to configure the contents of the preview.

Namespace

JamFilePreview

Public Methods

JamFilePreview.TJamFilePreview

	Name	Description
	constructor Create(AOwner: TComponent); override;	Creates an instance of a TJamFilePreview component
	destructor Destroy; override;	Destroys an instance of a TJamFilePreview component

TJamFilePreview Events

JamFilePreview.TJamFilePreview

	Name	Description
	property OnLoadedPreview: TJamFilePreviewLoadedEvent read fLoadedPreview write fLoadedPreview;	Occurs after the preview of a file is displayed. The event is also raised if a file could not be previewed.
	property OnLoadPreview: TJamFilePreviewLoadPreviewEvent read fLoadPreview write fLoadPreview;	Occurs before the preview handler is loaded for the given file

IJamShellControl Methods

	Name	Description
	procedure FileChanged(FolderPIDL: IItemIdList; FilePIDL: IItemIdList);	This method is called by the ShellLink instance if the currently selected item has changed.
	function getShellLink: TJamShellLink;	Getter method for the ShellLink property.
	function GoUp: Boolean;	This method indicates that the callee should go up one level and display the contents of the current folder's parent folder.
	procedure PathChanged(FolderPIDL: IItemIdList);	This method is called by the ShellLink instance if the currently displayed folder has changed.
	procedure Refresh(pRefreshLevel: TRefreshLevel; pItemIdList: IItemIdList = nil);	This method indicates that the control should perform a refresh of its contents.
	procedure SelectAll;	This method indicates that the callee should select all item it currently displays.
	procedure setShellLink(aValue: TJamShellLink);	Setter method for the ShellLink property.

JamFilePreview.TJamFilePreview

	Name	Description
	procedure Invalidate; override;	Invalidates the control.
	procedure LoadFromStream(const pStream: TStream; const pExtension: String);	Allows using a stream to show a file's preview.
	class function PreviewHandlerOnSystem(const pPreviewHandlerGuid: TGuid): Boolean;	Checks, if the passed GUID is registered.
	class procedure PrintPreviewHandler;	Prints a list of installed PreviewHandlers to the Debug Log.
	procedure Refresh(pRefreshLevel: TRefreshLevel; pItemIdList: IItemIdList = nil);	This method indicates that the control should perform a refresh of its contents.
	procedure Resize; override;	Respond to control resize
	procedure ScrollTo(pCharPos: integer);	Scrolls to the passed character position.
	function SelectString(const pString: string; const pOptions: TSelectionOptions): integer;	Only supported in the TextPreviewHandler, where each occurrence of the given string is highlighted and the first match focussed.
	procedure UnselectAll;	Removes any highlighting.

IJamShellControl Properties

	Name	Description
	property ShellLink: TJamShellLink read getShellLink write setShellLink;	The TJamShellLink instance to which the current control connected.

JamFilePreview.TJamFilePreview

	Name	Description
	property AbsoluteItemIdList: IItemIdList read GetAbsoluteItemIdList write SetAbsoluteItemIdList;	AbsoluteItemIdList of the item that is/should be previewed
	property Align;	Determines how the control aligns within its container (parent control).
	property Anchors;	See TCustomPanel.Anchors
	property AutomaticRefresh: Boolean read fAutomaticRefresh write SetAutomaticRefresh default True;	Receives notifications about changes in the shell and performs refreshes automatically.
	property BevelInner default bvNone;	See TCustomPanel.BevelInner
	property BevelOuter default bvNone;	See TCustomPanel.BevelOuter
	property BevelWidth;	Determines the width, in pixels, of both the inner and outer bevels of a panel.
	property BorderStyle;	Determines whether the list view displays a single line border.
	property BorderWidth;	Specifies the distance, in pixels, between the outer and inner bevels.
	property Caption;	The caption property is used for temporary state messages the control issues.
	property CenterVertically: Boolean read fCenterVertically write fCenterVertically default True;	If true, previews of images are centered vertically, if false they are top-aligned.
	property Color;	See TCustomPanel.Color
	property Constraints;	Specifies the size constraints for the control.
	property DragCursor;	Specifies the image used to represent the mouse pointer when the control is being dragged.
	property DragKind;	Specifies whether the control is being dragged normally or for docking.
	property DragMode;	Specifies how the control initiates drag-and-drop or drag-and-dock operations.
	property Enabled: Boolean read GetEnabled write SetEnabled default true;	Enables or disables the preview.
	property FallbackPdfHandlerActive: Boolean read fFallbackPdfHandler write fFallbackPdfHandler;	If set to true PDF files will be previewed via the Acrobat ActiveX object if the registered PreviewHandler failed.
	property Font;	Specifies the attributes of text written on or in the control.
	property OnCanResize;	Occurs when an attempt is made to resize the control.
	property OnClick;	See TControl.OnClick
	property OnContextPopup;	Occurs when the user right-clicks the control or otherwise invokes the pop-up menu (such as using the keyboard).
	property OnDblClick;	Occurs when the user double-clicks the left mouse button when the mouse pointer is over the control.
	property OnDragDrop;	Occurs when the user drops an object being dragged.
	property OnDragOver;	Occurs when the user drags an object over a control.
	property OnEndDock;	Occurs when the dragging of an object ends, either by docking the object or by canceling the dragging.
	property OnEndDrag;	Occurs when the dragging of an object ends, either by dropping the object or by canceling the dragging.
	property OnMouseDown;	Occurs when the user presses a mouse button with the mouse pointer over a control.
	property OnMouseMove;	Occurs when the user moves the mouse pointer while the mouse pointer is over a control.
	property OnMouseUp;	Occurs when the user releases a mouse button that was pressed with the mouse pointer over a component.
	property OnStartDock;	Occurs when the user begins to drag a control with a DragKind of dkDock.
	property OnStartDrag;	Occurs when the user begins to drag the control or an object it contains by left-clicking the control and holding the mouse button down.
	property ParentBackground default false;	See TCustomPanel.ParentBackground
	property ParentColor;	See TCustomPanel.ParentColor
	property ParentFont;	Specifies where a control looks for its font information.
	property ParentShowHint;	Specifies where a control looks to find out if its Help Hint should be shown.
	property Path: string read GetPath write SetPath;	Set the path of the object that should be previewed.
	property PopupMenu;	Specifies the pop-up menu associated with the control.
	property PreviewNotAvailableMessage: string read GetPreviewNotAvailableMessage write fPreviewNotAvailableMessage;	Sets a custom hint message if the currently selected file does not support being previewed.
	property PreviewNotPossibleMessage: string read GetPreviewNotPossibleMessage write fPreviewNotPossibleMessage;	Sets a custom hint message if the preview could not be displayed.
	property SelectFileMessage: string read GetSelectFileMessage write fSelectFileMessage;	Sets a custom hint message if no element is currently selected.
	property ShellLink: TJamShellLink read getShellLink write setShellLink;	Connects this component to a TJamShellLink in order to synchronize it to other shell controls.
	property ShowHint;	Specifies whether to show the Help Hint when the mouse pointer moves over the control.
	property ShowIcons: Boolean read fShowIcons write fShowIcons;	Whether the FilePreview will display a file's icon, if no other preview can be loaded.
	property Status: TJamFilePreviewStatus read GetStatus;	Holds information on the state of the component
	property StyleName;	Specifies the style name for this control.
	property Touch;	Touch specifies the touch manager component associated with the control.
	property UseSystemTextPreviewHandler: Boolean read fUseSystemTextHandler write fUseSystemTextHandler default true;	The FilePreview has an own implementation for previewing files with textual content. Set this flag to false, to use it.
	property Version: String read GetVersion stored false;	The version number of the ShellBrower controls.
	property Visible;	Determines whether the component appears onscreen.

Links

JamFilePreview, Legend, Members, Public Methods, TJamFilePreview Events, IJamShellControl Methods, IJamShellControl Properties

Contents | Index | Home