M_AML_ExternalDataReference_ExternalDataReference_AddDocumentElement

ExternalDataReference.AddDocumentElement Method

Adds a document element to the defined internalElement. A Document Element is semanticaly described with an attached role defined withe the base role class ExternalDataRoleClassPath or a derived role class. If no roleclass path is given as a parameter the default is used. If the specified role class path can not be identified as a dreived role from the ExternalDataRoleClassPath no document element is added (returns null).

Namespace: AML.ExternalDataReference
Assembly: AMLEngineExtensions (in AMLEngineExtensions.dll) Version: 3.5

Syntax

C#

public static InternalElementType AddDocumentElement(
	this SystemUnitClassType internalElement,
	string name,
	string externalDataRoleClassPath = "AutomationMLBPRRoleClassLib/ExternalData"
)

C++

public:
[ExtensionAttribute]
static InternalElementType^ AddDocumentElement(
	SystemUnitClassType^ internalElement, 
	String^ name, 
	String^ externalDataRoleClassPath = L"AutomationMLBPRRoleClassLib/ExternalData"
)

Parameters

 

internalElement

Type: CAEX_ClassModel.SystemUnitClassType
The internalElement.

name

Type: System.String
The name of the document element.

externalDataRoleClassPath (Optional)

Type: System.String
The Role class path to a role class, derived from the ExternalData Role Class ExternalDataRoleClassPath

Return Value

Type: InternalElementType
created InternalElementType document element or null if the role class is invalid

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type SystemUnitClassType. 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