CAEXBasicObjectExtensionsAncestorsT(ICAEXWrapper, Boolean) Method

Finds the ancestors of the provided CAEX object which have the given type.

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

Syntax

public static IEnumerable<T> Ancestors<T>(
	this ICAEXWrapper caexObject,
	bool includeSelf = false
)
where T : CAEXWrapper

<ExtensionAttribute>
Public Shared Function Ancestors(Of T As CAEXWrapper) ( 
	caexObject As ICAEXWrapper,
	Optional includeSelf As Boolean = false
) As IEnumerable(Of T)

public:
[ExtensionAttribute]
generic<typename T>
where T : CAEXWrapper
static IEnumerable<T>^ Ancestors(
	ICAEXWrapper^ caexObject, 
	bool includeSelf = false
)

Parameters

caexObject ICAEXWrapper: The CAEX object.
includeSelf Boolean (Optional): Includes the caex object if set to true.

Type Parameters

T: CAEX element type of the ancestors.

Return Value

IEnumerableT
The ancestors of the CAEX object which are of the given type.

Usage Note

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

Reference

CAEXBasicObjectExtensions Class

Ancestors Overload

Aml.Engine.CAEX.Extensions Namespace