Click or drag to resize

ExternalDataReferenceAddDocumentElement Method

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

Namespace: Aml.Engine.AmlObjects
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2
Syntax
Copy
public static InternalElementType AddDocumentElement(
	this SystemUnitClassType internalElement,
	string name,
	string externalDataRoleClassPath = "AutomationMLBPRRoleClassLib/ExternalData"
)

Parameters

internalElement  SystemUnitClassType
The internalElement.
name  String
The name of the document element.
externalDataRoleClassPath  String  (Optional)
The Role class path to a role class, derived from the ExternalData Role Class ExternalDataRoleClassPath

Return Value

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