Hide Table of Contents
GetDisplayTitleName Method (ISwDMDocument25)

Gets the display title name of this document.

.NET Syntax

Visual Basic (Declaration) 
Function GetDisplayTitleName() As System.String
Visual Basic (Usage) 
Dim instance As ISwDMDocument25
Dim value As System.String
 
value = instance.GetDisplayTitleName()
C# 
System.string GetDisplayTitleName()
C++/CLI 
System.String^ GetDisplayTitleName(); 

Return Value

Display title name

Example

'VB.NET

'----------------------------------------------------------------------------
' Preconditions:

' 1. Read the SOLIDWORKS Document Manager API Getting Started
'    topic and ensure that the required DLLs are registered.
'
' 2. Copy and paste this code into a VB.NET console application
'    in Microsoft Visual Studio.
'
' 3. Add the SolidWorks.Interop.swdocumentmgr.dll reference to the project:
'    a. Right-click the solution in Solution Explorer.
'    b. Click Add Reference.
'    c. Click Browse.
'    d. Click:
'       install_dir\api\redist\SolidWorks.Interop.swdocumentmgr.dll
'    e. Click Add.
'    f. Click Close.
'
' 4. Substitute model_path_and_filename with the path and filename of the model to open.
'
' 5. Substitute your_license_key with your SOLIDWORKS Document
'    Manager license key.
'
' 6. Open the Immediate window.
'
' Postconditions: Inspect the Immediate window.

'
' NOTE: If the model is used elsewhere, do not save changes.
'--------------------------------------------------------------------------

Imports SolidWorks.Interop.sldworks

Imports SolidWorks.Interop.swdocumentmgr

Imports SolidWorks.Interop.swconst

Imports System.Runtime.InteropServices

Imports System

Partial Class SolidWorksMacro

    Sub main()

        Dim swClassFact As SwDMClassFactory

        Dim swDocMgr As SwDMApplication

        Dim swDoc As SwDMDocument25

        Dim sLicenseKey As String

        sLicenseKey = "your_license_key"

        Dim sDocFileName As String

        sDocFileName = "model_path_and_filename"

        Dim nDocType As Integer

        nDocType = SwDmDocumentType.swDmDocumentPart

        swClassFact = New SwDMClassFactory

        swDocMgr = swClassFact.GetApplication(sLicenseKey)

        Dim retval As SwDmDocumentOpenError

        swDoc = swDocMgr.GetDocument(sDocFileName, nDocType, False, retval)

        Debug.Print("File = " + swDoc.FullName)

        Debug.Print("DisplayTitleName = " + swDoc.GetDisplayTitleName)

        swDoc.CloseDoc

    End Sub

    ''' <summary>

    ''' The SldWorks swApp variable is pre-assigned for you.

    ''' </summary>

    Public swApp As SldWorks

End Class

Example

 

See Also

Availability

SOLIDWORKS Document Manager API 2020 SP04


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:   GetDisplayTitleName Method (ISwDMDocument25)
*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) 2022 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.