LightFamily

Description:
This class encapsulates light family information.

Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.Lighting.LightFamily

public class LightFamily : IDisposable

Public Class LightFamily _
	Implements IDisposable

public ref class LightFamily : IDisposable

public void GetLightDataInFamilyDocument(Document familyDoc)
{
    // LightFamily API should work only in light fixture family document.
    if (familyDoc.OwnerFamily.FamilyCategory.Id.IntegerValue == (int)BuiltInCategory.OST_LightingFixtures)
        return;

    // Get the light family from the static method.
    LightFamily lightFamily = LightFamily.GetLightFamily(familyDoc);

    // Get the light source shape style and distribution style
    LightShapeStyle shapeStyle = lightFamily.GetLightShapeStyle();
    LightDistributionStyle distributionStyle = lightFamily.GetLightDistributionStyle();

    // Get the light photometric for each family type
    for (int index = 0; index < lightFamily.GetNumberOfLightTypes(); index++)
    {
        string typeName = lightFamily.GetLightTypeName(index);  // the type name
        LightType lightData = lightFamily.GetLightType(index);  // the light data for each type
        // How to get and set data in LightType object, please read help document for LightType class.
    }
}

Public Sub GetLightDataInFamilyDocument(familyDoc As Document)
   ' LightFamily API should work only in light fixture family document.
   If familyDoc.OwnerFamily.FamilyCategory.Id.IntegerValue = CInt(BuiltInCategory.OST_LightingFixtures) Then
      Return
   End If

   ' Get the light family from the static method.
   Dim lightFamily__1 As LightFamily = LightFamily.GetLightFamily(familyDoc)

   ' Get the light source shape style and distribution style
   Dim shapeStyle As LightShapeStyle = lightFamily__1.GetLightShapeStyle()
   Dim distributionStyle As LightDistributionStyle = lightFamily__1.GetLightDistributionStyle()

   ' Get the light photometric for each family type
   For index As Integer = 0 To lightFamily__1.GetNumberOfLightTypes() - 1
      Dim typeName As String = lightFamily__1.GetLightTypeName(index)
      ' the type name
      ' the light data for each type
      ' How to get and set data in LightType object, please read help document for LightType class.
      Dim lightData As LightType = lightFamily__1.GetLightType(index)
   Next
End Sub

Name	Return Type	Description
M Dispose()	None	Releases all resources used by the
M GetLightDistributionStyle()	LightDistributionStyle	Returns a LightDistributionStyle value for the light distribution
M GetLightFamily(Document)	LightFamily	Creates a light family object from the given family document
M GetLightShapeStyle()	LightShapeStyle	Returns a LightShapeStyle value for the light shape
M GetLightSourceTransform()	Transform	Returns a Transform value for the transform of light source.
M GetLightType(Int32)	LightType	Return a LightType object for the light type at the given index
M GetLightTypeName(Int32)	string	Return the name for the light type at the given index
M GetNumberOfLightTypes()	int	Return the number of light types contained in this light family
M SetLightDistributionStyle(LightDistributionStyle)	None	Set the light distribution style to the given shape distribution
M SetLightShapeStyle(LightShapeStyle)	None	Set the light shape style to the given shape style

Name	Return Type	Description
P IsValidObject	bool	Specifies whether the .NET object represents a valid Revit entity.