{"id":112,"date":"2016-04-19T10:45:12","date_gmt":"2016-04-19T10:45:12","guid":{"rendered":"http:\/\/cadsupport.ru\/en\/?p=112"},"modified":"2024-04-10T04:49:34","modified_gmt":"2024-04-10T04:49:34","slug":"how-to-use-tekla-macro-script-with-tekla-api","status":"publish","type":"post","link":"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/","title":{"rendered":"How to use Tekla Macro Scripts with Tekla API"},"content":{"rendered":"
\"Tekla
Quick view scale switch app example<\/figcaption><\/figure>\n

If you\u00a0carefully study the Tekla API<\/strong>, then pretty soon you will notice that the functionality\u00a0which is listed at Reference Documentations\u00a0does not exhaust the whole possibilities\u00a0of Tekla Structures. If you have access to the Tekla Extranet<\/strong>, in the appropriate forums, you can see that it is indeed the case.\u00a0However a way to use all the functions exists. It consists in working with Tekla Macro Scripts.<\/p>\n

Tekla Open API Limits<\/h2>\n

There is no documentation for macro script writing (at least I couldn’t find it). But actually creating, recording and analysis of scripts at Tekla is a task which is not easy at first glance, but in fact it’s trivial. Unsolved question is how to embed scripting functionality to your \u00a0C# application?<\/p>\n

Below you could find listing of the code that is binds\u00a0on button of application interface. This function create, write as script and invoke that script. As result script changes the scale of the selected view on current drawing and switch it on value that is set in the button text. Script it self call the standard View Dialog<\/em>, throws all of it’s check boxes, sets a new scale, marks scale check box, apply new settings and close dialog.<\/p>\n

Tekla Macro Scripts example:<\/h2>\n
\/\/Change Scale of View on Tekla Drawing<\/span>\r\n        private<\/span> void<\/span> btViewScale_Click(object<\/span> sender, EventArgs e)\r\n        {\r\n            string<\/span> Name = GetMacroFileName();\/\/Temporary file name.<\/span>\r\n            string<\/span> MacrosPath = string<\/span>.Empty;\/\/would store Path to script<\/span>\r\n            Tekla.Structures.TeklaStructuresSettings.GetAdvancedOption(\"XS_MACRO_DIRECTORY\"<\/span>, ref<\/span> MacrosPath);\/\/Find out where is actual macro directory.<\/span>\r\n            if<\/span> (MacrosPath.IndexOf(';'<\/span>) > 0) { MacrosPath = MacrosPath.Remove(MacrosPath.IndexOf(';'<\/span>)); }\r\n            \r\n            \/\/Create a script as string<\/span>\r\n            string<\/span> script2 = \"namespace Tekla.Technology.Akit.UserScript\"<\/span> +\r\n                            \"{\"<\/span> +\r\n                            \" public class Script\"<\/span> +\r\n                                \"{\"<\/span> +\r\n                                    \" public static void Run(Tekla.Technology.Akit.IScript akit)\"<\/span> +\r\n                                    \" {\"<\/span> +\r\n            @\"akit.Callback(\"<\/span>\"acmd_display_attr_dialog\"<\/span>\", \"<\/span>\"view_dial\"<\/span>\", \"<\/span>\"main_frame\"<\/span>\");\"<\/span> +\r\n            @\"akit.PushButton(\"<\/span>\"view_on_off\"<\/span>\", \"<\/span>\"view_dial\"<\/span>\");\"<\/span> +\r\n            @\"akit.ValueChange(\"<\/span>\"view_dial\"<\/span>\", \"<\/span>\"gr_view_scale_en\"<\/span>\", \"<\/span>\"1\"<\/span>\");\"<\/span> +\r\n            @\"akit.ValueChange(\"<\/span>\"view_dial\"<\/span>\", \"<\/span>\"gr_view_scale\"<\/span>\", \"<\/span>\"\"<\/span> + (sender as<\/span> Button).Text + @\"\"<\/span>\");\"<\/span> +\r\n            @\"akit.PushButton(\"<\/span>\"view_modify\"<\/span>\", \"<\/span>\"view_dial\"<\/span>\");\"<\/span> +\r\n            @\"akit.PushButton(\"<\/span>\"view_ok\"<\/span>\", \"<\/span>\"view_dial\"<\/span>\");\"<\/span> +\r\n                                    \"}}}\"<\/span>;\r\n\r\n       \/\/Save to file<\/span>\r\n            File.WriteAllText(Path.Combine(MacrosPath, Name), script2);\r\n       \/\/Run it at Tekla Structures application<\/span>\r\n            Tekla.Structures.Model.Operations.Operation.RunMacro(\"..\\\\\" + Name);\r\n        }\r\n        \r\n        \/\/Additional Function - File name generator<\/span>\r\n                private<\/span> string<\/span> GetMacroFileName()\r\n        {\r\n            lock<\/span> (Random)\r\n            {\r\n                if<\/span> (_TempFileIndex < 0)\r\n                {\r\n                    _TempFileIndex = Random.Next(0, MaxTempFiles);\r\n                }\r\n                else<\/span>\r\n                {\r\n                    _TempFileIndex = (_TempFileIndex + 1) % MaxTempFiles;\r\n                }\r\n\r\n                return<\/span> string<\/span>.Format(FileNameFormat, _TempFileIndex);\r\n            }\r\n        }<\/pre>\n
 <\/p>\n","protected":false},"excerpt":{"rendered":"
If you\u00a0carefully study the Tekla API, then pretty soon you will notice that the functionality\u00a0which is listed at Reference Documentations\u00a0does not exhaust the whole possibilities\u00a0of Tekla Structures. If you have access to the Tekla Extranet, in the appropriate forums, you can see that it is indeed the case.\u00a0However a way to use all the functions […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[4,5],"tags":[10,8,11,9,13,7,14,12],"class_list":["post-112","post","type-post","status-publish","format-standard","hentry","category-programing","category-tekla","tag-application","tag-c","tag-drawing","tag-openapi","tag-scale","tag-scripts","tag-tekla-structures","tag-view"],"yoast_head":"\nHow to use Tekla Macro Scripts with Tekla API - CadSupport<\/title>\n<meta name=\"description\" content=\"Tekla Macro Scripts, how to implement functionality to your application example. Good way to avoid Tekla Open API limitations.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How to use Tekla Macro Scripts with Tekla API - CadSupport\" \/>\n<meta property=\"og:description\" content=\"Tekla Macro Scripts, how to implement functionality to your application example. Good way to avoid Tekla Open API limitations.\" \/>\n<meta property=\"og:url\" content=\"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/\" \/>\n<meta property=\"og:site_name\" content=\"CadSupport\" \/>\n<meta property=\"article:published_time\" content=\"2016-04-19T10:45:12+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-04-10T04:49:34+00:00\" \/>\n<meta property=\"og:image\" content=\"http:\/\/cadsupport.ru\/en\/wp-content\/uploads\/2016\/04\/Tekla-macro-script-using-in-application.jpg\" \/>\n<meta name=\"author\" content=\"DonJad\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"DonJad\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/\",\"url\":\"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/\",\"name\":\"How to use Tekla Macro Scripts with Tekla API - CadSupport\",\"isPartOf\":{\"@id\":\"http:\/\/cadsupport.ru\/en\/#website\"},\"primaryImageOfPage\":{\"@id\":\"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/#primaryimage\"},\"image\":{\"@id\":\"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/#primaryimage\"},\"thumbnailUrl\":\"http:\/\/cadsupport.ru\/en\/wp-content\/uploads\/2016\/04\/Tekla-macro-script-using-in-application.jpg\",\"datePublished\":\"2016-04-19T10:45:12+00:00\",\"dateModified\":\"2024-04-10T04:49:34+00:00\",\"author\":{\"@id\":\"http:\/\/cadsupport.ru\/en\/#\/schema\/person\/b57bc479c7822ae8efbc5a5b624a3b8a\"},\"description\":\"Tekla Macro Scripts, how to implement functionality to your application example. Good way to avoid Tekla Open API limitations.\",\"breadcrumb\":{\"@id\":\"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/#primaryimage\",\"url\":\"http:\/\/cadsupport.ru\/en\/wp-content\/uploads\/2016\/04\/Tekla-macro-script-using-in-application.jpg\",\"contentUrl\":\"http:\/\/cadsupport.ru\/en\/wp-content\/uploads\/2016\/04\/Tekla-macro-script-using-in-application.jpg\",\"width\":232,\"height\":240,\"caption\":\"Tekla Macro Scripts - using in c# application or script\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"http:\/\/cadsupport.ru\/en\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"How to use Tekla Macro Scripts with Tekla API\"}]},{\"@type\":\"WebSite\",\"@id\":\"http:\/\/cadsupport.ru\/en\/#website\",\"url\":\"http:\/\/cadsupport.ru\/en\/\",\"name\":\"CadSupport\",\"description\":\"smart solutions for engineering duties\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"http:\/\/cadsupport.ru\/en\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"http:\/\/cadsupport.ru\/en\/#\/schema\/person\/b57bc479c7822ae8efbc5a5b624a3b8a\",\"name\":\"DonJad\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"http:\/\/cadsupport.ru\/en\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/b22cdec01f0612764c8b311b89954151bfb042524440d622849757864e132a55?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/b22cdec01f0612764c8b311b89954151bfb042524440d622849757864e132a55?s=96&d=mm&r=g\",\"caption\":\"DonJad\"},\"url\":\"http:\/\/cadsupport.ru\/en\/author\/donjad\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"How to use Tekla Macro Scripts with Tekla API - CadSupport","description":"Tekla Macro Scripts, how to implement functionality to your application example. Good way to avoid Tekla Open API limitations.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/","og_locale":"en_US","og_type":"article","og_title":"How to use Tekla Macro Scripts with Tekla API - CadSupport","og_description":"Tekla Macro Scripts, how to implement functionality to your application example. Good way to avoid Tekla Open API limitations.","og_url":"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/","og_site_name":"CadSupport","article_published_time":"2016-04-19T10:45:12+00:00","article_modified_time":"2024-04-10T04:49:34+00:00","og_image":[{"url":"http:\/\/cadsupport.ru\/en\/wp-content\/uploads\/2016\/04\/Tekla-macro-script-using-in-application.jpg"}],"author":"DonJad","twitter_card":"summary_large_image","twitter_misc":{"Written by":"DonJad","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/","url":"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/","name":"How to use Tekla Macro Scripts with Tekla API - CadSupport","isPartOf":{"@id":"http:\/\/cadsupport.ru\/en\/#website"},"primaryImageOfPage":{"@id":"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/#primaryimage"},"image":{"@id":"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/#primaryimage"},"thumbnailUrl":"http:\/\/cadsupport.ru\/en\/wp-content\/uploads\/2016\/04\/Tekla-macro-script-using-in-application.jpg","datePublished":"2016-04-19T10:45:12+00:00","dateModified":"2024-04-10T04:49:34+00:00","author":{"@id":"http:\/\/cadsupport.ru\/en\/#\/schema\/person\/b57bc479c7822ae8efbc5a5b624a3b8a"},"description":"Tekla Macro Scripts, how to implement functionality to your application example. Good way to avoid Tekla Open API limitations.","breadcrumb":{"@id":"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/#primaryimage","url":"http:\/\/cadsupport.ru\/en\/wp-content\/uploads\/2016\/04\/Tekla-macro-script-using-in-application.jpg","contentUrl":"http:\/\/cadsupport.ru\/en\/wp-content\/uploads\/2016\/04\/Tekla-macro-script-using-in-application.jpg","width":232,"height":240,"caption":"Tekla Macro Scripts - using in c# application or script"},{"@type":"BreadcrumbList","@id":"http:\/\/cadsupport.ru\/en\/how-to-use-tekla-macro-script-with-tekla-api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"http:\/\/cadsupport.ru\/en\/"},{"@type":"ListItem","position":2,"name":"How to use Tekla Macro Scripts with Tekla API"}]},{"@type":"WebSite","@id":"http:\/\/cadsupport.ru\/en\/#website","url":"http:\/\/cadsupport.ru\/en\/","name":"CadSupport","description":"smart solutions for engineering duties","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"http:\/\/cadsupport.ru\/en\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Person","@id":"http:\/\/cadsupport.ru\/en\/#\/schema\/person\/b57bc479c7822ae8efbc5a5b624a3b8a","name":"DonJad","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"http:\/\/cadsupport.ru\/en\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/b22cdec01f0612764c8b311b89954151bfb042524440d622849757864e132a55?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/b22cdec01f0612764c8b311b89954151bfb042524440d622849757864e132a55?s=96&d=mm&r=g","caption":"DonJad"},"url":"http:\/\/cadsupport.ru\/en\/author\/donjad\/"}]}},"_links":{"self":[{"href":"http:\/\/cadsupport.ru\/en\/wp-json\/wp\/v2\/posts\/112","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/cadsupport.ru\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/cadsupport.ru\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/cadsupport.ru\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/cadsupport.ru\/en\/wp-json\/wp\/v2\/comments?post=112"}],"version-history":[{"count":10,"href":"http:\/\/cadsupport.ru\/en\/wp-json\/wp\/v2\/posts\/112\/revisions"}],"predecessor-version":[{"id":202,"href":"http:\/\/cadsupport.ru\/en\/wp-json\/wp\/v2\/posts\/112\/revisions\/202"}],"wp:attachment":[{"href":"http:\/\/cadsupport.ru\/en\/wp-json\/wp\/v2\/media?parent=112"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/cadsupport.ru\/en\/wp-json\/wp\/v2\/categories?post=112"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/cadsupport.ru\/en\/wp-json\/wp\/v2\/tags?post=112"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}