M

LightType.GetLightTypeFromInstance

Description:
Creates a light type object from the given document and element ID

public static LightType GetLightTypeFromInstance(
	Document document,
	ElementId instanceId
)

Public Shared Function GetLightTypeFromInstance ( 
	document As Document,
	instanceId As ElementId
) As LightType

public:
static LightType^ GetLightTypeFromInstance(
	Document^ document, 
	ElementId^ instanceId
)

static member GetLightTypeFromInstance : 
        document : Document * 
        instanceId : ElementId -> LightType

Document

document

The document the instanceId is from
ElementId

instanceId

The ID of the light fixture instance

Return Value LightType The newly created LightType object

public LightType GetLightTypeFromLightInstance(Document document)
{
    if(document.IsFamilyDocument) // not used in family document
        return null;

    // In order to get the light infromation, please get a light fixture instance first
    FilteredElementCollector collector = new FilteredElementCollector(document);
    collector.OfClass(typeof(FamilyInstance)).OfCategory(BuiltInCategory.OST_LightingFixtures);
    FamilyInstance lightFixture = collector.Cast<FamilyInstance>().First<FamilyInstance>();
    if (lightFixture == null)    // check null reference
        return null;

    // Get the LightType for given light fixture
    return LightType.GetLightTypeFromInstance(document, lightFixture.Id);
}

ArgumentException

The ElementId is the argument that is being validated The ElementId is not valid because it is not for a light element.
ArgumentNullException

A non-optional argument was null