Skip to main content

IModel.GetRefRelatedModels(IPackage,string,bool) Method

Namespace: NextDesign.Core

Description

Retrieves instances that have a reference relationship with this instance through the specified related class.
The specified class is identified from within the package specified in the scope.

This method evaluates IContextOption.PlModelAccessMode.

This method returns an empty collection in the following cases:

  • No instances associated with the corresponding reference relationship exist.

  • The specified related class cannot be found.

  • The reference field by the specified related class cannot be found.

Note that if the specified related class is a self-referential relationship, both the source and target relationships are evaluated.

Argument

NameTypeDescription
scopeIPackageScope (the package that serves as the base for the search)
classNamestringRelated Class Name
Specifies the name or fully qualified name of the related class.
fuzzyboolFuzzy Match Option
Whether to treat the className argument as the class name rather than the fully qualified name.
If False, it is evaluated as specifying a class whose fully qualified name matches className.
If True, it is evaluated as specifying a class whose class name matches className.

The default value is True.

Return value

  • IModelCollection