Hide Table of Contents

Get Drawing Sheets' Properties (C#)

This example shows how to get the properties of a drawing's sheets.

//----------------------------------------------------------------------
// Preconditions:
// 1. Read the SolidWorks Document Manager API Getting Started topic
//    and ensure that the required DLLs are registered.
// 2. Start SolidWorks, open a new C# macro, and replace the code
//    in the SwMacro - SolidWorks Visual Studio Tools for Applications
//    code window with the code in this example.
// 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 the Browse tab.
//    d. Select:
//       install_dir\api\redist\SolidWorks.Interop.swdocumentmgr.dll
// 4. Ensure that the specified drawing document exists.
// 5. Open the Immediate window.
// 6. Substitute "your_license_key" with your SolidWorks Document
//    Manager license key.
// 7. Run the macro.
//
// Postconditions:
// 1. The drawing sheet properties are printed to the Immediate Window.
// 2. Examine the Immediate window.
//----------------------------------------------------------------------

using SolidWorks.Interop.sldworks;
using SolidWorks.Interop.swconst;
using SolidWorks.Interop.swdocumentmgr;
using System;
using SolidWorks.Interop;
using System.Diagnostics;

namespace GetDrawingPropertiesCSharp.csproj
{
    
partial class SolidWorksMacro
    {
        
public void Main()
        {
            SwDMClassFactory swClassFact;
            SwDMApplication docMgrApp;
            SwDMDocument13 docDrw;
            SwDmDocumentOpenError res;

            swClassFact =
new SwDMClassFactory();
            docMgrApp = (SwDMApplication)swClassFact.GetApplication(
"your_license_key");
            
string sDocFileName;
            sDocFileName =
"C:\\Program Files\\SolidWorks Corp\\SolidWorks\\samples\\tutorial\\advdrawings\\foodprocessor.slddrw";
            docDrw = (SwDMDocument13)docMgrApp.GetDocument(sDocFileName, SwDmDocumentType.swDmDocumentDrawing,
true, out res);
            
string[] sheetNameVar;
            
int sheetCount;

            sheetCount = docDrw.GetSheetCount();
            sheetNameVar = (
string[])docDrw.GetSheetNames();

            
string sheetName;
            
int sheetNameCount;
            
for (sheetNameCount = 0; sheetNameCount <= sheetNameVar.Length - 1; sheetNameCount++)
            {
                
string formatName;
                swSheetFormatPathResult status1;
                sheetName = sheetNameVar[sheetNameCount];
                status1 = (swSheetFormatPathResult)docDrw.GetSheetFormatPath(sheetName,
out formatName);

                
Debug.Print(sheetName + " ---- " + formatName + "\n");

                swSheetPropertiesResult status2;
                
object formatPropObj;

                status2 = (swSheetPropertiesResult)docDrw.GetSheetProperties(sheetName,
out formatPropObj);

                
double[] formatProp = (double[])formatPropObj;

                
double para;
                para = System.
Math.Round(formatProp[0]);

                
string paperSize;

                GetPaperSize(para,
out paperSize);

                
Debug.Print("Paper Size = " + paperSize);
                
Debug.Print("Size = " + formatProp[1] + " x " + formatProp[2]);
                
Debug.Print("Scale = " + formatProp[3] + " : " + formatProp[4]);

                
bool boolData;

                boolData =
false;

                
if ((formatProp[5] == 1))
                {
                    boolData =
true;
                }

                
Debug.Print("First angle = " + boolData);
                
string templateSize;
                para = System.
Math.Round(formatProp[6]);
                GetTemplateSize(para,
out templateSize);
                
Debug.Print("Template size = " + templateSize);
                boolData =
false;

                
if ((formatProp[7] == 1))
                {
                    boolData =
true;
                }

                
Debug.Print("Template visible = " + boolData);
                
Debug.Print("===========================================");
            }
            docDrw.CloseDoc();
        }
        
/// <summary>
        /// The SldWorks swApp variable is pre-assigned for you.
        /// </summary>
        public SldWorks swApp;

        #region Helper Functions

        
public void GetPaperSize(double inpNum, out string outPaperType)
        {
            
if ((inpNum == 0))
            {
                outPaperType =
"swDwgPaperAsize";
            }
            
else if ((inpNum == 1))
            {
                outPaperType =
"swDwgPaperAsizeVertical";
            }
            
else if ((inpNum == 2))
            {
                outPaperType =
"swDwgPaperBsize";
            }
            
else if ((inpNum == 3))
            {
                outPaperType =
"swDwgPaperCsize";
            }
            
else if ((inpNum == 4))
            {
                outPaperType =
"swDwgPaperDsize";
            }
            
else if ((inpNum == 5))
            {
                outPaperType =
"swDwgPaperEsize";
            }
            
else if ((inpNum == 6))
            {
                outPaperType =
"swDwgPaperA4size";
            }
            
else if ((inpNum == 7))
            {
                outPaperType =
"swDwgPaperA4sizeVertical";
            }
            
else if ((inpNum == 8))
            {
                outPaperType =
"swDwgPaperA3size";
            }
            
else if ((inpNum == 9))
            {
                outPaperType =
"swDwgPaperA2size";
            }
            
else if ((inpNum == 10))
            {
                outPaperType =
"swDwgPaperA1size";
            }
            
else if ((inpNum == 11))
            {
                outPaperType =
"swDwgPaperA0size";
            }
            
else
            {
                outPaperType =
"swDwgPapersUserDefined";
            }
        }


        
public void GetTemplateSize(double inpNum, out string outTemplateType)
        {
            
if ((inpNum == 0))
            {
                outTemplateType =
"swDwgTemplateAsize";
            }
            
else if ((inpNum == 1))
            {
                outTemplateType =
"swDwgTemplateAsizeVertical";
            }
            
else if ((inpNum == 2))
            {
                outTemplateType =
"swDwgTemplateBsize";
            }
            
else if ((inpNum == 3))
            {
                outTemplateType =
"swDwgTemplateCsize";
            }
            
else if ((inpNum == 4))
            {
                outTemplateType =
"swDwgTemplateDsize";
            }
            
else if ((inpNum == 5))
            {
                outTemplateType =
"swDwgTemplateEsize";
            }
            
else if ((inpNum == 6))
            {
                outTemplateType =
"swDwgTemplateA4size";
            }
            
else if ((inpNum == 7))
            {
                outTemplateType =
"swDwgTemplateA4sizeVertical";
            }
            
else if ((inpNum == 8))
            {
                outTemplateType =
"swDwgTemplateA3size";
            }
            
else if ((inpNum == 9))
            {
                outTemplateType =
"swDwgTemplateA2size";
            }
            
else if ((inpNum == 10))
            {
                outTemplateType =
"swDwgTemplateA1size";
            }
            
else if ((inpNum == 11))
            {
                outTemplateType =
"swDwgTemplateA0size";
            }
            
else if ((inpNum == 12))
            {
                outTemplateType =
"swDwgTemplateCustom";
            }
            
else
            {
                outTemplateType =
"swDwgTemplateNone";
            }
        }

        #endregion

    }

}



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 Drawing Sheets Properties (C#)
*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) 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.