Namespace: Autodesk.Revit.DB.Lighting Class: LightGroupManager

LightGroupManager.SetLightOn

Method

Description:
Turns the given light on or off for rendering the given view depending on the bool argument

Syntax

public void SetLightOn(
	ElementId viewId,
	ElementId lightId,
	bool turnOn
)

Public Sub SetLightOn ( 
	viewId As ElementId,
	lightId As ElementId,
	turnOn As Boolean
)

public:
void SetLightOn(
	ElementId^ viewId, 
	ElementId^ lightId, 
	bool turnOn
)

member SetLightOn : 
        viewId : ElementId * 
        lightId : ElementId * 
        turnOn : bool -> unit

Parameters

Parameter	Type	Description
viewId	ElementId	The Id of the view
lightId	ElementId	The Id of the light to turn on or off
turnOn	Boolean	Turns the light on if true, off if false

Return Value

Exceptions

Exception	Condition
ArgumentException	The given element Id does not correspond to a 3d view -or- The given element Id does not correspond to a light instance
ArgumentNullException	A non-optional argument was null