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.

MarkBase Class

The MarkBase class contains general mark information and can be selected and modified with the general attributes.
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 abstract class MarkBase : DrawingObject, 
	IObjectAlignedBoundingBox, IAxisAlignedBoundingBox, IMovableRelative, IPlacing, IHasChildren, 
	IHideable

The MarkBase type exposes the following members.

Properties
  Name Description
Public property Attributes
Gets or sets the mark base attributes.
Public property Hideable
Accesses the information if this object is hidden or not or if it should be.
Public property InsertionPoint
The insertion point of the mark.
Public property IsAssociativeNote
Gets a value indicating whether the mark is an associative note.
Public property Placing
The current placing of the object. See the placing types for different placing options.
Public property QueryReturnValue
Status information about the latest database operation (select, insert, modify, delete).
(Inherited from DatabaseObject.)
Top
Methods
  Name Description
Public method Delete
Deletes the instance from the database.
(Inherited from DatabaseObject.)
Public method GetAxisAlignedBoundingBox
Returns the axis aligned bounding box of the text (rectangle format).
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 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 GetObjectAlignedBoundingBox
Returns the object aligned bounding box of the text (rectangle format).
Public method GetObjects
Gets the children objects of the current object.
Public method GetObjects(Type)
Gets the children objects of the current object that are of certain types.
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 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 object instance into the database. The inserted instance must be of a real type.
(Inherited from DatabaseObject.)
Public method IsEqual
Compares the current object with the given object. Checks every field of both objects for equality.
(Inherited from DrawingObject.)
Public method IsSameDatabaseObject
Returns true if the current object and the given object are referencing the same database object.
(Inherited from DatabaseObject.)
Public method Modify
Modifies the instance in the database.
(Inherited from DatabaseObject.)
Public method MoveObjectRelative
Moves the object using the move vector.
Public method Select
Selects the object instance from the database.
(Inherited from DatabaseObject.)
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.)
Top
Examples
The following example enumerates through all marks in all views and changes their frame types to sharpened and their frame colors to red.
using Tekla.Structures.Drawing;

public class Example
{
       public void Example1()
       {
           DrawingHandler MyDrawingHandler = new DrawingHandler();
           if(MyDrawingHandler.GetConnectionStatus())
           {
               MarkBase MyMarkBase;
               DrawingObjectEnumerator views = MyDrawingHandler.GetActiveDrawing().GetSheet().GetAllViews();
               while(views.MoveNext())
               {
                   DrawingObjectEnumerator allObjects = (views.Current as ViewBase).GetAllObjects();
                   while(allObjects.MoveNext())
                   {
                       if(allObjects.Current is MarkBase)
                       {
                           MyMarkBase = allObjects.Current as MarkBase;
                           MyMarkBase.Attributes.Frame.Color = DrawingColors.Red;
                           MyMarkBase.Attributes.Frame.Type = FrameTypes.Sharpened;
                           MyMarkBase.Modify();
                       }
                   }
               }
           }
       }
}
See Also