Hide Table of Contents
AddComponent5 Method (IAssemblyDoc)

Adds the specified component for the specified configuration options to this assembly.

.NET Syntax

Visual Basic (Declaration) 
Function AddComponent5( _
   ByVal CompName As String, _
   ByVal ConfigOption As Integer, _
   ByVal NewConfigName As String, _
   ByVal UseConfigForPartReferences As Boolean, _
   ByVal ExistingConfigName As String, _
   ByVal X As Double, _
   ByVal Y As Double, _
   ByVal Z As Double _
) As Component2
Visual Basic (Usage) 
Dim instance As IAssemblyDoc
Dim CompName As String
Dim ConfigOption As Integer
Dim NewConfigName As String
Dim UseConfigForPartReferences As Boolean
Dim ExistingConfigName As String
Dim X As Double
Dim Y As Double
Dim Z As Double
Dim value As Component2
 
value = instance.AddComponent5(CompName, ConfigOption, NewConfigName, UseConfigForPartReferences, ExistingConfigName, X, Y, Z)
C# 
Component2 AddComponent5( 
   string CompName,
   int ConfigOption,
   string NewConfigName,
   bool UseConfigForPartReferences,
   string ExistingConfigName,
   double X,
   double Y,
   double Z
)
C++/CLI 
Component2^ AddComponent5( 
&   String^ CompName,
&   int ConfigOption,
&   String^ NewConfigName,
&   bool UseConfigForPartReferences,
&   String^ ExistingConfigName,
&   double X,
&   double Y,
&   double Z
) 

Parameters

CompName
Path name of a pre-loaded part or assembly to add as a component (see Remarks)
ConfigOption

Mode in which to open the document as specified in swAddComponentConfigOptions_e

NewConfigName
Name for the new assembly configuration; valid only if ConfigOption = swAddComponentConfigOptions_e.swAddComponentConfigOptions_NewConfigWithAllReferenceModels or swAddComponentConfigOptions_e.swAddComponentConfigOptions_NewConfigWithAsmStructure
UseConfigForPartReferences
If true, the configuration specified in ExistingConfigName is used
ExistingConfigName

Name of the configuration of the loaded component; valid only if UseConfigForPartReferences = true

X
X coordinate of the component center
Y
Y coordinate of the component center
Z
Z coordinate of the component center

Return Value

IComponent2

Example

Remarks

The specified file must be loaded in memory. A file is loaded into memory when you load the file in your SolidWorks session (ISldWorks::OpenDoc6) or open an assembly that already contains the file.

If you want to add the component at a position relative to the root component, use IComponent2::Transform2 to reposition the component immediately after calling this method. Or, you can use IAssemblyDoc::AddComponents or IAssemblyDoc::AddComponents2 to specify the transform when inserting a component, insert as many components as you want at once, and rotate and scale the component through the transform matrix.

IMPORTANT: The x, y, and z parameters of this method are relative to the bounding box of the component. Only use this method if you want to approximately position the component. Use IComponent2::Transform2 if you want to more precisely position the component.

 

See Also

Availability

SolidWorks 2010 FCS, Revision Number 18.0


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:   AddComponent5 Method (IAssemblyDoc)
*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) 2010 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.