> Get Hyperlinks Example (C#)
Welcome
Getting Started
SolidWorks API Help
FeatureWorks API Help
SolidWorks Document Manager API Help
eDrawings API Help
SolidWorks Routing API Help
SolidWorks Simulation API Help
SolidWorks Utilities API Help
SolidWorks Workgroup PDM API Help
Hide Table of Contents Show Table of Contents

Get Hyperlinks Example (C#)

This example shows how to get the hyperlinks for a SolidWorks document using the SolidWorks Document Manager API.

//---------------------------------------------------------------------------
// Preconditions:
// 1. Read the SolidWorks Document Manager API
//    Getting Started topicand ensure that
//   
the required DLLs have been registered.
// 2. Copy and paste this module into a C#
//    console application in Microsoft Visual Studio.
// 3. Ensure that the specified document exists
//    (or point to a document that contains hyperlinks).
// 4. Add the SolidWorks.Interop.swdocumentmgr.dll
//    reference to the project:
//    a. Right-click the solution in
//       Solution Explorer.
//    b. Select Add Reference.
//    c. Click the Browse tab.
//    d. Load:

//  <SolidWorks_install_dir>\api\redist\SolidWorks.Interop.swdocumentmgr.dll
// 5. Substitute <your_license_code> with your
//    SolidWorks Document Manager license key.
// 6. Compile and run this program in Debug mode.
//
// Postconditions: Inspect the Output window and the
//
code to see how the API is used.
//--------------------------------------------------------------------------

using System;
using System.Diagnostics;
using System.Collections.Generic;
using System.Text;
using SolidWorks.Interop.swdocumentmgr;
class Program
{
    
    
public static void ProcessDocHyperlinks(SwDMDocument swDoc)
    {
        
int i = 0;
        
Debug.Print(" Hyperlinks:");
        
        
for (i = 0; i <= swDoc.GetHyperLinksCount() - 1; i++) {
            
Debug.Print(" " + swDoc.GetHyperLinkAt(i));
        }
        
        
Debug.Print("");
    }
    
    
static void Main(string[] args)
    {
        
        
const string sLicenseKey = "your_license_code>";
        
//Specify your license key
        const string sDocFileName = "C:\\Program Files\\SolidWorks Corp\\SolidWorks\\samples\\tutorial\\EDraw\\claw\\claw-mechanism.sldasm";
        
        
SwDMClassFactory swClassFact = default(SwDMClassFactory);
        
SwDMApplication swDocMgr = default(SwDMApplication);
        
SwDMDocument swDoc = default(SwDMDocument);
        
SwDMConfigurationMgr swCfgMgr = default(SwDMConfigurationMgr);
        
SwDmDocumentType nDocType = 0;
        
SwDmDocumentOpenError nRetVal = 0;

        
// Determine type of SolidWorks file based on file extension

        if (sDocFileName.EndsWith("sldprt"))
        {
            nDocType =
SwDmDocumentType.swDmDocumentPart;
        }
        
else if (sDocFileName.EndsWith("sldasm"))
        {
            nDocType =
SwDmDocumentType.swDmDocumentAssembly;
        }
        
else if (sDocFileName.EndsWith("slddrw"))
        {
            nDocType =
SwDmDocumentType.swDmDocumentDrawing;
        }
        
else
        {
            
// Not a SolidWorks file
            nDocType = SwDmDocumentType.swDmDocumentUnknown;

            
// So cannot open
            return;
        }

        
        swClassFact =
new SwDMClassFactory();
        swDocMgr = swClassFact.GetApplication(sLicenseKey);
        swDoc = (
SwDMDocument)swDocMgr.GetDocument(sDocFileName, nDocType, false, out nRetVal);
        
Debug.Assert(SwDmDocumentOpenError.swDmDocumentOpenErrorNone == nRetVal);
        swCfgMgr = swDoc.ConfigurationManager;
        
        
Debug.Print("File = "
+ swDoc.FullName);
          
        ProcessDocHyperlinks(swDoc);
    }
}



Related SolidWorks Forum Content

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:   Get Hyperlinks Example (C#)
*Comment:  
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) 2012 SP05

The search functionality within the web help is in a beta test phase and you may experience periodic delays or interruptions in its performance. These are the normal and ordinary features of a beta test and shall not under any circumstances give rise to any liability on the part of DS SolidWorks or its licensors. The topics within the Web-based help are not beta topics; they document API Help (English only) 2012 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.