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.

View Class

The View class contains methods related to views. Views are views that contain other drawing objects, excluding other views. Views also 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 View : ViewBase

The View type exposes the following members.

Constructors
  Name Description
Public method View(ContainerView, CoordinateSystem, CoordinateSystem, ArrayList)
Creates a new view instance with the given coordinate systems and part list.
Public method View(ContainerView, CoordinateSystem, CoordinateSystem, AABB)
Creates a new view instance with the given coordinate systems and model area.
Public method View(ContainerView, CoordinateSystem, CoordinateSystem, ArrayList, String)
Creates a new view instance with the given coordinate systems, part list and attributes file's filename.
Public method View(ContainerView, CoordinateSystem, CoordinateSystem, AABB, String)
Creates a new view instance with the given coordinate systems, model area and attributes file's filename.
Top
Properties
  Name Description
Public property Attributes
The view attributes.
Public property DisplayCoordinateSystem
The coordinate system of the display plane. This can be used to transform global points from the model that is to be inserted in the view.
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 Name
The name of the view.
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 RestrictionBox
The axis aligned bounding box that represents the volume of the view.
Public property ViewCoordinateSystem
The coordinate system of the view plane.
Public property ViewType
The view type information.
Public property Width
The width of the view frame in paper coordinates.
(Inherited from ViewBase.)
Top
Methods
  Name Description
Public methodStatic member Create3dView(Drawing, Point, ViewViewAttributes, View)
Generates a new 3d view on the sheet of the given drawing.
Public methodStatic member Create3dView(Drawing, CoordinateSystem, CoordinateSystem, AABB, Point, ViewViewAttributes, View)
Generates a new 3d view on the sheet of the given drawing using given view plane and display plane.
Public methodStatic member CreateBackView
Generates a new back view on the sheet of the given drawing.
Public methodStatic member CreateBottomView
Generates a new bottom view on the sheet of the given drawing.
Public methodStatic member CreateCurvedSectionView
Generates a new curved section view on the sheet and the associated section mark for the specified view.
Public methodStatic member CreateDetailView
Generates a new detail view on the sheet and the associated detail mark for the specified view.
Public methodStatic member CreateFrontView
Generates a new front view on the sheet of the given drawing.
Public methodStatic member CreateSectionView
Generates a new section view on the sheet and the associated section mark for the specified view.
Public methodStatic member CreateTopView
Generates a new top view on the sheet of the given drawing.
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 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 model objects that are in the view.
Public method GetModelObjects(Identifier)
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 GetVisibleAreaRestrictionBoxes
Gets the restriction boxes that represent the visible areas of the 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 RotateViewOnAxisX
Rotate the view on the X axis.
Public method RotateViewOnAxisY
Rotate the view on the Y axis.
Public method RotateViewOnAxisZ
Rotate the view on the Z axis.
Public method RotateViewOnDrawingPlane
Rotate the view on the drawings plane. This works just like the user interface command "Rotate view".
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 creates and inserts a new view to the active drawing. A drawing must be open when executing the 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));

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