| Revit 2020 API |
| LightGroupManager..::..IsLightOn Method |
| LightGroupManager Class See Also |
Returns true if the given light is on for rendering the given view
Namespace: Autodesk.Revit.DB.Lighting
Assembly: RevitAPI (in RevitAPI.dll) Version: 20.0.0.0 (20.0.0.377)
Since:
2013
Syntax
| C# |
|---|
public bool IsLightOn( ElementId viewId, ElementId lightId ) |
| Visual Basic |
|---|
Public Function IsLightOn ( _ viewId As ElementId, _ lightId As ElementId _ ) As Boolean |
| Visual C++ |
|---|
public: bool IsLightOn( ElementId^ viewId, ElementId^ lightId ) |
Parameters
- viewId
- Type: Autodesk.Revit.DB..::..ElementId
The Id of the view
- lightId
- Type: Autodesk.Revit.DB..::..ElementId
The Id of the light
Exceptions
| Exception | Condition |
|---|---|
| Autodesk.Revit.Exceptions..::..ArgumentException | The given element Id does not correspond to a 3d view -or- The given element Id does not correspond to a light instance |
| Autodesk.Revit.Exceptions..::..ArgumentNullException | A non-optional argument was NULL |