API Reference

Detailed and full API reference helps you master Tekla development

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

UserPropertyItemEnumerator Class

The UserPropertyItemEnumerator class allows to loop through the user property items.
Inheritance Hierarchy
SystemObject
  Tekla.Structures.CatalogsUserPropertyItemEnumerator

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

The UserPropertyItemEnumerator type exposes the following members.

Properties
  Name Description
Public property Current
Returns a user property item instance of the current element.
Top
Methods
  Name Description
Public method GetSize
Returns the total amout of items.
Public method MoveNext
Moves to the next item in the enumerator.
Public method Reset
Resets the enumerator to the beginning.
Top
Examples
The following example returns true if an item with the name "comment" has been found:
using Tekla.Structures.Catalogs;

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

           CatalogHandler CatalogHandler = new CatalogHandler();

           if (CatalogHandler.GetConnectionStatus())
           {
               UserPropertyItemEnumerator UserPropertyItemEnumerator = CatalogHandler.GetUserPropertyItems();

               while (UserPropertyItemEnumerator.MoveNext())
               {
                   UserPropertyItem UserPropertyItem = UserPropertyItemEnumerator.Current as UserPropertyItem;

                   if (UserPropertyItem.Name == "comment")
                   {
                       Result = true;
                       break;
                   }
               }
           }

           return Result;
       }
}
See Also