Name 

Description 

 

constructor Create(const pAbsoluteItemIdList: IItemIdList); overload; reintroduce; 

This constructor creates a new instance of the TShellBrowser class and initializes for the given object identified by an ItemIdList. 

 

constructor Create(AOwner: TComponent); override; overload; 

Creates an instance of a ShellBrowser component.  

 

constructor Create(pCopyFrom: TShellBrowser); overload; reintroduce; 

Copy constructor  

 

constructor Create(const aObjectPath: string); overload; reintroduce; 

This constructor creates a new instance of the TShellBrowser class and initializes for the given path. 

 

destructor Destroy; override; 

Destroys the instance of this class  

 

Name 

Description 

 

function AddLinkTo(const pDestinationFolder: string; const pLinkName: string = ''): IItemIdList; 

Adds a link (shortcut) to the element referred to by AbsoluteItemIdList in the passed folder. 

 

function BrowseObject: Boolean; 

Use BrowseObject to browse into the current object.  

 

function CanRename: Boolean; 

Returns true, if the current object can be renamed.  

 

function CheckIfValid(pFolderOnly: Boolean = False): Boolean; 

Checks if the current object is in a valid state for performing operations  

 

procedure CopyTo(pChangeNotifier: TJamShellChangeNotifier); overload; 

Adds the current object(s) of this instance to a TJamShellChangeNotifier.  

 

function FilterMatch: Boolean; 

Checks if the currently active object matches the filter.  

 

function GetAttributes(pAttributes: UINT): UINT; 

Get Attributes of the current object.  

 

function GetColumnInfo(col: Integer; var Width: Integer): TAlignment; overload; deprecated; 

Returns information about alignment and width of a column.  

 

procedure GetColumnInfo(pColumnIndex: Integer; out pColumnInfo: TColumnInfo); overload; deprecated; 

Returns information about alignment, visibility and width of a Shell column.  

 

procedure GetColumnInfo(const pShellColumn: TShellColumnId; out pColumnInfo: TColumnInfo); overload; deprecated; 

Returns information about alignment, visibility and width of a Shell column.  

 

function GetColumnText(pColumnIndex: Integer; pHeader: Boolean): string; overload; 

Returns the text which would be displayed in the Details view of the Windows Explorer.  

 

function GetColumnText(const pColumnID: TShellColumnId; pHeader: Boolean): string; overload; 

Returns the text which would be displayed in the Details view of the Windows Explorer.  

 

function GetColumnText(const pColumnID: TShellColumnId; pHeader: Boolean; var pColumnVariant: Variant): string; overload; 

Returns the text which would be displayed in the Details view of the Windows Explorer as String and Variant.  

 

function GetColumnValue(const pColumnID: TShellColumnId): Variant; 

Returns the value which would be displayed in the Details view of the Windows Explorer as Variant.  

 

function GetDefaultColumnState(colID: Integer): DWord; 

Returns the default column state.  

 

function GetDesktopIconIndex: Integer; 

Use GetDesktopIconIndex to get the number of the desktop icon.  

 

function GetDesktopName: string; 

This method returns the language defendant name of the Desktop folder.  

 

function GetFileSize: Int64; 

This method returns the size of the current file in Bytes and -1 upon error.  

 

function GetIndexOfShColumnId(const pColumnID: TShellColumnId): Integer; 

Returns the index for a given SHColumnId. 

 

function GetInfoTip(UseSlowInfoTip: Boolean = false): string; 

This method returns the hint text of the current object, which is provided by the shell.  

 

function GetLastChangeDate: TDateTime; deprecated; 

Returns the last change date of the current object.  

 

function GetOverlayIndex: Integer; 

Use GetOverlayIndex to get the index of the overlay icon of the current object.  

 

function GetShColumnIdFromColumnNumber(pColumnNumber: Integer): TShellColumnId; 

Returns the SHColumnId for a given column number. 

 

function GetShellObjectName(pInFolderName: Boolean = True): string; 

