Platforms to show: All Mac Windows Linux Cross-Platform

Back to FolderItem class.

FolderItem.IconMaskMBS(width as Integer, WindowsFlags as Integer=0) as picture

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Icon Service MBS Picture Plugin 3.3 ✅ Yes ✅ Yes ❌ No ✅ Yes All
Returns an picture with the icon mask of a FolderItem.
Example 
Backdrop=SpecialFolder.Desktop.IconMaskMBS(512)

May return a picture which is smaller as requested if the given picture size is not available. (Changed in v5.3 to return the requested size)
On Windows the icon picture is scaled to the requested size. (Actually the plugin can only get 32bit pixels wide icons on Windows as maximum)
Good sizes on Mac OS are 16, 32, 48 and 128 pixels.
Returns nil on low memory.

Please use with IconImageMBS and not with IconMBS function.
Version 8.6: Now reads the 8 bit alpha values if possible.

You can pass flags for Windows options:
SHGFI_ADDOVERLAYS= &h20Apply the appropriate overlays to the file's icon.
SHGFI_LINKOVERLAY= &h8000Adds the link overlay to the file's icon.
SHGFI_OPENICON= 2Retrieve the file's open icon
SHGFI_SELECTED= &h10000Blend the file's icon with the system highlight color.

This function can fail if the file does not exist.
Added 1024 pixel support in 12.3 plugins.

On Windows, it may be that you get a 256 pixel icon with small icon on top left. This is simply how windows handles the case when no big icon is available.

Some examples using this method:

Blog Entries

The items on this page are in the following plugins: MBS Picture Plugin.


The biggest plugin in space...