Platforms to show: All Mac Windows Linux Cross-Platform
Back to WindowsPreviewHandlerMBS class.
WindowsPreviewHandlerMBS.Constructor(ClassID as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 12.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
You find those ClassIDs in the registry (See example project).
See HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\PreviewHandlers in the registry.
WindowsPreviewHandlerMBS.DoPreview
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 12.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Lasterror is set.
If the previewer window has not yet been created, then it must be created after this method has been called. The preview handler is responsible for painting the area specified in SetWindow or SetRect. If these methods are called while the preview handler is rendering, the window must be reparented/resized without stopping or restarting the rendering of the item.
This method should be called only after SetWindow has been called.
Aditionally, this method should be called only after Constructor has been called.
Some examples using this method:
WindowsPreviewHandlerMBS.InitWithData(data as MemoryBlock)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 12.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Lasterror is set.
If loading from data is not supported for preview, we use a temporary file instead.
You need to call Preview next on success to show a preview.
See also:
WindowsPreviewHandlerMBS.InitWithData(data as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 12.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Lasterror is set.
If loading from data is not supported for preview, we use a temporary file instead.
You need to call Preview next on success to show a preview.
See also:
WindowsPreviewHandlerMBS.InitWithFile(file as folderitem)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 12.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Lasterror is set.
If the preview handler does not support reading file, the plugin reads the file and passes as data.
You need to call Preview next on success to show a preview.
If the file path is invalid, the preview will show a file not found error message.
WindowsPreviewHandlerMBS.SetBackgroundColor(red as Integer, green as Integer, blue as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 12.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Lasterror is set.
Not all preview handlers implement this method.
WindowsPreviewHandlerMBS.SetFocus
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 12.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Lasterror is set.
WindowsPreviewHandlerMBS.SetFont(size as Integer, font as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 12.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Lasterror is set.
Not all preview handlers implement this method.
WindowsPreviewHandlerMBS.SetRect(left as Integer, top as Integer, width as Integer, height as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 12.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Lasterror is set.
If called before the preview handler window has been created, the new rectangle replaces the rectangle previously received in the SetWindow call.
If called after the preview handler window has been created, the preview handler window must be resized.
If the preview handler is already rendering, then the preview must be resized without interrupting the render process.
Some examples using this method:
WindowsPreviewHandlerMBS.SetTextColor(red as Integer, green as Integer, blue as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 12.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Lasterror is set.
Not all preview handlers implement this method.
WindowsPreviewHandlerMBS.SetWindow(win as ContainerControl)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 23.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
We query size of the container automatically to set the right size independent of the screen scaling.
See also:
- SetWindow(win as ContainerControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as Control)
- SetWindow(win as Control, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopContainer)
- SetWindow(win as DesktopContainer, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopControl)
- SetWindow(win as DesktopControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopWindow)
- SetWindow(win as DesktopWindow, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as window, left as Integer, top as Integer, width as Integer, height as Integer)
Some examples using this method:
WindowsPreviewHandlerMBS.SetWindow(win as ContainerControl, left as integer, top as integer, width as integer, height as integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 22.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Coordinates in pixels.
See also:
- SetWindow(win as ContainerControl)
- SetWindow(win as Control)
- SetWindow(win as DesktopContainer)
- SetWindow(win as DesktopContainer, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopControl)
- SetWindow(win as DesktopControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopWindow)
- SetWindow(win as DesktopWindow, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as Window)
- SetWindow(win as window, left as Integer, top as Integer, width as Integer, height as Integer)
WindowsPreviewHandlerMBS.SetWindow(win as Control)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 23.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
e.g. use a Canvas to host the preview.
We query size of the container automatically to set the right size independent of the screen scaling.
See also:
- SetWindow(win as ContainerControl)
- SetWindow(win as ContainerControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as Control, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopContainer)
- SetWindow(win as DesktopContainer, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopControl)
- SetWindow(win as DesktopControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopWindow)
- SetWindow(win as Window)
- SetWindow(win as window, left as Integer, top as Integer, width as Integer, height as Integer)
WindowsPreviewHandlerMBS.SetWindow(win as Control, left as integer, top as integer, width as integer, height as integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 22.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Coordinates in pixels.
See also:
- SetWindow(win as ContainerControl)
- SetWindow(win as ContainerControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as Control)
- SetWindow(win as DesktopContainer)
- SetWindow(win as DesktopContainer, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopControl)
- SetWindow(win as DesktopControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopWindow)
- SetWindow(win as DesktopWindow, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as Window)
WindowsPreviewHandlerMBS.SetWindow(win as DesktopContainer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 23.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
We query size of the container automatically to set the right size independent of the screen scaling.
See also:
- SetWindow(win as ContainerControl)
- SetWindow(win as ContainerControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as Control)
- SetWindow(win as Control, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopContainer, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopWindow)
- SetWindow(win as DesktopWindow, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as Window)
- SetWindow(win as window, left as Integer, top as Integer, width as Integer, height as Integer)
WindowsPreviewHandlerMBS.SetWindow(win as DesktopContainer, left as integer, top as integer, width as integer, height as integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 22.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Coordinates in pixels.
See also:
- SetWindow(win as ContainerControl)
- SetWindow(win as Control)
- SetWindow(win as Control, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopContainer)
- SetWindow(win as DesktopControl)
- SetWindow(win as DesktopControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopWindow)
- SetWindow(win as DesktopWindow, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as Window)
- SetWindow(win as window, left as Integer, top as Integer, width as Integer, height as Integer)
WindowsPreviewHandlerMBS.SetWindow(win as DesktopControl)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 23.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
e.g. use a Canvas to host the preview.
We query size of the container automatically to set the right size independent of the screen scaling.
See also:
- SetWindow(win as ContainerControl)
- SetWindow(win as ContainerControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as Control)
- SetWindow(win as Control, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopContainer)
- SetWindow(win as DesktopContainer, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopWindow)
- SetWindow(win as DesktopWindow, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as Window)
WindowsPreviewHandlerMBS.SetWindow(win as DesktopControl, left as integer, top as integer, width as integer, height as integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 22.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Coordinates in pixels.
See also:
- SetWindow(win as ContainerControl)
- SetWindow(win as ContainerControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as Control)
- SetWindow(win as Control, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopContainer)
- SetWindow(win as DesktopContainer, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopControl)
- SetWindow(win as DesktopWindow)
- SetWindow(win as DesktopWindow, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as Window)
WindowsPreviewHandlerMBS.SetWindow(win as DesktopWindow)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 23.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
We query size of the container automatically to set the right size independent of the screen scaling.
See also:
- SetWindow(win as ContainerControl)
- SetWindow(win as ContainerControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as Control)
- SetWindow(win as Control, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopContainer, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopControl)
- SetWindow(win as DesktopControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopWindow, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as Window)
- SetWindow(win as window, left as Integer, top as Integer, width as Integer, height as Integer)
WindowsPreviewHandlerMBS.SetWindow(win as DesktopWindow, left as integer, top as integer, width as integer, height as integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 22.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Pass the window and the area for the previewer.
Lasterror is set.
The preview handler is responsible for painting the entire area. If the previewer window has been created, the preview handler must associate the previewer window to the new parent hwnd and resize the previewer window to the area defined by the rectangle. If the previewer window has not yet been created, the preview handler must remember this information for when the previewer window is created in DoPreview.
It is preferred that this information be stored prior to calling DoPreview. Doing so increases performance at setup time for any cases where the preview does not start.
Coordinates in pixels.
See also:
- SetWindow(win as ContainerControl)
- SetWindow(win as ContainerControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as Control)
- SetWindow(win as Control, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopContainer)
- SetWindow(win as DesktopControl)
- SetWindow(win as DesktopControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopWindow)
- SetWindow(win as Window)
- SetWindow(win as window, left as Integer, top as Integer, width as Integer, height as Integer)
WindowsPreviewHandlerMBS.SetWindow(win as Window)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 23.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
We query size of the container automatically to set the right size independent of the screen scaling.
See also:
- SetWindow(win as ContainerControl)
- SetWindow(win as ContainerControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as Control)
- SetWindow(win as Control, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopContainer)
- SetWindow(win as DesktopControl)
- SetWindow(win as DesktopControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopWindow)
- SetWindow(win as DesktopWindow, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as window, left as Integer, top as Integer, width as Integer, height as Integer)
WindowsPreviewHandlerMBS.SetWindow(win as window, left as Integer, top as Integer, width as Integer, height as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 12.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Pass the window and the area for the previewer.
Lasterror is set.
The preview handler is responsible for painting the entire area. If the previewer window has been created, the preview handler must associate the previewer window to the new parent hwnd and resize the previewer window to the area defined by the rectangle. If the previewer window has not yet been created, the preview handler must remember this information for when the previewer window is created in DoPreview.
It is preferred that this information be stored prior to calling DoPreview. Doing so increases performance at setup time for any cases where the preview does not start.
Coordinates in pixels.
See also:
- SetWindow(win as ContainerControl)
- SetWindow(win as ContainerControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as Control)
- SetWindow(win as Control, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopContainer)
- SetWindow(win as DesktopControl)
- SetWindow(win as DesktopControl, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as DesktopWindow)
- SetWindow(win as DesktopWindow, left as integer, top as integer, width as integer, height as integer)
- SetWindow(win as Window)
WindowsPreviewHandlerMBS.Unload
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows | MBS Win Plugin | 12.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Lasterror is set.
When called, the preview window will be destroyed.
This method should be called only after Constructor has been called. All resources associated with this initialization will be released. Prior to calling DoPreview, this preview handler will be re-initialized with a call to one of the initialization interfaces and a call to SetWindow.
The items on this page are in the following plugins: MBS Win Plugin.
