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

BoltItemEnumerator Class

The BoltItemEnumerator class allows to loop through the bolt catalog items.

Inheritance Hierarchy

SystemObject
Tekla.Structures.CatalogsBoltItemEnumerator

Namespace: Tekla.Structures.Catalogs
Assembly: Tekla.Structures.Catalogs (in Tekla.Structures.Catalogs.dll) Version: 2023.0.1

Syntax

Copy

[SerializableAttribute]
public sealed class BoltItemEnumerator : IEnumerator

<SerializableAttribute>
Public NotInheritable Class BoltItemEnumerator
	Implements IEnumerator

The BoltItemEnumerator type exposes the following members.

Properties

	Name	Description
	Current	Returns a bolt 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 standard A325N has been found:

Copy

using Tekla.Structures.Catalogs;

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

           CatalogHandler CatalogHandler = new CatalogHandler();

           if (CatalogHandler.GetConnectionStatus())
           {
               BoltItemEnumerator BoltItemEnumerator = CatalogHandler.GetBoltItems();

               while (BoltItemEnumerator.MoveNext())
               {
                   BoltItem BoltItem = BoltItemEnumerator.Current as BoltItem;

                   if (BoltItem.Standard == "A325N")
                   {
                       Result = true;
                       break;
                   }
               }
           }

           return Result;
       }
}

Reference

Tekla.Structures.Catalogs Namespace

API Reference

BoltItemEnumerator Class

Reference