System.Object
Eplan.EplApi.DataModel.AbstractDMObjectFilter
Eplan.EplApi.DataModel.StorableObjectsFilter
Eplan.EplApi.DataModel.PlacementsFilter
Eplan.EplApi.DataModel.FunctionsFilter
System.Object
Eplan.EplApi.DataModel.AbstractDMObjectFilter
Eplan.EplApi.DataModel.StorableObjectsFilter
Eplan.EplApi.DataModel.PlacementsFilter
Eplan.EplApi.DataModel.FunctionsFilter
public class FunctionsFilter : PlacementsFilter
public ref class FunctionsFilter : public PlacementsFilter
Project myProject = m_oProject; // A valid project Page myPage = myProject.Pages[0]; // A valid Page object // Use a filter to get only functions with category 'Motor' myPage.Filter.FunctionCategory = Eplan.EplApi.Base.Enums.FunctionCategory.Motor; // Place all functions with category 'Motor' on page myPage Function[] functions = myPage.Functions; // Another way to do the same: // Use a filter to get only functions with category 'Motor' FunctionsFilter myFunctionsFilter = new FunctionsFilter(); myFunctionsFilter.FunctionCategory = Eplan.EplApi.Base.Enums.FunctionCategory.Motor; myFunctionsFilter.Page = myPage; DMObjectsFinder objFinder = new DMObjectsFinder(myProject); // Place all functions with category 'Motor' on page myPage functions = objFinder.GetFunctions(myFunctionsFilter);
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);
Name | Description | |
---|---|---|
FunctionsFilter Constructor | Overloaded. |
Name | Description | |
---|---|---|
ExactNameMatching | Gets/Sets if the filtered function, when is filtered by name, should be matched exactly, it means that if searched name is only its name' prefix, it is not matching to the filter. Dafault this property is false . | |
FunctionCategory | Gets/Sets the filter's category | |
IsPlaced | Gets/Sets if the filtered function should be placed (i.e. should be located on a valid page). | |
Name | Gets/Sets the name that was set to this filter. | |
Page | Overridden. Sets the Page that StorableObjects matching the filter must be placed on. |
Name | Description | |
---|---|---|
Dispose() | Destructor for deterministic finalization of FunctionFilter object. (Inherited from Eplan.EplApi.DataModel.AbstractDMObjectFilter) | |
ResetFilter | Overridden. Resets the filter. Filter matches all StorableObjects then. | |
SetFilteredPropertyList | Overloaded. Sets the FunctionBasePropertyList that Functions matching the filter must have. | |
SetIdentifyingPropertyList | Overloaded. Sets the FunctionBasePropertyList that identifies the matching Functions. |