Platforms to show: All Mac Windows Linux Cross-Platform

Back to WindowsPreviewHandlerMBS class.

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
Sets the background color of the preview handler.

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
Directs the preview handler to set focus to itself.

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
Sets the font attributes to be used for text within the preview handler.

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
Directs the preview handler to change the area within the parent hwnd that it draws into.

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
Sets the color of the text within the preview handler.

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
Sets the parent of the preview to be the container with it's size.

We query size of the container automatically to set the right size independent of the screen scaling.

See also:

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
Sets the parent to a container control.

Coordinates in pixels.

See also:

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
Sets the parent of the preview to be the control with it's size.

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:

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
Sets the parent to a control.

Coordinates in pixels.

See also:

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
Sets the parent of the preview to be the container with it's size.

We query size of the container automatically to set the right size independent of the screen scaling.

See also:

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
Sets the parent to a desktop container control.

Coordinates in pixels.

See also:

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
Sets the parent of the preview to be the control with it's size.

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:

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
Sets the parent to a desktop control.

Coordinates in pixels.

See also:

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
Sets the parent window of the previewer window.

We query size of the container automatically to set the right size independent of the screen scaling.

See also:

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
Sets the parent window of the previewer window, as well as the area within the parent to be used for the previewer window.

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:

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
Sets the parent window of the previewer window.

We query size of the container automatically to set the right size independent of the screen scaling.

See also:

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
Sets the parent window of the previewer window, as well as the area within the parent to be used for the previewer window.

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:

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


The biggest plugin in space...