API Reference

Detailed and full API reference helps you master Tekla development

  1. Tekla Structures
  2. Tekla Open API 2023 Reference
  3. MaterialItemEnumerator Class

This is the most recent version of Tekla Open API.
For older versions, please visit Tekla Warehouse.

MaterialItemEnumerator Class

The MaterialItemEnumerator class allows to loop through the catalog material items.
Inheritance Hierarchy
SystemObject
  Tekla.Structures.CatalogsMaterialItemEnumerator

Namespace:  Tekla.Structures.Catalogs
Assembly:  Tekla.Structures.Catalogs (in Tekla.Structures.Catalogs.dll) Version: 2023.0.1
Syntax
Copy
[SerializableAttribute]
public sealed class MaterialItemEnumerator : IEnumerator

The MaterialItemEnumerator type exposes the following members.

Properties
  NameDescription
Public propertyCurrent
Returns a material item instance of the current element.
Top
Methods
  NameDescription
Public methodGetSize
Returns the total amout of items.
Public methodMoveNext
Moves to the next item in the enumerator.
Public methodReset
Resets the enumerator to the beginning.
Top
Examples
The following example returns true if an item with the name S235JR has been found:
Copy
using Tekla.Structures.Catalogs;

public class Example
{
       public bool Example1()
       {
           bool Result = false;

           CatalogHandler CatalogHandler = new CatalogHandler();

           if (CatalogHandler.GetConnectionStatus())
           {
               MaterialItemEnumerator MaterialItemEnumerator = CatalogHandler.GetMaterialItems();

               while (MaterialItemEnumerator.MoveNext())
               {
                   MaterialItem MaterialItem = MaterialItemEnumerator.Current as MaterialItem;

                   if (MaterialItem.MaterialName == "S235JR")
                   {
                       Result = true;
                       break;
                   }
               }
           }

           return Result;
       }
}
See Also