ComponentItemEnumerator Class

The ComponentItemEnumerator class allows to loop through the component catalog items.

Inheritance Hierarchy

SystemObject
Tekla.Structures.CatalogsComponentItemEnumerator

Namespace: Tekla.Structures.Catalogs
Assembly: Tekla.Structures.Catalogs (in Tekla.Structures.Catalogs.dll) Version: 2024.0.0+a110b435391768740483e3032720a566518c9a63

Syntax

Copy

[SerializableAttribute]
public sealed class ComponentItemEnumerator : IEnumerator

<SerializableAttribute>
Public NotInheritable Class ComponentItemEnumerator
	Implements IEnumerator

The ComponentItemEnumerator type exposes the following members.

Properties

	Name	Description
	Current	Returns a component 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 EndPlate and with the number 144 has been found:

Copy

using Tekla.Structures.Catalogs;

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

           CatalogHandler CatalogHandler = new CatalogHandler();

           if (CatalogHandler.GetConnectionStatus())
           {
               ComponentItemEnumerator ComponentItemEnumerator = CatalogHandler.GetComponentItems();

               while (ComponentItemEnumerator.MoveNext())
               {
                   ComponentItem ComponentItem = ComponentItemEnumerator.Current as ComponentItem;

                   if (ComponentItem.Name == "EndPlate" && ComponentItem.Number == 144)
                   {
                       Result = true;
                       break;
                   }
               }
           }

           return Result;
       }
}

Reference

Tekla.Structures.Catalogs Namespace