API Reference

Detailed and full API reference helps you master Tekla development

  1. Tekla Structures
  2. Tekla Open API 2023 Reference
  3. Grid Class

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

Grid Class

The Grid class defines a user defined (possibly magnetic) set of planes helping in modeling work. A grid has grid plane instances as children.
Inheritance Hierarchy

Namespace:  Tekla.Structures.Model
Assembly:  Tekla.Structures.Model (in Tekla.Structures.Model.dll) Version: 2023.0.1
Syntax
Copy
[SerializableAttribute]
public sealed class Grid : GridBase

The Grid type exposes the following members.

Constructors
  NameDescription
Public methodGrid
Creates a new grid instance.

The default values are as follows:

  • Name = "Grid";
  • CoordinateX = "0.00 4*3000.00";
  • CoordinateY = "0.00 5*6000.00";
  • CoordinateZ = "0.00 6000.00 8000.00 9000.00";
  • LabelX = "A B C D E";
  • LabelY = "1 2 3 4 5 6";
  • LabelZ = "+0 +6000 +8000 +9000";
  • ExtensionLeftX = 2000.0;
  • ExtensionLeftY = 2000.0;
  • ExtensionLeftZ = 2000.0;
  • ExtensionRightX = 2000.0;
  • ExtensionRightY = 2000.0;
  • ExtensionRightZ = 2000.0;
  • IsMagnetic = false;
Top
Properties
  NameDescription
Public propertyColor
Gets or sets the color of the grid.
Public propertyCoordinateX
The coordinates for the X-axis.
Public propertyCoordinateY
The coordinates for the Y-axis.
Public propertyCoordinateZ
The coordinates for the Z-axis.
Public propertyExtensionForMagneticArea Obsolete.
The extension for the magnetic area.
Public propertyExtensionLeftX
The extension to the left X-axis.
Public propertyExtensionLeftY
The extension to the left Y-axis.
Public propertyExtensionLeftZ
The extension to the left Z-axis.
Public propertyExtensionRightX
The extension to the right X-axis.
Public propertyExtensionRightY
The extension to the right Y-axis.
Public propertyExtensionRightZ
The extension to the right Z-axis.
Public propertyFontColor
Gets or sets font color for the grid labels
(Inherited from GridBase.)
Public propertyFontSize
Gets or sets font size for the grid labels
(Inherited from GridBase.)
Public propertyIdentifier
The identifier of the object.
(Inherited from Object.)
Public propertyIsMagnetic
Gets or sets whether the grid is magnetic or not.
(Inherited from GridBase.)
Public propertyIsUpToDate
Gets if the object does not have a modification which is not shared.
(Inherited from ModelObject.)
Public propertyLabelX
The labels for the X-axis.
Public propertyLabelY
The labels for the Y-axis.
Public propertyLabelZ
The labels for the Z-axis.
Public propertyModificationTime
Gets latest time of the object was modified or created.
(Inherited from ModelObject.)
Public propertyName
Gets or sets the name of the grid.
(Inherited from GridBase.)
Public propertyOrigin
Gets or sets the origin of the grid
(Inherited from GridBase.)
Top
Methods
  NameDescription
Public methodCompareTo
Compares Identifiers of model objects.
(Inherited from ModelObject.)
Public methodDelete
Deletes the grid with the given ID.
(Inherited from GridBase.)
Public methodEquals
Check if Identifiers of model objects are same.
(Inherited from ModelObject.)
Public methodCode exampleGetAllReportProperties
Retrieves all properties for the model object in one hashtable. Type for the returned value must be checked using type casting.
(Inherited from ModelObject.)
Public methodGetAllUserProperties
Retrieves all properties for the model object in one hashtable. Type for the returned value must be checked using type casting.
(Inherited from ModelObject.)
Public methodGetChildren
Returns an enumerator of all the children model objects.
(Inherited from ModelObject.)
Public methodGetCoordinateSystem
Returns the coordinate system for the given model object.
(Inherited from ModelObject.)
Public methodGetDoubleReportProperties
Retrieves multiple double report properties for the model object. It is faster to fetch multiple properties at once.
(Inherited from ModelObject.)
Public methodGetDoubleUserProperties
Retrieves all double properties for the model object.
(Inherited from ModelObject.)
Public methodGetDynamicStringProperty
Gets a dynamic string property from the model object.
(Inherited from ModelObject.)
Public methodGetFatherComponent
Returns the father component of the model object.
(Inherited from ModelObject.)
Public methodGetHierarchicObjects
Returns an enumerator of all the connected hierarchic objects.
(Inherited from ModelObject.)
Public methodGetIntegerReportProperties
Retrieves multiple integer report properties for the model object. It is faster to fetch multiple properties at once.
(Inherited from ModelObject.)
Public methodGetIntegerUserProperties
Retrieves all integer properties for the model object.
(Inherited from ModelObject.)
Public methodGetPhase
Retrieves the phase of the model object (the phase number, the phase name, the phase comment and whether the phase is the current one or not).
(Inherited from ModelObject.)
Public methodGetReportProperty(String, Double)
Retrieves a double property of the report for the model object.
(Inherited from ModelObject.)
Public methodGetReportProperty(String, Int32)
Retrieves an integer property of the report for the model object.
(Inherited from ModelObject.)
Public methodGetReportProperty(String, String)
Retrieves a string property of the report for the model object.
(Inherited from ModelObject.)
Public methodGetStringReportProperties
Retrieves multiple string report properties for the model object. It is faster to fetch multiple properties at once.
(Inherited from ModelObject.)
Public methodGetStringUserProperties
Retrieves all string properties for the model object.
(Inherited from ModelObject.)
Public methodGetUserProperty(String, Double)
Retrieves a double property for the model object.
(Inherited from ModelObject.)
Public methodGetUserProperty(String, Int32)
Retrieves an integer property for the model object.
(Inherited from ModelObject.)
Public methodGetUserProperty(String, String)
Retrieves a string property for the model object.
(Inherited from ModelObject.)
Public methodInsert
Inserts the grid into the model.
(Inherited from GridBase.)
Public methodModify
Modifies the grid with the given ID.
(Inherited from GridBase.)
Public methodSelect
Selects the grid with the given ID.
(Inherited from GridBase.)
Public methodSetDynamicStringProperty
Sets a dynamic string property for the model object.
(Inherited from ModelObject.)
Public methodSetLabel
Sets a label for an object when a new instance is created, this method must be called before Insert. The label is used in plug-ins for identifying the changed object in modification.
(Inherited from ModelObject.)
Public methodSetPhase
Sets the phase of the model object.
(Inherited from ModelObject.)
Public methodSetUserProperties
Sets multiple properties for the model object.
(Inherited from ModelObject.)
Public methodSetUserProperty(String, Double)
Sets a double property for the model object.
(Inherited from ModelObject.)
Public methodSetUserProperty(String, Int32)
Sets an integer property for the model object.
(Inherited from ModelObject.)
Public methodSetUserProperty(String, String)
Sets a string property for the model object.
(Inherited from ModelObject.)
Top
Examples
Copy
using Tekla.Structures.Model;

public class Example
{
       public void Example1()
       {
           Grid Grid = new Grid();

           Grid.IsMagnetic = true;

           bool Result = false;
           Result = Grid.Insert();
       }
}
See Also