cPropTendonSetProp Method

Defines a tendon property

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int SetProp(
	string Name,
	string MatProp,
	int ModelingOption,
	double Area,
	int Color = -1,
	string Notes = "",
	string GUID = ""
)

Parameters

Name
Type: SystemString
The name of an existing or new tendon property. If this is an existing property, that property is modified; otherwise, a new property is added.
MatProp
Type: SystemString
The name of the material property assigned to the tendon property.
ModelingOption
Type: SystemInt32
This is either 1 or 2, indicating the tendon modeling option.
ValueModeling Option
1Model tendon as loads
2Model tendon as elements
Area
Type: SystemDouble
The cross-sectional area of the tendon. [L2]
Color (Optional)
Type: SystemInt32
Notes (Optional)
Type: SystemString
GUID (Optional)
Type: SystemString
The GUID (global unique identifier), if any, assigned to the property. If this item is input as Default, the program assigns a GUID to the property

Return Value

Type: Int32
Returns zero if the property is successfully defined; otherwise it returns a nonzero value.
Remarks
Modeling tendons as elements (ModelingOption = 2) is not supported in ETABS.
Examples
VB
Copy
Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1
       Dim Name As String

   'create ETABS object
       EtabsObject = CreateObject("CSI.ETABS.API.ETABSObject")

   'start ETABS application
       ret = EtabsObject.ApplicationStart()

   'create SapModel object
       SapModel = EtabsObject.SapModel

   'initialize model
       ret = SapModel.InitializeNewModel()

   'create steel deck template model
       ret = SapModel.File.NewSteelDeck(4,12,12,4,4,24,24)

   'add tendon material
       ret = SapModel.PropMaterial.AddQuick(Name, eMatType.Tendon, , , , , , eMatTypeTendon.ASTM_A416Gr270)

   'set new tendon property
       ret = SapModel.PropTendon.SetProp("T1", Name, 1, 2.25)

   'close ETABS
       EtabsObject.ApplicationExit(False)

   'clean up variables
       SapModel = Nothing
       EtabsObject = Nothing
   End Sub
See Also