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

In This Topic
    ArticleReferencesFilter Class
    In This Topic
    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 
    public ref class ArticleReferencesFilter : public AbstractDMObjectFilter 
    Example
    The following example shows how to filter by user-defined properties
    MultiLangString mlsTestValue = new MultiLangString();
    mlsTestValue.AddString(ISOCode.Language.L_de_DE, "Test043c");
    string strPropertyIdentyfingName = "Page.Test043c";
    UserDefinedPropertyDefinition oUDPD = UserDefinedPropertyDefinition.Create(m_oProject, strPropertyIdentyfingName, UserDefinedPropertyDefinition.Enums.ClientType.Page);
    
    //set test property
    Page oPage = m_oProject.Pages[0];
    oPage.Properties[strPropertyIdentyfingName] = mlsTestValue;
    
    //search page with property value
    DMObjectsFinder oFinder = new DMObjectsFinder(m_oProject);
    PagesFilter oPagesFilter = new PagesFilter();
    PagePropertyList oPagePropertyList = new PagePropertyList();
    AnyPropertyId oAnyPropertyId = new AnyPropertyId(m_oProject, strPropertyIdentyfingName);
    oPagePropertyList[oAnyPropertyId] = mlsTestValue;
    oPagesFilter.SetFilteredPropertyList(oPagePropertyList);
    Page[] arrPages1 = oFinder.GetPages(oPagesFilter);
    
    
    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