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: 2023.0.1

Syntax

Copy

[SerializableAttribute]
public sealed class UserPropertyItemEnumerator : IEnumerator

<SerializableAttribute>
Public NotInheritable Class UserPropertyItemEnumerator
	Implements IEnumerator

The UserPropertyItemEnumerator type exposes the following members.

Properties

	Name	Description
	Current	Returns a user property 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 "comment" has been found:

Copy

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;
       }
}

Reference

Tekla.Structures.Catalogs Namespace

API Reference

UserPropertyItemEnumerator Class

Reference