ShellLink.TJamShellLink

Component that allows to synchronize the view of multiple shell controls.

Syntax

Pascal

TJamShellLink = class(TJamBaseComponent, IJamShellHistory);

Remarks

This component is able to synchronize several of the visual shell components, e.g. JamShellTree, JamShellList and JamShellCombo. Just drop a JamShellLink component to this form and assign the ShellLink property of all shell components to the ShellLink component. You can refresh all connected shell controls by using the TJamShellLink.Refresh method. You can disable a ShellLink component temporarily by using the Enabled property.

If you want to use CheckBoxes in a JamShellTree or JamShellList, that must be connected to a JamShellLink. The ShellLink will synchronize the selected files and folder in the different shell controls.

The JamShellLink class implements the TJamShellLink interface. In Delphi/C++Builder, the ShellLink can be assigned to the corresponding components during design time in the Object Inspector.

The assign of the JamShellLink is equivalent to all other components, which have a ShellLink property, e.g. JamFileList and JamThumbnailImage.

Namespace

ShellLink

Public Methods

ShellLink.TJamBaseComponent

	Name	Description
	constructor Create(AOwner: TComponent); override;	Creates and intializes an instance of this component.
	destructor Destroy; override;	See TWinControl.ParentDoubleBuffered

ShellLink.TJamShellLink

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

TJamShellLink Events

ShellLink.TJamShellLink

	Name	Description
	property OnChange: TItemIdListEvent read FOnChange write FOnChange;	This event will be triggered whenever the connected controls will be informed about a new active folder.
	property OnNavigating: TNavigationPendingEvent read fOnNavigating write fOnNavigating;	Occurs when navigating to a folder. You can intercept navigation by setting the Cancel parameter in the event arguments.
	property OnSelectionChanged: TItemIdListEvent read fOnSelectionChange write fOnSelectionChange;	This event will be triggered whenever the connected controls will be informed about a selected subelement, i.e. an element in a TJamShellList.

IJamShellHistory Methods

	Name	Description
	procedure Add(const pItemIdList: IItemIdList);	Adds a visited folder to the list.
	procedure Clear;	Clears the history of visited folders.
	function GetCount: Integer;	Gets the count of visited folders.
	function GetCurrentFolderItemIDList: IItemIdList;	Gets the current folder ItemIdList.
	function GetPosition: Integer;	Gets the current position in history of visited folders.
	function IsMovePossible(pDelta: Integer): Boolean;	Checks if a move is possible.
	procedure MoveBack(const pSteps: Byte = 1);	Moves back in history of visited folders.
	procedure MoveForward(const pSteps: Byte = 1);	Moves forward in history of visited folders.
	procedure SetPosition(const pPosition: Integer);	Sets the current position in history of visited folders.

ShellLink.TJamShellLink

	Name	Description
	function CanNavigate(const Sender: TObject; const pItemIdList: IItemIdList): boolean;	Use this function to check if navigating the passed ItemIdList is allowed. It currently calls the cancellable OnNavigating event, that can be implemented to prohibit paths.
	procedure Clear;	Clears the history of visited folders.
	procedure FileChanged(Sender: IJamShellControl; FolderPIDL: IItemIdList; FilePIDL: IItemIdList);	This public method is used by the connected controls for synchronization.
	procedure FilterChanged(Sender: IJamShellControl; const Filter: string);	Call method, when a new filter shall be updated in linked controls that support filters.
	procedure GoUp; overload;	Goes up one level in the file system structure.
	procedure GoUp(Sender: IJamShellControl); overload;	For internal use only.
	function IsMovePossible(pDelta: Integer): Boolean;	Checks if a move is possible.
	procedure MoveBack(const pSteps: Byte = 1);	Moves back in history of visited folders.
	procedure MoveForward(const pSteps: Byte = 1);	Moves forward in history of visited folders.
	procedure PathChanged(Sender: IJamShellControl; PIDL: IItemIdList);	This public method is used by the connected controls for synchronization.
	procedure Refresh(Sender: IJamShellControl; pRefreshLevel: TRefreshLevel; pItemIdList: IItemIdList = nil); overload;	Refreshes the information displayed in all controls connected with this JamShellLink except the passed control, which usually will be the caller.
	procedure Refresh(pRefreshLevel: TRefreshLevel); overload;	Refreshes the information displayed in all controls connected with this JamShellLink.
	procedure RegisterShellControl(ShellControl: IJamShellControl);	Registers the control for update notifications.
	procedure SelectAll; overload;	Selects all items in the connected controls.
	procedure SelectAll(Sender: IJamShellControl); overload;	Selects all items in the connected controls.
	procedure UnregisterShellControl(ShellControl: IJamShellControl);	Unregisters the control. No more notifications will be received by the control.

IJamShellHistory Properties

	Name	Description
	property Count: Integer read GetCount;	Gets the count of visited folders.
	property CurrentFolderItemIDList: IItemIdList read GetCurrentFolderItemIDList;	Gets the current folder ItemIdList.
	property Position: Integer read GetPosition write SetPosition;	Gets or sets the current position in history of visited folders.

ShellLink.TJamBaseComponent

	Name	Description
	property Enabled: Boolean read GetEnabled write SetEnabled default True;	Indicates whether the component is enabled or not.
	property Version: String read GetVersion stored False;	Returns the version of the ShellBrowser components.

ShellLink.TJamShellLink

	Name	Description
	property Count: Integer read GetCount;	Gets the count of visited folders.
	property CurrentFileItemIdList: IItemIdList read fCurrentFileItemIdList;	Contains the absolute ItemIdList of the file that is currently selected in the connected controls.
	property CurrentFolderItemIdList: IItemIdList read GetCurrentFolderItemIDList;	Contains the absolute ItemIdList of the folder that is currently selected in the connected controls.
	property Position: Integer read GetPosition write SetPosition;	Gets or sets the current position in history of visited folders.
	property SelectionList: TJamSelectionList read get_SelectionList write set_SelectionList;	Gives access to the files/folders selected using the checkboxes.
	property ShowParentFolderItem: Boolean read get_ShowParentFolderItem write set_ShowParentFolderItem default True;	For internal use only.

Links

ShellLink, Legend, Members, Public Methods, TJamShellLink Events, IJamShellHistory Methods, IJamShellHistory Properties

Contents | Index | Home