Category: Tekla API

A series of blog posts exploring the Tekla API.  Code examples, explanations and (where relevant) videos will be provided.

  • How to check if you have a legitimate Tekla Profile using the Tekla Open API

    Our use case?

    1. Detailers copy / paste profiles from structural drawings into a CSV file.
    2. This CSV file is then used to create a model.
    3. It is essential that the profiles are recognisable by Tekla.

    How can we check?

    • Through a data validation directly in Excel. Or
    • By validating the data directly in your code.
    using Tekla.Structures.Catalogs;
    // download this dll from Nuget
    
                    public bool CSVProfilesAreCorrect(List<CSVFieldsImplemented> dataRows)
            {
                HashSet<string> csvProfiles = dataRows.Select(row => row.Profile).ToHashSet<string>();
                HashSet<string> teklaProfiles = getAllTeklaProfiles().ToHashSet<string>();
    
                if (_areCSVProfilesCorrect())
                {
                    return true;
                }
                else
                {
                    throw new SystemException($"The CSV files have these profiles which don't exist in Tekla: {String.Join(", ", string.Join(", ", csvProfiles.Except(teklaProfiles)))}");
                }
    
                bool _areCSVProfilesCorrect()
                {   
                    // all the csv profiles
                    // must be contained in tekla profiles
    
                    return csvProfiles.All(profile => teklaProfiles.Contains(profile));
                }
            }
    
    // and we call it like so:
    CSVValidator validator = new CSVValidator(db);
    
    if (validator.CSVProfilesAreCorrect(extractor.CSVRecords))
    {
        // do the modelling
    }        

    Voila! Now it’s hard to make a mistake.

    If you want to get all materials – it’s very similar to the above. Use the CatalogHandler.GetMaterialItems() method along with the materialItem.MaterialName property. The code to actually do that – I will leave as an exercise to the reader.

  • How to Get Tekla Model Objects if selected by Users (Tekla API)

    How to Get Tekla Model Objects if selected by Users (Tekla API)

    A user has pre-selected a set of model objects.

    We need to retrieve them via the API. How do we do it?

    All of our code is extracted from our production apps.

  • ByCoordinateSystems (i.e. the Tekla API method)? AlignCoordinateSystem (the AutoCAD .net API method)? What are they? What do they mean?

    What problem does it solve?

    I have some treasure, buried somewhere.

    I know how to get there from my town.

    • Go 10km forward, and then 5 km left, and then 2 km right.
    • Walk forward 10 steps, and now
    • dig.

    This is great from my current location. But how will you get there from YOUR location? Without changing the location of the treasure, I can tell you how to get there, from your location by aligning coordinate systems.

    But it can be confusing. Here’s how I think about it intuitively. Forget the maths, just think about it intuitively.

    Consider both examples:

    If you think about it that way, it will be much harder to get confused.

  • How to programmatically filter model objects, in a Tekla model, by Part Position? (Tekla API)

    How to programmatically filter model objects, in a Tekla model, by Part Position? (Tekla API)

    Suppose you have a Tekla model and you want to programmatically filter for parts with a revision mark of abc/1. How would you do that?

    1. One way would be to iterate through the entire model, check for items which match your condition (perhaps via a LINQ query).
    2. The second would be to use Tekla’s native filtering metchnicsms, which seem to be FAST:

    When I originally tried the code, I had a single Binary Filter expression for just the part Position Number. I made a fatal mistake – I had assumed that Tekla would be smart enough to release that given I want a part position number, I also wanted a part. The API returned almost everything under the sun. And I have no idea why. So then I added a second Binary filter expression – this time one for parts.

    Given we have two “filters”, we need to add them into a filter collection, and then finally, when we search, we search by .GetObjectsByFilter(filterCollection).

    Here is the code:

  • How to Debug a Tekla Plugin Without Restarting Visual Studio (Tekla Open API Tutorial)

    How to Debug a Tekla Plugin Without Restarting Visual Studio (Tekla Open API Tutorial)

    To my surprise, debugging is not a trivial exercise. Please watch the video to guide you on where to click etc.

    Source code – github repository of the tekla beam plugin.

    You need to follow the instructions listed here: https://developer.tekla.com/tekla-structures/documentation/debug-plugin-without-restarting-tekla-structures with the following notes and amendments:

    1. Add “set XS_PLUGIN_DEVELOPER_MODE=true” to the teklastructures.ini file and open Tekla Structures. – Trimble Documentation

    In order to add the flag above, you need to locate the ‘teklastructures.ini’ file: on my PC: it is here: `D:\Program Files\Tekla Structures\2019.1\nt\bin` (refer to the above URL) – it might be in the C: drive on your computer.

    Post Build Events

    For more information on post build events: https://learn.microsoft.com/en-us/visualstudio/ide/how-to-specify-build-events-csharp?view=vs-2022

    As you can see they are basically .bat files. Which means you can use “MS-DOS Batch File Language” or batch commands in there. The MSFT documentation suggests you can also use PowerShell (https://learn.microsoft.com/en-us/powershell/scripting/overview?view=powershell-7.4) script commands.

    Here is the post build event I used:

    The Tekla documentation is confused about where to paste the DLL – in some cases they say the ‘plugins’ folder, but in others, it is the ‘extensions’ folder. Yet elsewhere, different Tekla versions have different places where you can paste it. In my case, I have focused on the “extensions” directory.

    Warning: If you paste it into multiple locations, you may find that you cannot hit break points! The above link suggests the files should be copied into the .environments/common/extensions folder. I am taking that to mean, in actuality: the `Environments/common/extensions` folder. I am not pasting it into the `plugins` folder, but have opted for the `extensions` folder.

    If you want to use the plugins folder, follow these instructions: The dll containing the plug-in has to be copied into: \<Tekla Structures installation folder>\<version>\nt\bin\plugins. A sub-folder could also be created to store the dll. In my case, the plugin files are located here: D:\Program Files\Tekla Structures\2019.1\nt\bin\plugins\TestWPFBeamPlugin

    Setting up a macro:

    Run the UI macro (Reloadplugins.cs) in the Applications & Components catalog on the side pane. We must set it up. In my system, the location is at the following:

    D:\Program Files\Tekla Structures\2019.1\Environments\common\macros

    Go there and copy the code noted in the above git gist. You can add an image if you wish to.

  • How to Get Drawing Revision Numbers

    How to Get Drawing Revision Numbers

    Couldn’t do it, because it’s not exposed. This is a hack that I used to circumvent:

     

     

  • Tekla API – how to select model objects via a picker

    Tekla API – how to select model objects via a picker

    Pretty simple: just selects a simple model object

     

     

  • Exploring a New Approach to Copying Objects in Tekla


     

    copy to another Object in Tekla

     

    Normally in Tekla, if we want to copy objects or components from one object to another, we have to follow these steps :

     

    • Select the objects and components you want to copy.
    • Execute the “Copy to Another Object” command.
    • Choose the source object.
    • Select the destination object.
    • The objects will be copied by reference, aligning their coordination system with that of the source object to the destination object’s coordination system.

     

    Please note that the coordination system is used to ensure the accurate positioning of the copied objects in relation to the source and destination objects.

     


     

    Macro: Copy to another object multiple

     

    The command “Copy to Another Object” poses an issue when used in Tekla. It does not allow the selection of multiple destination objects at once; instead, we can only choose them one by one. This limitation can be time-consuming, particularly when working on large projects.

     

    Tekla offers a macro called “Copy to Another Object Multiple” that fulfills the requirement of selecting multiple destination objects. This macro functions similarly to the command mentioned earlier. First, we need to select the objects before running the macro. Once the macro is executed, it prompts us to select an object. Then, we select one source part, after which we can conveniently use drag selection to choose multiple destination objects. Finally, press the mouse middle button.

     

    the snapshot was taken on Tekla version 2022

     

    You can find this macro in the Applications & Components catalog of Tekla Structures.

     


     

    Introducing a New Approach: The Modified Implementation for Copying Objects in Tekla

     

    The ‘Copy to Another Object‘ command works by copying objects in relation to the source object and pasting them according to the destination objects

     

    • The coordination system plays a crucial role in defining the position and rotation of a part in Tekla
    • It is primarily based on the start handle of the part
    • Altering the coordination system of a part is not possible

     

    If the destination object’s lengths differ from the source object, a problem arises where the objects are positioned based on the start point

     

    After copying the small beam to other destination objects of varying lengths

     

    In many situations, we often find ourselves having to manually utilize the ‘Copy Linear’ or ‘Move Linear’ commands to perform copying tasks.

     

    We utilized the Tekla API to Create a new macro that helps to copy objects in relation to the end handle of the part. When executing this macro, it prompts the user to select the desired handling method for copying objects

     

    This is the dialog box that appears while running the modified “Copy Multiple Tek1” macro.

     

    When the “End Handle to End Handle Copy” option is selected, the operation produces an outcome that is similar to the image shown.

    members of the Tek1 organization can download the tsep installer file of the above macro by clicking the download button

    Here is the code of the macro. if anyone wants to have a look around and find out how things work, just go through the code:

    https://gist.github.com/ansonsuhesh/582062d65e83fad2a74540e2fddd795c

    Here is the video to explain the process of the newly created macro. Check this out:

    GitHub/ansonsuhesh

    LinkedIn/ansonsuhesh

  • Blog Test Post

    Blog Test Post

    THIS IS A TEST POST