Hide Table of Contents
AddLightSource Method (IModelDoc2)

Adds a type of light source to a scene with the specified names.

.NET Syntax

Visual Basic (Declaration) 
Function AddLightSource( _
   ByVal IdName As System.String, _
   ByVal LTyp As System.Integer, _
   ByVal UserName As System.String _
) As System.Boolean
Visual Basic (Usage) 
Dim instance As IModelDoc2
Dim IdName As System.String
Dim LTyp As System.Integer
Dim UserName As System.String
Dim value As System.Boolean
value = instance.AddLightSource(IdName, LTyp, UserName)
System.bool AddLightSource( 
   System.string IdName,
   System.int LTyp,
   System.string UserName
System.bool AddLightSource( 
&   System.String^ IdName,
&   System.int LTyp,
&   System.String^ UserName



New light source ID name


New light source type:

  • 1 = Ambient light

  • 2 = Spot light

  • 3 = Point light

  • 4 = Directional light


New light source user name

Return Value

True if the light source creation was successful, false if not; for example, creation of a light source fails if IdName is not unique within this model



See Also


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

Subject:   Feedback on Help Topics
Page:   AddLightSource Method (IModelDoc2)
*   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:


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

Web Help Content Version: API Help (English only) 2016 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.