Namespace: Autodesk.Revit.DB Class: FamilyInstance

FamilyInstance.GetReferenceName

Method

Description:
Gets the name of the reference plane in the family corresponding to the given family instance reference.

Remarks:
If the given family reference corresponds to a named reference plane in the instance's family, the name of that reference plane will be returned. Otherwise, an empty string will be returned.

Syntax

public string GetReferenceName(
	Reference reference
)

Public Function GetReferenceName ( 
	reference As Reference
) As String

public:
String^ GetReferenceName(
	Reference^ reference
)

member GetReferenceName : 
        reference : Reference -> string

Parameters

Parameter	Type	Description
reference	Reference	The family instance reference.

Return Value

Type	Description
String	Returns the name of the reference plane in the family corresponding to the given family instance reference. If the reference doesn't correspond to a named reference plane, returns an empty string.

Exceptions

Exception	Condition
ArgumentNullException	A non-optional argument was null