Hide Table of Contents
BackgroundProcessingOption Property (IDrawingDoc)

Gets or sets the background processing option for this drawing.

.NET Syntax

Visual Basic (Declaration) 
Property BackgroundProcessingOption As System.Integer
Visual Basic (Usage) 
Dim instance As IDrawingDoc
Dim value As System.Integer
instance.BackgroundProcessingOption = value
value = instance.BackgroundProcessingOption
System.int BackgroundProcessingOption {get; set;}
property System.int BackgroundProcessingOption {
   System.int get();
   void set ( &   System.int value);

Property Value

Background processing option as defined in swBackgroundProcessOption_e (see Remarks)



SOLIDWORKS recommends that you only use this property with ISldWorks::IsBackgroundProcessingCompleted and ISldWorks::EnableBackgroundProcessing when you can quickly open a drawing document via the user interface, but that same drawing takes significantly more time to open programmatically.

To more efficiently and programmatically open a drawing document that requires a lot of CPU time and no user input:

  1. Set ISldWorks::EnableBackgroundProcessing to true.
  2. Use ISldWorks Event BackgroundProcessingStartNotify to handle the background processing start event.
  3. Open the drawing document by calling either ISldWorks::OpenDoc6 or ISldWorks::OpenDoc7.
  4. Set IDrawingDoc::BackgroundProcessingOption to swBackgroundProcessOption_e.swBackgroundProcessing_DeferToApplication.
  5. Call ISldWorks::IsBackgroundProcessingCompleted repeatedly, which polls the status of the open operation
  6. Use ISldWorks Event BackgroundProcessingEndNotify to handle the background processing end event.
  7. When the open operation is finished, set ISldWorks::EnableBackgroundProcessing to false.

See Also


SOLIDWORKS 2013 FCS, Revision Number 21.0

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

Subject:   Feedback on Help Topics
Page:   BackgroundProcessingOption Property (IDrawingDoc)
*   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:


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

Web Help Content Version: API Help (English only) 2015 SP05

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.