ShellBrowser.TJamSystemImageList

The TJamSystemImageList component provides the icons of the Windows shell in from of a Delphi ImageList descendant.

Syntax

Pascal

TJamSystemImageList = class(TCustomImageList);

Remarks

Use this component to get access to the system image list of Windows. This can be useful if you want to display shell related information in a Delphi TListView or TTreeView. Then just place a TJamSystemImageList component on your form and assign it to the Images property of the TTreeView of TListView. Use the Size property to switch between small and large icons. GetIndexFromExtension will return the icon number for a given extension or filename. Use the Draw and GetBitmap methods of Delphi`s TCustomImageList component to draw an icon somewhere on a TCanvas or to retrieve it as bitmap.

Example

The following example will retrieve the large icon associated with Word documents as bitmap:

var index : Integer;
    bitmap: TBitmap;
begin
  index := SystemImageList.GetIndexFromExtension('doc');
  bitmap:= TBitmap.Create;
  SystemImageList.GetBitmap(index, bitmap);
end;

Namespace

ShellBrowser

Public Methods

	Name	Description
	constructor Create(AOwner: TComponent); override; overload;	Creates an instance of a TJamSystemImageList component.
	constructor Create(pSize: TJamImageListSize = TJamImageListSize.si_Small; pOwner: TComponent = nil); overload; reintroduce;	Creates an instance of a TJamSystemImageList component.
	constructor Create(pHeight: integer; pOwner: TComponent = nil; pSize: TJamImageListSize = si_freescaled); overload; reintroduce;	Creates an instance of a TJamSystemImageList component.
	constructor CreateScaled(const pSize: TJamImageListSize; const pDestPPI: integer; pOwner: TComponent = nil);	Creates a scaled instance of a TJamSystemImageList component.

TJamSystemImageList Methods

	Name	Description
	class function BitmapFromHBitmap(pBmpHandle: HBITMAP; pWidth: Integer; pHeight: Integer; pBgColor: TColor = clNone): TBitmap;	Converts the given HBITMAP into a TBitmap.
	procedure ChangeScale(M: Integer; D: Integer); deprecated;	Reloads the image list handle if needed to adjust to a new dpi scaling.
	class procedure ConvertTo32BitImageList(const ImageList: TCustomImageList);	Converts imagelist to an image with alpha channel.
	class function CopySystemImageTo(pImageList: TCustomImageList; pIconNumber: Integer): Integer;	Copies an image from the system image list to another imagelist.
	class function DefaultSize: Integer;	The default size in pixels of the small system-imagelist respecting dpi-scaling.
	class function GetAsBitmap(pImageList: TCustomImageList; aIconNumber: Integer; aHeigth: Integer = -1; aWidth: Integer = -1; BorderColor: TColor = clSilver; BackgroundColor: TColor = clNone; pStretch: Boolean = false): TBitmap;	Returns a bitmap showing the icon for a given icon number.
	class function GetFileType(pExtension: string): string;	Returns the type of the specified file extension.
	class function GetFolderIconNumber(opened: Boolean = false): Integer;	Returns the number of the standard folder icon.
	class function GetIndexFromExtension(const Extension: string; aSize: TJamImageListSize = si_Small; Opened: Boolean = False): Integer;	Returns the icon number for a given extension.
	class function GetIndexFromItemIdList(const AbsoluteItemIdList: IItemIdList; aSize: TJamImageListSize = si_Small; Opened: Boolean = False): Integer;	Returns the icon number for a given absolute ItemIdList.
	class function GetIndexFromPath(const pFullPath: string; pSize: TJamImageListSize = si_Small; pOpened: Boolean = False): Integer;	Returns the image index of a given path in the system image list.
	class function GetIndexFromPathByExt(const Path: string; aSize: TJamImageListSize = si_Small; Opened: Boolean = False): Integer;	Returns the icon number for a given path.
	class function GetInstance(pWidth: Integer): TJamSystemImageList; overload;	Returns a reference to a global image list with a size matching best to the gicen width.
	class function GetInstance(pSize: TJamImageListSize = TJamImageListSize.si_FreeScaled): TJamSystemImageList; overload;	Returns a reference to a global image list.
	function GetSize: TSize;	Supplies the size of the images in this system imagelist in pixels.
	function GetSpecialFolderIcon(folder: TJamShellFolder): Integer;	Returns the icon number for a given special folder.
	class function GetUnknownFileIconNumber: Integer;	Returns the number of the standard icon for files with no known extension.
	class function PixelsToSize(pPixels: Integer): TJamImageListSize;	Converts the given size into a member of TJamImageListSize that fits best based on the primary monitor's dpi settings.
	procedure Scale(pPixels: Integer);	Reloads the image list handle if needed to adjust to a new dpi scaling.

TJamSystemImageList Properties

	Name	Description
	property BkColor default clWhite;	Determines which background color to use when drawing an image.
	property DrawingStyle;	Specifies the style to be used when the image list is drawing an image.
	property Height: Integer read GetHeight;	The height of the images in this system imagelist in pixels.
	property OnChange;	Occurs when the image list changes.
	property ShareImages: Boolean read GetShareImages write SetShareImages default nodefault;	Share images with the shell or make own copy.
	property Size: TJamImageListSize read fSize write SetSize default si_small;	Switch between small and large icon for the ImageList.
	property Version: String read GetVersion stored false;	The version number of the ShellBrower controls.
	property Width: Integer read GetWidth;	The width of the images in this system imagelist in pixels.

Links

ShellBrowser, Legend, Members, Public Methods, Example, TJamSystemImageList Methods, TJamSystemImageList Properties

Contents | Index | Home