Eplan Platform API
Eplan.EplApi.DataModel Namespace / ArticleReferencesFilter Class
Members Example

ArticleReferencesFilter Class
This class represents filter of ArticleReference and derived from it classes. The ArticleReferencesFilter can be used as a parameter for DMObjectsFinder. Setting more than one criterion of matching the filter causes that returned functions must match both conditions.
Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.AbstractDMObjectFilter
      Eplan.EplApi.DataModel.ArticleReferencesFilter

Syntax
public class ArticleReferencesFilter : AbstractDMObjectFilter 
Example
The following example shows how to filter by user-defined properties
Project myProject = m_oProject; // A valid project
Page myPage = myProject.Pages[0]; // A valid Page object

// Define test property
MultiLangString mlsTestValue = new MultiLangString();
mlsTestValue.AddString(ISOCode.Language.L_de_DE, "Test043c");
string strPropertyIdentyfingName = "Page.Test043c";
UserDefinedPropertyDefinition oUDPD = UserDefinedPropertyDefinition.Create(myProject, strPropertyIdentyfingName, UserDefinedPropertyDefinition.Enums.ClientType.Page);

// Set test property on myPage
myPage.Properties[strPropertyIdentyfingName] = mlsTestValue;

// Search page with property value
DMObjectsFinder objFinder = new DMObjectsFinder(myProject);
PagesFilter pagesFilter = new PagesFilter();
PagePropertyList pagePropertyList = new PagePropertyList();
AnyPropertyId anyPropertyId = new AnyPropertyId(myProject, strPropertyIdentyfingName);

pagePropertyList[anyPropertyId] = mlsTestValue;
pagesFilter.SetFilteredPropertyList(pagePropertyList);
Page[] arrPages1 = objFinder.GetPages(pagesFilter);


Public Constructors
 NameDescription
Public ConstructorOverloaded.   
Top
Public Properties
 NameDescription
Public PropertyGets/Sets the part number that was set to this filter.  
Top
Public Methods
 NameDescription
Public Method (Inherited from Eplan.EplApi.DataModel.AbstractDMObjectFilter)
Public MethodOverridden. Resets the filter. Filter matches all ArticleReferences then.  
Public MethodSets the ArticleReferencePropertyList that ArticleReferences matching the filter must have.  
Top
See Also