API Reference

Detailed and full API reference helps you master Tekla development

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

Image Class

The Image class defines an image that can be inserted into a drawing.
Inheritance Hierarchy

Namespace:  Tekla.Structures.Drawing
Assembly:  Tekla.Structures.Drawing (in Tekla.Structures.Drawing.dll) Version: 2022.0.13611
Syntax
[SerializableAttribute]
public sealed class Image : EmbeddedObjectBase

The Image type exposes the following members.

Constructors
  NameDescription
Public methodImage(ViewBase, Point, String)
Initializes a new instance of the Image class with the given parameters.
Public methodImage(ViewBase, Point, String, EmbeddedObjectAttributes)
Initializes a new instance of the Image class using the specified attributes.
Public methodImage(ViewBase, Point, Size, String)
Initializes a new instance of the Image class with the given parameters.
Public methodImage(ViewBase, Point, Size, String, EmbeddedObjectAttributes)
Initializes a new instance of the Image class using the specified attributes.
Top
Properties
  NameDescription
Public propertyAngle
Gets or sets the angle (in degrees).
(Inherited from EmbeddedObjectBase.)
Public propertyAttributes
Gets or sets the attributes.
(Inherited from EmbeddedObjectBase.)
Public propertyFileName
Gets or sets the file name defining the embedded object.
(Inherited from EmbeddedObjectBase.)
Public propertyInsertionPoint
Gets or sets the insertion point.
(Inherited from EmbeddedObjectBase.)
Public propertyQueryReturnValue
Status information about the latest database operation (select, insert, modify, delete).
(Inherited from DatabaseObject.)
Public propertySize
Gets or sets the size of the frame of the embedded object.
(Inherited from EmbeddedObjectBase.)
Top
Methods
  NameDescription
Public methodDelete
Deletes the embedded object.
(Inherited from EmbeddedObjectBase.)
Public methodGetAxisAlignedBoundingBox
Gets the bounding box for the current object in the global axis coordinate system.
(Inherited from EmbeddedObjectBase.)
Public methodGetDoubleUserProperties(DictionaryString, Double)
Retrieves all double user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public methodGetDoubleUserProperties(ListString, DictionaryString, Double)
Retrieves all double user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public methodGetDrawing
Gets the drawing where the drawing object is.
(Inherited from DrawingObject.)
Public methodGetIntegerUserProperties(DictionaryString, Int32)
Retrieves all integer user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public methodGetIntegerUserProperties(ListString, DictionaryString, Int32)
Retrieves all integer user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public methodGetObjectAlignedBoundingBox
Gets the bounding box for the current object in its local coordinate system.
(Inherited from EmbeddedObjectBase.)
Public methodGetRelatedObjects
Gets the related objects of the current object.
(Inherited from DrawingObject.)
Public methodGetRelatedObjects(Type)
Gets the related objects of the current object that are of certain types.
(Inherited from DrawingObject.)
Public methodGetStringUserProperties(DictionaryString, String)
Retrieves all string user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public methodGetStringUserProperties(ListString, DictionaryString, String)
Retrieves all string user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public methodGetUserProperty(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 methodGetUserProperty(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 methodGetUserProperty(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 methodGetView
Gets the view where the drawing object is.
(Inherited from DrawingObject.)
Public methodInsert
Inserts the embedded object.
(Inherited from EmbeddedObjectBase.)
Public methodIsEqual
Compares the current object with an object of the same type.
(Inherited from EmbeddedObjectBase.)
Public methodIsSameDatabaseObject
Returns true if the current object and the given object are referencing the same database object.
(Inherited from DatabaseObject.)
Public methodModify
Modifies the embedded object.
(Inherited from EmbeddedObjectBase.)
Public methodCode exampleMoveObjectRelative
Moves the object according to the given move vector.
(Inherited from EmbeddedObjectBase.)
Public methodResize
Resizes the object. The scaling type is changed to ScaleToFit.
(Inherited from EmbeddedObjectBase.)
Public methodSelect
Selects the embedded object.
(Inherited from EmbeddedObjectBase.)
Public methodSetUserProperty(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 methodSetUserProperty(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 methodSetUserProperty(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 methodToString
Changes the string presentation of the drawing object.
(Inherited from DrawingObject.)
Top
See Also