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
)

static member ParseFromStableRepresentation : 
        document : Document * 
        representation : string -> Reference

Document

document

The document.
String

representation

The reference representation.

Return Value Reference 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;
}

ArgumentNullException

One or more arguments was.
ArgumentException

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