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

<SerializableAttribute>
Public NotInheritable Class MaterialItemEnumerator
	Implements IEnumerator

The MaterialItemEnumerator type exposes the following members.

Properties

	Name	Description
	Current	Returns a material item instance of the current element.

Top

Methods

	Name	Description
	GetSize	Returns the total amout of items.
	MoveNext	Moves to the next item in the enumerator.
	Reset	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;
       }
}

Reference

Tekla.Structures.Catalogs Namespace

API Reference

MaterialItemEnumerator Class

Reference