Hide Table of Contents
AddFileOpenItem3 Method (ISldWorks)

Adds file types to the SOLIDWORKS File Open dialog box.

.NET Syntax

Visual Basic (Declaration) 
Function AddFileOpenItem3( _
   ByVal Cookie As System.Integer, _
   ByVal MethodName As System.String, _
   ByVal Description As System.String, _
   ByVal Extension As System.String, _
   ByVal OptionLabel As System.String, _
   ByVal OptionMethodName As System.String _
) As System.Boolean
Visual Basic (Usage) 
Dim instance As ISldWorks
Dim Cookie As System.Integer
Dim MethodName As System.String
Dim Description As System.String
Dim Extension As System.String
Dim OptionLabel As System.String
Dim OptionMethodName As System.String
Dim value As System.Boolean
 
value = instance.AddFileOpenItem3(Cookie, MethodName, Description, Extension, OptionLabel, OptionMethodName)
C# 
System.bool AddFileOpenItem3( 
   System.int Cookie,
   System.string MethodName,
   System.string Description,
   System.string Extension,
   System.string OptionLabel,
   System.string OptionMethodName
)
C++/CLI 
System.bool AddFileOpenItem3( 
&   System.int Cookie,
&   System.String^ MethodName,
&   System.String^ Description,
&   System.String^ Extension,
&   System.String^ OptionLabel,
&   System.String^ OptionMethodName
) 

Parameters

Cookie

Cookie specified in ISwAddin::ConnectToSW

MethodName

Name of the application function used to open the file

Description

File description displayed in the Files of Type menu

Extension

File extensions separated by semicolons

OptionLabel

Label for your options button or an empty string

OptionMethodName

Name of the callback method to display your dialog, which appears when a user clicks your options button, or an empty string

Return Value

True if the item was added, false if not

Example

Adds a file type xyz:

Private Function SwAddin_ConnectToSW(ByVal ThisSW As Object, ByVal Cookie As Long) As Boolean

    ...

    bWasAdded = pSldWorks.AddFileSaveAsItem2(swCookie, "Test_Callback", "Save As file type", "xyz", 1)

    

    bWasAdded = pSldWorks.AddFileOpenItem3(swCookie, "Test_Callback", "Open File type", "xyz", "", "")

    ...

End Function

Private Function SwAddin_DisconnectFromSW() As Boolean

    ...

    

    bWasItemRemoved = pSldWorks.RemoveFileSaveAsItem2(swCookie, "Test_Callback", "Save As file type", "xyz", 1)

    bWasItemRemoved = pSldWorks.RemoveFileOpenItem2(swCookie, "Test_Callback", "Open File type", "xyz")

    ...

End Function

 

Public Sub Test_CallBack(Filename As String)

    pSldWorks.SendMsgToUser "Callback called with filename = " & Filename End Sub

 

Adds and removes multiple file types:

...

bRet = iSwApp.AddFileOpenItem3(addinID, "Test_Callback", "Open My File Type (*.ext1;*.ext2"), "ext1;ext2", "", "")

...

bRet = iSwApp.RemoveFileOpenItem2(addinID, "Test_Callback", "Open My File Type (*.ext1;*.ext2)", "ext1;ext2")

...

 

Example

Remarks

If your application is unloaded using an add-in, then you must remove any file types added with this method. See ISldWorks::RemoveFileOpenItem2

The callback is called one time if the user:

  • Presses the Shift or Ctrl key and selects multiple files to open in the File Open Dialog.
  • drags-and-drops files into SOLIDWORKS from Windows Explorer or the File Explorer tab in the TaskPane.
 

See Also

Availability

SOLIDWORKS 2007 FCS, Revision Number 15.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:   AddFileOpenItem3 Method (ISldWorks)
*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) 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.