ExternalDataReferenceAddDocumentReference Method

Adds a document with the specified external reference interface to the document element. If the given internal element is not a document element or the defined class path to the external reference interface is not derived from the standard base class no interface is added.

Namespace: Aml.Engine.AmlObjects
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2

Syntax

C++

Copy

public static InterfaceClassType AddDocumentReference(
	this InternalElementType documentElement,
	string referenceName,
	string externalDataReferenceInterfaceClassPath = "AutomationMLBPRInterfaceClassLib/ExternalDataReference"
)

<ExtensionAttribute>
Public Shared Function AddDocumentReference ( 
	documentElement As InternalElementType,
	referenceName As String,
	Optional externalDataReferenceInterfaceClassPath As String = "AutomationMLBPRInterfaceClassLib/ExternalDataReference"
) As InterfaceClassType

public:
[ExtensionAttribute]
static InterfaceClassType^ AddDocumentReference(
	InternalElementType^ documentElement, 
	String^ referenceName, 
	String^ externalDataReferenceInterfaceClassPath = L"AutomationMLBPRInterfaceClassLib/ExternalDataReference"
)

Parameters

documentElement InternalElementType: The document element.
referenceName String: The name for the referencing interface.
externalDataReferenceInterfaceClassPath String (Optional): The external data reference interface class path.

Return Value

InterfaceClassType
The InterfaceClass which is created as a reference to the external data.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type InternalElementType. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
NullReferenceException	Element is not contained in a CAEXDocument

Reference

ExternalDataReference Class

Aml.Engine.AmlObjects Namespace