M_AML_ExternalDataReference_ExternalDataReference_AddDocumentReference

ExternalDataReference.AddDocumentReference 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.ExternalDataReference
Assembly: AMLEngineExtensions (in AMLEngineExtensions.dll) Version: 3.5

Syntax

C#

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

C++

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

Parameters

 

documentElement

Type: CAEX_ClassModel.InternalElementType
The document element.

referenceName

Type: System.String
The name for the referencing interface.

externalDataReferenceInterfaceClassPath (Optional)

Type: System.String
The external data reference interface class path.

Return Value

Type: InterfaceClassType
InterfaceClassType.

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).

See Also

Reference

ExternalDataReference Class
AML.ExternalDataReference Namespace