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.

ProjectInfo Class

The ProjectInfo class provides project information about the currently open Tekla Structures model.
Inheritance Hierarchy
SystemObject
  Tekla.Structures.ModelProjectInfo

Namespace:  Tekla.Structures.Model
Assembly:  Tekla.Structures.Model (in Tekla.Structures.Model.dll) Version: 2019.0.0.0 (2019.0.0.0)
Syntax
[SerializableAttribute]
public sealed class ProjectInfo

The ProjectInfo type exposes the following members.

Properties
  Name Description
Public property Address
The address information of the ProjectInfo.
Public property Builder
The builder information of the ProjectInfo.
Public property Country
The address country information of the ProjectInfo.
Public property Description
The description of the ProjectInfo.
Public property Designer
The designer information of the ProjectInfo.
Public property EndDate
The end date information of the ProjectInfo.
Public property GUID
The GUID field of the ProjectInfo.
Public property Info1
The Info 1 field of the ProjectInfo.
Public property Info2
The Info 2 field of the ProjectInfo.
Public property Location
The address location information of the ProjectInfo.
Public property ModelSharingLocalPath Obsolete.
The local folder for model sharing. Is null if not defined for the model.
Public property ModelSharingServerPath Obsolete.
The server path for model sharing. Is null if not defined for the model.
Public property Name
The name information of the ProjectInfo.
Public property Object
The object information of the ProjectInfo.
Public property PostalBox
The address postal box information of the ProjectInfo.
Public property PostalCode
The address postal code information of the ProjectInfo.
Public property ProjectNumber
The project number information of the ProjectInfo.
Public property Region
The address region information of the ProjectInfo.
Public property StartDate
The start date information of the ProjectInfo.
Public property Town
The address town information of the ProjectInfo.
Top
Methods
  Name Description
Public methodStatic member GetBasePointByGuid
Gets a base point by given guid.
Public methodStatic member GetBasePointByName
Gets a base point by given name.
Public methodStatic member GetBasePoints
Gets all available base points as a list.
Public methodStatic member GetCurrentCoordsysBasePoint
Gets the current base point, if set.
Public method GetDoubleUserProperties
Retrieves all double properties for the ProjectInfo.
Public method GetIntegerUserProperties
Retrieves all integer properties for the ProjectInfo.
Public methodStatic member GetProjectBasePoint
Gets the project base point, if any set.
Public method GetStringUserProperties
Retrieves all string properties for the ProjectInfo.
Public method GetUserProperty(String, Double)
Retrieves a double property for the ProjectInfo.
Public method GetUserProperty(String, Int32)
Retrieves an integer property for the ProjectInfo.
Public method GetUserProperty(String, String)
Retrieves a string property for the ProjectInfo.
Public method Modify
Modifies the current project information.
Public methodStatic member SetCurrentCoordsysToBasePoint
Sets the current base point.
Public method SetUserProperty(String, Double)
Sets a double property for the ProjectInfo.
Public method SetUserProperty(String, Int32)
Sets an integer property for the ProjectInfo.
Public method SetUserProperty(String, String)
Sets a string property for the ProjectInfo.
Top
Examples
The following example gets the project information and shows the value of the Name property in a message dialog:
using Tekla.Structures.Model;
using System.Windows.Forms;

public class Example
{
    public void Example1()
    {
        Model CurrentModel = new Model();
        ProjectInfo ProjectInfo = CurrentModel.GetProjectInfo();

        if (CurrentModel.GetConnectionStatus())
        {
            if (ProjectInfo.Name.Length > 0)
            {
                MessageBox.Show(ProjectInfo.Name);
            }
        }
    }
}
See Also