Hide Table of Contents
GetDisplayTitleName Method (ISwDMDocument25)

Gets the display 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 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. Select Add Reference
'    c. Click Browse.
'    d. Click install_dir\api\redist\SolidWorks.Interop.swdocumentmgr.dll.
'    e. Click Add.
'    f. Click Close.

' 4. Ensure that sLicenseKey and sDocFileName point to valid strings.

' 5. Open an Immediate window.

' 6. Press F5.

'

' Postconditions:

' 1. Inspect the Immediate window.

' 2. Press F5.

' 3. Repeat steps 1 and 2 until the end.

' 4. The display title name of the document is changed to "TestValue".

'===================================================

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 = "doc_file_name"

        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)

        Stop

        Dim str As String

        Dim va As Object

        str = "TestValue"

        va = str

        Dim swdmhotfix As ISwDMHotfix

        swdmhotfix = swDoc

        Dim error_code As Integer

        'Set the display title name with CmdID = 9995

        error_code = swdmhotfix.Command(9995, va)

        Debug.Print("Set is complete:")

        Stop

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

        error_code = swDoc.Save

        swDoc.CloseDoc

    End Sub

    ''' <summary>

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

    ''' </summary>

    Public swApp As SldWorks

End Class

Example

Remarks

To set the display title name, you can use ISwDMHotfix::Command with Command ID 9995. Contact SOLIDWORKS API Support for more information.
 

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) 2020 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.