Gets the well formatted shell name of the current object.  

 

function GetSortColumn: Cardinal; 

Returns the default sort column.  

 

function GetThumbnailBitmap(pWidth: Integer; pHeight: Integer; pIconInstead: Boolean = False; pBackgroundColor: TColor = clNone): TBitmap; deprecated; 

Deprecated; Use instead.  

 

function GetThumbnailImage(Image: TImage): Boolean; deprecated; 

Deprecated; Use TJamThumbnailExtractor.GetThumbnailAsImage instead.  

 

function GetUIObject(const pInterfaceID: TGUID): IUnknown; 

Wrapper for IShellFolder.GetUIObjectOf() method which retrieves a COM object for current shell object(s).  

 

procedure HandlePopupMessages(var Message: TMessage); 

Handles messages of popup messages, neccessary to show Send To submenu correct.  

 

function HasSubFolders: Boolean; 

Use the property HasSubFolders to check if the current object has subfolders.  

 

procedure InvokeCommand(const pCommand: TShellCommand); overload; 

Executes a command of the context menu of the current object.  

 

function InvokeContextMenuCommand(const pCommand: TShellCommand): Boolean; deprecated; 

Executes a command of the context menu of the current object.  

 

function InvokeDefaultContextMenuCommand(pPaths: TStrings): Boolean; deprecated; 

Executes the default path on the given files. 

 

function IsDrive: Boolean; 

This function returns true, if the given path is a drive like C:, D: or \servershare .  

 

function IsFileSystemFolder: Boolean; 

This function returns true, if the current object is a folder of the file system.  

 

function IsFolder: Boolean; 

Use the property IsFolder to check if the current object is a folder.  

 

function IsHidden: Boolean; 

Use this property to determine if the current object should be displayed as hidden.  

 

function IsLink: Boolean; 

Use this property to determine if the current object is a shortcut to another object.  

 

function IsSpecialObject: TJamShellFolder; 

Returns the type of the current object.  

 

function Next: Boolean; overload; 

Next enumerates the objects in the current folder.  

 

function Next(pChangeNotifier: TJamShellChangeNotifier): TEnumResult; overload; 

Next enumerates the objects in the current folder.  

 

procedure QueryBackgroundMenu(aPoint: TPoint); 

Query the BackgroundMenu - needed to generate the ShellNew-registry value for our NewFile-menu.  

 

function RenameObject(var NewName: string): HResult; deprecated; 

Use RenameObject to rename the current object.  

 

procedure SaveThumbnailToJPEG(const SourceFilename: string; const ThumbnailFilename: string; Width: Longint = 100; Height: LongInt = 100; Quality: LongInt = 80); deprecated; 

Deprecated; Use TJamThumbnailExtractor.SaveThumbnailToJPEG instead.  

 

function SelectParent: Boolean; 

Use SelectParent to select the parent folder.  

 

class procedure SetThumbnailProvider(pProvider: TOnThumbnailUnavailable); deprecated; 

Deprecated; Use TJamThumbnailExtractor.SetThumbnailProvider instead.  

 

function ShowBackgroundMenu(const aPoint: TPoint; aMenu: TPopUpMenu = nil): String; 

Show the context menu when the user right clicks on the background of the Windows Explorer.  

 

function ShowContextMenu(const Pos: TPoint; ShellMenuAnchor: TMenuItem; pBeforeCommand: TBeforeCommandFunc = nil): String; overload; 

Shows the context menu for files or folders as submenu of an existing menu item. 

 

function ShowContextMenu(const lppt: TPoint; M: TPopupMenu = nil; ShellMenuAnchor: TMenuItem = nil; pBeforeCommand: TBeforeCommandFunc = nil): String; overload; 

Shows the context menu for files or folders.  

 

function ShowNetConnectionDialog: Boolean; deprecated; 

Use this method to display the system dialog to connect a new network drive.  

 

function ShowObjectAccordingShowOptions(const pShowOptions: TJamShellShowOptions): Boolean; 

