M

Reference.ParseFromStableRepresentation

Description:
Converts a stable String representation of a reference to a Reference object.

Remarks:
Use ConvertToStableRepresentation(Document) to obtain the representation. The Reference will have only the following information set:

You will also be able to pass the reference to Document.GetElement(reference) and Element.GetGeometryObjectFromReference(reference) to obtain the element and geometry object referred to.

public static Reference ParseFromStableRepresentation(
	Document document,
	string representation
)

Public Shared Function ParseFromStableRepresentation ( _
	document As Document, _
	representation As String _
) As Reference

public:
static Reference^ ParseFromStableRepresentation(
	Document^ document, 
	String^ representation
)

Autodesk.Revit.DB.Document

document

The document.
String

representation

The reference representation.

Return Value Reference

public Reference ParseReference(Document doc, String str)
{
    Reference reference = Reference.ParseFromStableRepresentation(doc, str);
    if (null == reference)
    {
        TaskDialog.Show("ParseReference", "Reference is Null.");
    }
    return reference;
}

Public Function ParseReference(doc As Document, str As [String]) As Reference
    Dim reference__1 As Reference = Reference.ParseFromStableRepresentation(doc, str)
    If reference__1 Is Nothing Then
        TaskDialog.Show("ParseReference", "Reference is Null.")
    End If
    Return reference__1
End Function

Autodesk.Revit.Exceptions.ArgumentNullException

One or more arguments wasnullNothingnullptra null reference (Nothingin Visual Basic).
Autodesk.Revit.Exceptions.ArgumentException

Reference representation could not be successfully parsed, or element id obtained from reference representation could not be found in this document.