Hide Table of Contents

Insert and Show BOM Table and BOM Balloon Example (C#)

This example shows how to insert a bill of materials table and balloon in a drawing document.

//----------------------------------------------------------------------------
// Preconditions: Specified file to open and template exist.
//
// Postconditions:
// 1. An indented BOM table is inserted.
// 2. A BOM balloon annotation is inserted.
// 3. Inspect the Immediate Window for the name of the configuration used
//    to create the table, the type of numbering, and the name of the annotation.
//
// NOTE: Because this drawing document is used elsewhere,
// do not save any changes when closing the document.
//------------------------------------------------------------------
 
using SolidWorks.Interop.sldworks;
using SolidWorks.Interop.swconst;
using System.Runtime.InteropServices;
using System;
using System.Diagnostics;
 
namespace IViewInsertBomTable4CSharp.csproj
{
 
    partial class SolidWorksMacro
    {
 
 
        public void Main()
        {
            ModelDoc2 swModel = default(ModelDoc2);
            ModelDocExtension swModelDocExt = default(ModelDocExtension);
            DrawingDoc swDrawing = default(DrawingDoc);
            View swView = default(View);
            BomTableAnnotation swBOMAnnotation = default(BomTableAnnotation);
            BomFeature swBOMFeature = default(BomFeature);
            Note swNote = default(Note);
            BalloonOptions BomBalloonParams = default(BalloonOptions);
            bool boolstatus = false;
            int AnchorType = 0;
            int NbrType = 0;
            int BomType = 0;
            int nErrors = 0;
            int nWarnings = 0;
            string Configuration = null;
            string TableTemplate = null;
 
            swModel = (ModelDoc2)swApp.OpenDoc6("c:\\Program Files\\SolidWorks Corp\\SolidWorks\\samples\\tutorial\\advdrawings\\foodprocessor.slddrw", (int)swDocumentTypes_e.swDocDRAWING, (int)swOpenDocOptions_e.swOpenDocOptions_Silent, ""ref nErrors, ref nWarnings);
            swDrawing = (DrawingDoc)swModel;
            swModelDocExt = (ModelDocExtension)swModel.Extension;
            boolstatus = swDrawing.ActivateView("Drawing View1");
            swView = (View)swDrawing.ActiveDrawingView;
 
            // Insert indented BOM table
            AnchorType = (int)swBOMConfigurationAnchorType_e.swBOMConfigurationAnchor_TopLeft;
            BomType = (int)swBomType_e.swBomType_Indented;
            NbrType = (int)swNumberingType_e.swNumberingType_Detailed;
            TableTemplate = "C:\\Program Files\\SolidWorks Corp\\SolidWorks\\lang\\english\\bom-standard.sldbomtbt";
            Configuration = "";
            swBOMAnnotation = (BomTableAnnotation)swView.InsertBomTable4(false, 0.4, 0.3, AnchorType, BomType, Configuration, TableTemplate, false, NbrType, true);
            swBOMFeature = (BomFeature)swBOMAnnotation.BomFeature;
 
            Debug.Print("Type of BOM table as defined in swBomType_e: " + (int)swBOMFeature.TableType);
	   Debug.Print("Numbering type of BOM table as defined in swNumberingType_e: " + (int)swBOMFeature.NumberingTypeOnIndentedBOM);
            Debug.Print("Value to display when a value is 0 as defined in swZeroQuantityDisplay_e: " + (int)swBOMFeature.ZeroQuantityDisplay);
 
            // Print the name of the configuration used for the BOM table
            Debug.Print("Name of configuration used for BOM table: " + swBOMFeature.Configuration);
	   Debug.Print("Display as one item? " + swBOMFeature.DisplayAsOneItem);
	   Debug.Print("Strikeout missing items? " + swBOMFeature.StrikeoutMissingItems);
	   Debug.Print("Sequence start number: " + swBOMFeature.SequenceStartNumber);
	   Debug.Print("Keep missing items? " + swBOMFeature.KeepMissingItems);
	   Debug.Print("Keep current item numbers? " + swBOMFeature.KeepCurrentItemNumbers);
 
            boolstatus = swModelDocExt.SelectByID2("""EDGE", 0.1205506330468, 0.261655309417, -0.0004000000000133, false, 0, null, 0);
 
 
            BomBalloonParams = swModelDocExt.CreateBalloonOptions();
            BomBalloonParams.Style = (int)swBalloonStyle_e.swBS_Circular;
            BomBalloonParams.Size = (int)swBalloonFit_e.swBF_2Chars;
            BomBalloonParams.UpperTextContent = (int)swBalloonTextContent_e.swBalloonTextItemNumber;
            BomBalloonParams.UpperText = "";
            BomBalloonParams.ShowQuantity = true;
            BomBalloonParams.QuantityPlacement = (int)swBalloonQuantityPlacement_e.swBalloonQuantityPlacement_Right;
            BomBalloonParams.QuantityDenotationText = "PLACES";
            BomBalloonParams.QuantityOverride = false;
            BomBalloonParams.QuantityOverrideValue = "";
            BomBalloonParams.ItemNumberStart = 1;
            BomBalloonParams.ItemNumberIncrement = 1;
            BomBalloonParams.ItemOrder = (int)swBalloonItemNumbersOrder_e.swBalloonItemNumbers_DoNotChangeItemNumbers;
 
 
            swNote = (Note)swModelDocExt.InsertBOMBalloon2(BomBalloonParams);
 
 
            // Get whether balloon is a BOM balloon
            // If so, print the name of the BOM balloon
 
            if (swNote.IsBomBalloon())
            {
                Debug.Print("Name of BOM balloon: " + swNote.GetName());
            }
 
            swDrawing.ForceRebuild();
 
        }
 
 
        /// <summary>
        /// The SldWorks swApp variable is pre-assigned for you.
        /// </summary>
 
        public SldWorks swApp;
 
    }
}


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:   Insert and Show BOM Table and BOM Balloon Example (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) 2014 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.