Jam.Shell.DetailsPane.TDetailsPane

ShellBrowser Delphi Components Documentation

Contents

Index

Home

Previous

Next

Jam.Shell.DetailsPane.TDetailsPane

Jam.Shell.DetailsPane Legend Members Public Methods TDetailsPane Constants IJamShellControl Methods IJamShellControl Properties

This control displays some meta data and a preview of a file or object.

Class Hierarchy

Syntax

Pascal

TDetailsPane = class(TCustomPanel, IJamShellControl);

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

We currently support filesystem path, IItemIdList and IHierarchicalBase.

Jam.Shell.DetailsPane

Jam.Shell.DetailsPane.TDetailsPane

	Name	Description
	constructor Create(AOwner: TComponent); override;	Creates an instance of a TDetailsPane component
	destructor Destroy; override;	The destructor of the class.

TDetailsPane Constants

Jam.Shell.DetailsPane.TDetailsPane

	Name	Description
	const cDefaultWidth = 240;	The initial width of the control in pixels @100% dpi scaling.

TDetailsPane Events

Jam.Shell.DetailsPane.TDetailsPane

	Name	Description
	property OnLoadPreview: TJamFilePreviewLoadPreviewEvent read fLoadPreviewEvent write fLoadPreviewEvent;	Occurs before the preview handler is loaded for the given file. It may be used to control some aspects of the preview, such as the previewhandler that will be used. TJamFilePreviewLoadPreviewEventArgs

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.

Jam.Shell.DetailsPane.TDetailsPane

	Name	Description
	procedure AddSnippet(const pSnippet: string; const pSearchExpression: string; const pOptions: TSelectionOptions);	Shows a snippet in the details pane.
	procedure AfterConstruction; override;	Excuted after the constructor was called.
	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 Refresh(pRefreshLevel: TRefreshLevel; pItemIdList: IItemIdList = nil);	This method indicates that the control should perform a refresh of its contents.
	procedure Reload(const pRefreshLevel: TRefreshLevel = rfFull); virtual;	Reloads the information in this control.
	procedure SetCurrentObject(const pObject: IInterface);	Sets the current object for that information is shown. We currently support the interfaces IHierarchcalBase and IItemIdList.

IJamShellControl Properties

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

Jam.Shell.DetailsPane.TDetailsPane

	Name	Description
	property Align;	See TControl.Align
	property Alignment;	See TControl.Alignment
	property Anchors;	See TControl.Anchors
	property BevelOuter;	See TControl.BevelOuter
	property Color;	See TControl.Color
	property Constraints;	See TControl.Constraints
	property DoubleBuffered;	See TWinControl.DoubleBuffered
	property Font;	See TControl.Font
	property HeaderMetaData: TShellColumnId read fHeaderMetaData write fHeaderMetaData;	The metadata through that the path can be retrieved.
	property MetaData: TShellColumnIdArray read fMetaData write fMetaData;	The metadata displayed in the grid.
	property OnMetaDataDisplayName: TMetaDataDisplayName read fOnMetaDataDisplayName write fOnMetaDataDisplayName;	Event that is called when the display name of a certain meta data is needed.
	property Padding;	See TControl.Padding
	property ParentBackground;	See TControl.ParentBackground
	property ParentColor;	See TControl.ParentColor
	property ParentDoubleBuffered;	See TWinControl.ParentDoubleBuffered
	property ParentFont;	See TControl.ParentFont
	property ParentShowHint;	See TControl.ParentShowHint
	property Path: string read fCurrentPath write SetPath;	Adds a header row to the grid for showing the object's name.
	property PopupMenu;	See TControl.PopupMenu
	property Preview: TJamFilePreview read fPreview;	Access to the Preview in the control.
	property ShellLink: TJamShellLink read getShellLink write setShellLink;	Connects this component to a TJamShellLink in order to synchronize it to other shell controls.
	property ShowHint;	See TControl.ShowHint
	property ShowPreview: TShowPreview read fShowPreview write fShowPreview default TShowPreview;	Defines whether or not the file preview is shown.
	property StyleName;	Specifies the style name for this control.
	property TabOrder;	See TControl.TabOrder
	property TabStop;	See TControl.TabStop
	property Visible;	See TControl.Visible

Jam.Shell.DetailsPane, Legend, Members, Public Methods, TDetailsPane Constants, TDetailsPane Events, IJamShellControl Methods, IJamShellControl Properties

Contents | Index | Home