ExternalDataReferenceAddDocumentElementRole Method

Add a role reference to a external data role class or derived role class defined with the given role class path as a supported role class to the internal element. If the specified role class path can not be identified as a derived role from the ExternalDataRoleClassPath no role reference is added (returns false).

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

Syntax

C++

Copy

public static bool AddDocumentElementRole(
	this InternalElementType internalElement,
	string externalDataRoleClassPath
)

<ExtensionAttribute>
Public Shared Function AddDocumentElementRole ( 
	internalElement As InternalElementType,
	externalDataRoleClassPath As String
) As Boolean

public:
[ExtensionAttribute]
static bool AddDocumentElementRole(
	InternalElementType^ internalElement, 
	String^ externalDataRoleClassPath
)

Parameters

internalElement InternalElementType: The internalElement.
externalDataRoleClassPath String: path to the role class

Return Value

Boolean
true, if a supported role class with the defined path is added false 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 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	InternalElement not contained in CAEXDocument

Reference

ExternalDataReference Class

Aml.Engine.AmlObjects Namespace