Hide Table of Contents
DPDMDocManagerEvents_BeforeWritingToDocumentEventHandler Delegate (SolidWorks.Interop.swbrowser)

Handles the notification that the specified PDM-managed document is about to be written to.

.NET Syntax

Visual Basic (Declaration) 
Public Delegate Function DPDMDocManagerEvents_BeforeWritingToDocumentEventHandler( _
   ByVal fileName As System.String _
) As System.Integer
Visual Basic (Usage) 
Dim instance As New DPDMDocManagerEvents_BeforeWritingToDocumentEventHandler(AddressOf HandlerMethod)
C# 
public delegate System.int DPDMDocManagerEvents_BeforeWritingToDocumentEventHandler( 
   System.string fileName
)
C++/CLI 
public delegate System.int DPDMDocManagerEvents_BeforeWritingToDocumentEventHandler( 
&   System.String^ fileName
)

Parameters

fileName
Path and file name of document to which to write

Return Value

If 0 is returned without setting the document status, an error occurs. If 1 is returned, Toolbox uses the specified file name and proceeds as usual.

Example

See Getting Started for more information.

Remarks

Available only if you installed SOLIDWORKS Toolbox.

In the body of this handler, you can perform PDM document management functions such as:

  • Determine the availability of fileName in the SOLIDWORKS Toolbox.
  • Clear the read-only attribute of the PDM-managed document in preparation for writing.
  • Call IPDMDocManager::SetManagedDocument to direct the Toolbox Browser application to write to a different document, if the PDM-managed version is not writable.

Before returning from this handler, you must call IPDMDocManager::SetDocumentStatus with swPDMStatus_e.swPDMStatusKnownAndAvailable in order to not generate an error.

Availability

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

 
*Email:  
Subject:   Feedback on Help Topics
Page:   DPDMDocManagerEvents_BeforeWritingToDocumentEventHandler Delegate (SolidWorks.Interop.swbrowser)
*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) 2024 SP03

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.