Tabular Editor API
This is the API documentation for Tabular Editor's C# scripting capabilities.
Specifically, the objects available for scripting are those found in the TOMWrapper.dll and TabularEditor3.Shared.dll libraries.
When writing a script in Tabular Editor, the two most common objects used are
Selected, which lets you access objects currently selected in the TOM Explorer, and
Model, which lets you access any object within the currently loaded data model. Both these objects are available as member properties on the global
In addition, the
ScriptHost object holds static methods which are exposed to the script as global methods (i.e. methods you can call without the
ScriptHost prefix). These methods are also known as C# Script Helper Methods.
// Displays a dialog to the user prompting them to select a measure: var myMeasure = SelectMeasure(); // Creates a new measure on the first table of the model, with the same name and expression // as the previously selected measure: Model.Tables.First().AddMeasure(myMeasure.Name + " copy", myMeasure.Expression);
For more examples, see Useful script snippets.