Determines if the object represented by this instances is visible with respect to the TJamShellShowOptions that are passed.  

 

Name 

Description 

 

property AbsoluteItemIdList: IItemIDList read GetAbsoluteItemIdList write SetAbsoluteItemIdList; 

AbsoluteItemIdList returns a pointer to a fully qualified ItemIdList of the current object.  

 

property AsyncContextMenuOperations: Boolean read fAsyncContextMenuOperations write fAsyncContextMenuOperations; 

If set to True (the default value), context menu operations will be executed asynchronously in an own thread if possible, if False, they will be executed synchronously in the main thread. 

 

property FileSystemOnly: Boolean read FFileSystemOnly write FFileSystemOnly default False; 

Use FileSystemOnly to specify, if Next will return only file system objects.  

 

property Filter: string read GetFilter write SetFilter; 

Allows you to filter objects by filename when enumerating them using the Next function.  

 

property Folder: string read GetDirectory write SetDirectory; 

Folder contains the path to the current object.  

 

property FolderIdList: IItemIdList read GetFolderIdList write SetFolderIdList; 

Gets or sets the current folder.  

 

property ForNavigation: Boolean read fForNavigation write fForNavigation default false; 

Decides if additional levels shoule be enumerated that are useful for navvigational purposes.  

 

property FullPath: string read GetFullPath write SetFullPath; 

The full path of the current object. 

 

property IconNumber: Integer read GetIconNumber; 

Use IconNumber to get the number of the icon for the current object.  

 

property ItemIdList: IItemIDList read GetItemIdList write SetItemIdList; 

ItemIdList contains a pointer to the ItemIdList of the current object.  

 

property MultiObjects: IItemIdListCollection read GetMultiObjects; 

Use MultiObjects if you want use ShowContextMenu or InvokeContextMenuCommand for multiple files and folders.  

 

property ObjectName: string read GetObjectName write SetObjectName; 

ObjectName contains the name of the current object  

 

property OnRename: TNotifyEvent read fOnRename write fOnRename; 

This event occurs when the user selected 'Rename' in the context menu of an object.  

 

property ReadOnly: Boolean read fReadOnly write fReadOnly; 

If set to true, context menu operations that make changes to the file system (like "delete" or "copy") will not be executed.  

 

property SelectedIconNumber: Integer read GetSelectedIconNumber; 

Use SelectedIconNumber to get the number of the 'opened' icon for the current object.  

 

property ShellFolder: IShellfolder read GetShellFolder write SetShellFolder; 

This property gives access to the IShellFolder interface of the current folder.  

 

property ShowContextMenuOnTop: Boolean read fShowContextMenuOnTop write fShowContextMenuOnTop default false; 

Decides if the shell context menu is added above or below the supplied Delphi TPopupMenu.  

 

property ShowErrorMessages: Boolean read fShowErrorMessages write fShowErrorMessages default true; 

Use this property to define, if Windows error messages and login dialogs will be shown to the user or not.  

 

property SpecialFolder: TJamShellFolder read GetSpecialFolder write SetSpecialFolder default SF_INVALID; 

Allows you to deal with non file system folders.  

 

property SpecialObject: TJamShellFolder read IsSpecialObject write SetSpecialObject; 

Allows you deal with non file system objects.  

 

property Version: String read GetVersion stored false; 

The version number of the ShellBrowser controls. 

 

Name 

Description 

 

property OnBeforeCommand: TOnBeforeCommand read GetOnBeforeCommand write SetOnBeforeCommand; 

This event occurs, before a context menu command is executed.  

 

property OnBeforeShellCommand: TOnBeforeShellCommand read GetOnBeforeShellCommand write SetOnBeforeShellCommand; 

This event occurs, before a context menu command is executed. Event is deprecated. Use OnBeforeCommand instead.  

 

property OnContextMenuSelect: TOnContextMenuSelectEvent read fOnContextMenuSelect write fOnContextMenuSelect; 

This event occurs, if the user has selected a menu item of the shell context menu.