cFrameObjSetSelected Method

Sets the selected status for a frame object.

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int SetSelected(
	string Name,
	bool Selected,
	eItemType ItemType = eItemType.Objects
)

Parameters

Name
Type: SystemString
The name of an existing frame object or group depending on the value of the ItemType item.
Selected
Type: SystemBoolean
This item is True if the specified frame object is selected, otherwise it is False.
ItemType (Optional)
Type: ETABS2016eItemType
This is one of the following items in the eItemType enumeration:
  • Object = 0
  • Group = 1
  • SelectedObjects = 2

If this item is Objects, the selected status is set for the frame object specified by the Name item.

If this item is Group, the selected status is set for all frame objects in the group specified by the Name item.

If this item is SelectedObjects, the selected status is set for all selected frame objects and the Name item is ignored.

Return Value

Type: Int32
Returns zero if the selected status is successfully set, otherwise it returns a nonzero value.
Remarks
Examples
VB
Copy
Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1

   '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)

   'set point selected
       ret = SapModel.FrameObj.SetSelected("8", True)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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