Get Display Title Name (C#)

This example shows how to get the display title name of a document. Consult with SOLIDWORKS API Support to learn how to set the display title name using ISwDMHotfix::Command.

// =================================================

// 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 C# 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".

// ===================================================

using System;

using System.Collections.Generic;

using System.Diagnostics;

using System.Globalization;

using System.IO;

using System.Linq;

using System.Reflection;

using System.Runtime.CompilerServices;

using System.Security;

using System.Text;

using System.Threading.Tasks;

using Microsoft.VisualBasic;

using SolidWorks.Interop.sldworks;

using SolidWorks.Interop.swdocumentmgr;

using SolidWorks.Interop.swconst;

using System.Runtime.InteropServices;

partial class SolidWorksMacro

{

    public void main()

    {

        SwDMClassFactory swClassFact;

        SwDMApplication swDocMgr;

        SwDMDocument25 swDoc;

        string sLicenseKey;

        sLicenseKey = "your_license_key";

        string sDocFileName;

        sDocFileName = "doc_file_name";

        int nDocType;

        nDocType = SwDmDocumentType.swDmDocumentPart;

        swClassFact = new SwDMClassFactory();

        swDocMgr = swClassFact.GetApplication(sLicenseKey);

        SwDmDocumentOpenError retval;

        swDoc = swDocMgr.GetDocument(sDocFileName, nDocType, false, retval);

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

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

        System.Diagnostics.Debugger.Break(); 

        string str;

        object va;

        str = "TestValue";

        va = str;

        ISwDMHotfix swdmhotfix;

        swdmhotfix = swDoc;

        int error_code;

        // Set the display title name with CmdID = 9995

        error_code = swdmhotfix.Command(9995, va);

        Debug.Print("Set is complete:");

        System.Diagnostics.Debugger.Break();

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

        error_code = swDoc.Save;

        swDoc.CloseDoc();

    }

    /// <summary>

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

    ///     ''' </summary>

    public SldWorks swApp;

}