JamShellChangeNotifier.TJamShellChangeNotifier

The TJamShellChangeNotifier component informs about changes in the file system and the shell.

Syntax

Pascal

TJamShellChangeNotifier = class(TJamBaseComponent, ICancellationIndicator);

Remarks

Use this component to get information about changes in the file system (copy, move or delete operations) and other changes relevant for shell operations. The Directory property decides which part of the shell namespace will be watched for changes. If this component is placed on a form in the desinger and no directory is specified, it will watch the entire PC after the form is loaded.

Namespace

JamShellChangeNotifier

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

JamShellChangeNotifier.TJamShellChangeNotifier

	Name	Description
	constructor Create(pCheckForDuplicates: Boolean); overload; reintroduce;	Constructor of the TJamShellChangeNotifier component.
	constructor Create(AOwner: TComponent); override; overload;	Constructor of the TJamShellChangeNotifier component.
	destructor Destroy; override;	Destructor of the TJamShellChangeNotifier component.

TJamShellChangeNotifier Events

JamShellChangeNotifier.TJamShellChangeNotifier

	Name	Description
	property OnChange: TJamShellNotifierEvent read fOnChange write fOnChange;	This event occurs, if a relevant change has occurred in the ShellNamespace.
	property OnChangePIDL: TJamShellNotifierEventPIDL read fOnChangePIDL write fOnChangePIDL;	Intended for internal use only.

ICancellationIndicator Methods

	Name	Description
	function IsCancellationRequested: Boolean;	Gets whether cancellation has been requested for this token.

JamShellChangeNotifier.TJamShellChangeNotifier

	Name	Description
	procedure Add(const pItemIdLists: IItemIdListCollection);	Adds a collection of ItemIdLists for watching.
	procedure AddItemIdList(const pItemIdList: IItemIdList; const pRecursive: Boolean; pEventFilter: TNotificationEvents = []); overload;	Adds an ItemIdList of a file or directory for watching.
	procedure AddItemIdList(const pItemIdList: IItemIdList; pEventFilter: TNotificationEvents = []); overload;	Adds an ItemIdList of a file or directory for watching.
	procedure AddPath(const pPath: string);	Adds a path of a file or directory for watching.
	procedure Clear;	Removes all directories from the Directories property and afterwards no longer watches any drive or folder.
	procedure RemoveItemIdList(const pItemIdList: IItemIdList);	Removes a the ItemIdList of a file or directory for watching.
	procedure RemovePath(const pPath: string);	Removes a path of a file or directory for watching.

TJamBaseComponent Properties

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.

JamShellChangeNotifier.TJamShellChangeNotifier

	Name	Description
	property Count: Integer read GetCount;	The number of watched paths in this instance.
	property Directories: TJamPathList read GetDirectories;	List of the watched directories.
	property Enabled: Boolean read GetEnabled write SetEnabled default True;	Enables or disables the change notifications.
	property EventFilter: TNotificationEvents read fEventFilter write SetEventFilter default [neAssociationChange, neAttributesChange, neFileChange, neFileCreate, neFileDelete, neFileRename, neDriveAdd, neDriveRemove, neShellDriveAdd, neDriveSpaceChange, neMediaInsert, neMediaRemove, neFolderCreate, neFolderDelete, neFolderRename, neFolderUpdate, neNetShare, neServerDisconnect, neImageListChange];	Selects the events that should be monitored.
	property Handle: THandle read fHandle;	The window handle of this instance to which Windows sends the Shell chnage notifications.
	property NotifyAsynchronously: Boolean read fNotifyAsynchronously write fNotifyAsynchronously default False;	If False (the default value) the events will be fired in context of the main thread.If True, the events will be fired in the context of concurrent threads.
	property Recursive: Boolean read fRecursive write SetRecursive default true;	Decides if subfolders are watched too.

Links

JamShellChangeNotifier, Legend, Members, Public Methods, TJamShellChangeNotifier Events, ICancellationIndicator Methods, TJamBaseComponent Properties

Contents | Index | Home