Close Method

Description

Closes the referenced object.

Syntax

Visual Basic
Public Sub Close( _ Optional ByVal SaveChanges As Variant, _ Optional ByVal FileName As Variant, _ Optional ByVal RouteWorkbook As Variant _ )

Parameters

SaveChanges: If there are no changes to the document, this argument is ignored. If there are changes to the document and other associated windows are open, this argument is ignored, and the user is prompted for saving the changes.
FileName: Specifies the file name to which changes are to be saved. If this argument is not specified and the document has changed, the GetSaveAsFilename method is called.
RouteWorkbook: If the referenced object does not need to be routed to the next recipient (that is, it has no routing slip or has already been routed), this argument is ignored. Otherwise, if this argument is True, the document is routed to all recipients or to the next recipient based on the setting in the routing slip. If this argument is False, the document is not routed. If the argument is omitted, a dialog box is displayed.

Remarks

This method closes the specified document and removes the object from the collection. Any associated windows are also closed. The method returns True on success and False on failure.

Example

Example (Visual Basic)

Private Sub Form_Load()
    Dim objApp As SolidEdgeFramework.Application
    Dim objDoc As SolidEdgePart.PartDocument
    Const TESTFILE = "T:\vbtests\testcases\chead.par"
    Const SAVEFILE = "T:\vbtests\TestCases\temp.par"
    ' Report errors
    Const PI = 3.14159265358979
    ' Create/get the application with specific settings
    On Error Resume Next
    Set objApp = GetObject(, "SolidEdge.Application")
    If Err Then
        Err.Clear
        Set objApp = CreateObject("SolidEdge.Application")
        Set objDoc = objApp.Documents.Add("SolidEdge.PartDocument")
        objApp.Visible = True
    Else
        Set objDoc = objApp.ActiveDocument
    End If
    Call objDoc.Close
    ' opening the test case file
    Set objDoc = objApp.Documents.Open(TESTFILE)
    ' Using Close property without any of the arguments
    Call objDoc.Close
    If objApp.Documents.Count <> 0 Then
        MsgBox "Unable to close the document without using any arguments"
    End If
    ' Using Close property with saving it to a filename
    Set objDoc = objApp.Documents.Add(progID:="SolidEdge.PartDocument", TemplateDoc:="normal.par")
    Call objDoc.RefPlanes.AddParallelByDistance(parentplane:=objDoc.RefPlanes(1), normalside:=igRight, distance:=0.05)
    Call objDoc.Close(SaveChanges:=True, Filename:=SAVEFILE)
    If objApp.Documents.Count <> 0 Then
        MsgBox "Unable to close the document with changes"
    End If
    ' USER DISPLAY
    ' Release objects
    Set objApp = Nothing
    Set objDoc = Nothing
End Sub