Hide Table of Contents
OnPreviewRequested Method (IRenderCallbackHandler)

Requests a preview image of the specified size from the rendering engine during an ongoing asynchronous render.

.NET Syntax

Visual Basic (Declaration) 
Sub OnPreviewRequested( _
   ByVal width As System.Integer, _
   ByVal height As System.Integer _
)
Visual Basic (Usage) 
Dim instance As IRenderCallbackHandler
Dim width As System.Integer
Dim height As System.Integer
 
instance.OnPreviewRequested(width, height)
C# 
void OnPreviewRequested( 
   System.int width,
   System.int height
)
C++/CLI 
void OnPreviewRequested( 
&   System.int width,
&   System.int height
)

Parameters

width
Width in pixels of the preview image
height
Height in pixels of the preview image

Remarks

The rendering engine responds by invoking IRenderNotificationHandler2::RendererPropertyChangedNotify with the updated preveiw image included in the status.

Both image size and the frequency at which preview images are requested may negatively impact overall rendering performance. Use sparingly to avoid delays or degraded output quality.

 

See Also

Availability

SOLIDWORKS Visualize Add-in API 2026 FCS


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   OnPreviewRequested Method (IRenderCallbackHandler)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2026 PR1

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.

10.20.6