Hide Table of Contents
IGetModelDoc Method (IComponent2)

Obsolete. Superseded by IComponent2::GetModelDoc2.

.NET Syntax

Visual Basic (Declaration) 
Function IGetModelDoc() As ModelDoc2
Visual Basic (Usage) 
Dim instance As IComponent2
Dim value As ModelDoc2
 
value = instance.IGetModelDoc()
C# 
ModelDoc2 IGetModelDoc()
C++/CLI 
ModelDoc2^ IGetModelDoc(); 

Return Value

Pointer to the model document

Remarks

This method might return NULL if:

  • a component is suppressed or lightweight.
  • the component ID is not loaded into memory by SolidWorks.

For more information on lightweight components, see Work With Lightweight Components.

When you use the IModelDoc2 object of a component, you do not have access to whatever uniqueness might exist for this instance of the assembly IComponent2. This occurs because the IModelDoc2 object goes back to the saved part file. By comparison, the IComponent2 object gathers information at the assembly level. This allows IComponent2 objects to recognize assembly-level changes made to a component instance (for example, assembly-level features and material changes).

In addition, the IModelDoc2 object returned from this method represents the last-saved state. If the component part is currently open, then the IModelDoc2 object represents the state of the opened document. For example, if the component part is not open and it was last saved in the default configuration, then IComponent2::GetModelDoc
returns a IModelDoc2 pointer representing that state. To get access to other configuration information (such as features and configuration properties), you must activate the part and show the desired configuration using IModelDoc2::ShowConfiguration2.

If this component is the root component, then this method returns a NULL pointer. For more information, see IConfiguration::IGetRootComponent2.

 

See Also

Availability

SolidWorks 2001Plus FCS, Revision Number 10.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:   IGetModelDoc Method (IComponent2)
*Comment:  

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

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 Dassault Systèmes SolidWorks Corporation or its licensors. The topics within the Web-based help are not beta topics; they document 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.