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.

ContainerView Class

The ContainerView class contains container views that contain other drawing objects, including other views and container views. The drawing sheet is a container view. Container views do not contain drawing representations of model objects.
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 ContainerView : ViewBase

The ContainerView type exposes the following members.

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 ExtremaCenter
Gets the view extrema center.
(Inherited from ViewBase.)
Public property FrameOrigin
The vector from the view origin to the frame origin.
(Inherited from ViewBase.)
Public property Height
The height of the view frame in paper coordinates.
(Inherited from ViewBase.)
Public property IsSheet
Gets a value indicating whether the container view is the drawing's sheet.
(Inherited from ViewBase.)
Public property Origin
The view origin coordinates in the sheet.
(Inherited from ViewBase.)
Public property QueryReturnValue
Status information about the latest database operation (select, insert, modify, delete).
(Inherited from DatabaseObject.)
Public property Width
The width of the view frame in paper coordinates.
(Inherited from ViewBase.)
Top
Methods
  Name Description
Public method Delete
Deletes the view and its children objects from the database.
(Inherited from ViewBase.)
Public method GetAllObjects
Gets all the objects and their children objects in the view.
(Inherited from ViewBase.)
Public method GetAllObjects(Type)
Gets all the objects and their children objects in the view that are of a certain type.
(Inherited from ViewBase.)
Public method GetAllObjects(Type)
Gets all the objects and their children objects in the view that are of certain types.
(Inherited from ViewBase.)
Public method GetAllViews
Gets all the views that are placed on the container view and their children views.
Public method GetAxisAlignedBoundingBox
The view size in paper coordinates.
(Inherited from ViewBase.)
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 GetModelObjects
Gets the drawing model objects based on given model object identifier. If used from sheet model objects from all views are returned.
(Inherited from ViewBase.)
Public method GetObjects
Gets the objects in the view. Does not return child objects (single dimensions, grid lines, views).
(Inherited from ViewBase.)
Public method GetObjects(Type)
Gets the objects in the view that are of certain types. Does not return child objects (single dimensions, grid lines, views).
(Inherited from ViewBase.)
Public method GetOriginalDrawing
Gets the drawing on which the view was originally created. @see DrawingObject.GetDrawing() for retrieving the current drawing the object resides on.
(Inherited from ViewBase.)
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 GetViews
Gets all the views that are placed on the container view.
Public method Insert
Inserts the view to the database.
(Inherited from ViewBase.)
Public method IsEqual
Compares the current object with an object of the same type.
(Overrides ViewBaseIsEqual(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 Modify
Modifies the view in the database.
(Inherited from ViewBase.)
Public method Select
Selects the view from the database.
(Inherited from ViewBase.)
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 uses a container view to create and insert a new view to the active drawing. A drawing must be open when executing code.
using Tekla.Structures.Drawing;
using Tekla.Structures.Geometry3d;

public class Example
{
       public void Example1()
       {
           DrawingHandler MyDrawingHandler = new DrawingHandler();
           if(MyDrawingHandler.GetConnectionStatus())
           {
               Drawing Drawing = MyDrawingHandler.GetActiveDrawing();
               CoordinateSystem CoordinateSystem = new CoordinateSystem(new Point(), new Vector(1, 0, 0), new Vector(0, 1, 0));

               ContainerView ContainerView = Drawing.GetSheet();

               View newView = new View(ContainerView, CoordinateSystem, CoordinateSystem, new AABB(new Point(0, 0), new Point(1000, 1000, 1000)));
               newView.Insert();
           }
       }
}
See Also