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

ShapeItemEnumerator Class

The ShapeItemEnumerator class allows to loop through the shape catalog items.

Inheritance Hierarchy

SystemObject
Tekla.Structures.CatalogsShapeItemEnumerator

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

Syntax

Copy

[SerializableAttribute]
public sealed class ShapeItemEnumerator : IEnumerator

<SerializableAttribute>
Public NotInheritable Class ShapeItemEnumerator
	Implements IEnumerator

The ShapeItemEnumerator type exposes the following members.

Properties

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

Top

Methods

	Name	Description
	GetSize	Returns the total amount 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 Connection has been found:

Copy

using Tekla.Structures.Catalogs;

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

           CatalogHandler CatalogHandler = new CatalogHandler();

           if (CatalogHandler.GetConnectionStatus())
           {
               ShapeItemEnumerator ShapeItemEnumerator = CatalogHandler.GetShapes();

               while (ShapeItemEnumerator.MoveNext())
               {
                   ShapeItem ShapeItem = ShapeItemEnumerator.Current as ShapeItem;

                   if (ShapeItem.Name == "Connection")
                   {
                       Result = true;
                       break;
                   }
               }
           }

           return Result;
       }
}

Reference

Tekla.Structures.Catalogs Namespace

API Reference

ShapeItemEnumerator Class

Reference