Tekla Open API

Detailed and full API reference helps you master Tekla Open API

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

Plugin Class

The Plugin class represents a drawing plug-in.
Inheritance Hierarchy

Namespace:  Tekla.Structures.Drawing
Assembly:  Tekla.Structures.Drawing (in Tekla.Structures.Drawing.dll) Version: 2018.1.0.0 (2018.1.0.0)
Syntax
[SerializableAttribute]
public sealed class Plugin : DrawingObject

The Plugin type exposes the following members.

Constructors
  Name Description
Public method Plugin
Creates a new plug-in instance.
Top
Properties
  Name Description
Public property Attributes
Gets or sets the attributes of the current object. Only attributes of the same type as the object are allowed.
(Inherited from DrawingObject.)
Public property Name
Gets the name of the plug-in.
Public property QueryReturnValue
Status information about the latest database operation (select, insert, modify, delete).
(Inherited from DatabaseObject.)
Top
Methods
  Name Description
Public method ApplyStandardValues
Applies the values of the specified file as the default values for the dialog belonging to this plug-in. This will affect each Insert call of the plug-ins with the same name.
Public method Delete
Deletes the plug-in from the current drawing database.
(Overrides DatabaseObjectDelete.)
Public method GetDoubleAttribute
Gets the value of the specified double attribute of the plug-in.
Public method GetDoubleUserProperties(DictionaryString, Double)
Retrieves all double user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public method GetDoubleUserProperties(ListString, DictionaryString, Double)
Retrieves all double user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public method GetDrawing
Gets the drawing where the drawing object is.
(Inherited from DrawingObject.)
Public method GetIntAttribute
Gets the value of the specified int attribute of the plug-in.
Public method GetIntegerUserProperties(DictionaryString, Int32)
Retrieves all integer user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public method GetIntegerUserProperties(ListString, DictionaryString, Int32)
Retrieves all integer user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public method GetRelatedObjects
Gets the related objects of the current object.
(Inherited from DrawingObject.)
Public method GetRelatedObjects(Type)
Gets the related objects of the current object that are of certain types.
(Inherited from DrawingObject.)
Public method GetStringAttribute
Gets the value of the specified string attribute of the plug-in.
Public method GetStringUserProperties(DictionaryString, String)
Retrieves all string user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public method GetStringUserProperties(ListString, DictionaryString, String)
Retrieves all string user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public method GetUserProperty(String, Double)
Gets a double property from the drawing object. The object has to be in a drawing before the method can be used.
(Inherited from DatabaseObject.)
Public method GetUserProperty(String, Int32)
Gets an integer property from the drawing object. The object has to be in a drawing before the method can be used.
(Inherited from DatabaseObject.)
Public method GetUserProperty(String, String)
Gets a string property from the drawing object. The object has to be in a drawing before the method can be used.
(Inherited from DatabaseObject.)
Public method GetView
Gets the view where the drawing object is.
(Inherited from DrawingObject.)
Public method Insert
Inserts the plug-in into the current drawing database.
(Overrides DatabaseObjectInsert.)
Public method IsEqual
Compares the current object with an object of the same type.
(Overrides DrawingObjectIsEqual(Object).)
Public method IsSameDatabaseObject
Returns true if the current object and the given object are referencing the same database object.
(Inherited from DatabaseObject.)
Public method LoadStandardValues
Sets the values from the specified file to this plug-in.
Public method Modify
Modifies the plug-in in the current drawing database.
(Overrides DatabaseObjectModify.)
Public method Select
Selects the plug-in from the current drawing database.
(Overrides DatabaseObjectSelect.)
Public method SetAttribute(String, Double)
Sets the specified attribute of the plug-in to the given value. NOTE! Only works on already inserted plug-ins.
Public method SetAttribute(String, Int32)
Sets the specified attribute of the plug-in to the given value. NOTE! Only works on already inserted plug-ins.
Public method SetAttribute(String, String)
Sets the specified attribute of the plug-in to the given value. NOTE! Only works on already inserted plug-ins.
Public method SetPickerInput
Defines the sequence of inputs to use in place of interactive picks when the plug-in is inserted to a drawing.
Public method SetUserProperty(String, Double)
Sets a double property for the drawing object. The object has to be in a drawing before the method can be used.
(Inherited from DatabaseObject.)
Public method SetUserProperty(String, Int32)
Sets an integer property for the drawing object. The object has to be in a drawing before the method can be used.
(Inherited from DatabaseObject.)
Public method SetUserProperty(String, String)
Sets a string property for the drawing object. The object has to be in a drawing before the method can be used.
(Inherited from DatabaseObject.)
Public method ToString
Changes the string presentation of the drawing object.
(Inherited from DrawingObject.)
Public method TryGetAttribute(String, Double)
Gets the value of the specified double attribute of the plug-in.
Public method TryGetAttribute(String, Int32)
Gets the value of the specified int attribute of the plug-in.
Public method TryGetAttribute(String, String)
Gets the value of the specified string attribute of the plug-in.
Public method TrySetAttribute(String, Double)
Sets the specified attribute of the plug-in to the given value. NOTE! Only works on already inserted plug-ins.
Public method TrySetAttribute(String, Int32)
Sets the specified attribute of the plug-in to the given value. NOTE! Only works on already inserted plug-ins.
Public method TrySetAttribute(String, String)
Sets the specified attribute of the plug-in to the given value. NOTE! Only works on already inserted plug-ins.
Top
Examples
The following example demonstrates how to insert a plug-in into a view. The plug-in used in this example is the Center of gravity dimensions plug-in (COGDimensioning).
using Tekla.Structures.Drawing;
using Tekla.Structures.Geometry3d;

public class Example
{
    public void Example1()
    {
        DrawingHandler MyDrawingHandler = new DrawingHandler();
        DrawingObjectEnumerator allViews = MyDrawingHandler.GetActiveDrawing().GetSheet().GetAllViews();
        allViews.MoveNext();
        ViewBase curView = allViews.Current as ViewBase;

        Plugin myPlugin = new Plugin(curView, "COGDimensioning");

        PluginPickerInput newPluginInput = new PluginPickerInput();
        newPluginInput.Add(new PickerInputPoint(curView, new Point(100, 200)));
        newPluginInput.Add(new PickerInputPoint(curView, new Point(300, 400)));
        myPlugin.SetPickerInput(newPluginInput);

        myPlugin.Insert(); // Inserts the plug-in, the plug-in's DefineInput method's UI.Picker calls will use the given data above.
        // After the Insert returns the Plugin is inserted into the drawing view.
        // Alternatively, if there are some errors during the insertion of the plug-in,
        // exceptions may be thrown or the return value of Insert will be false.
    }
}
See Also