cGroupSetGroup Method

Sets the group data.

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
int SetGroup(
	string Name,
	int Color = -1,
	bool SpecifiedForSelection = true,
	bool SpecifiedForSectionCutDefinition = true,
	bool SpecifiedForSteelDesign = true,
	bool SpecifiedForConcreteDesign = true,
	bool SpecifiedForAluminumDesign = true,
	bool SpecifiedForColdFormedDesign = true,
	bool SpecifiedForStaticNLActiveStage = true,
	bool SpecifiedForBridgeResponseOutput = true,
	bool SpecifiedForAutoSeismicOutput = false,
	bool SpecifiedForAutoWindOutput = false,
	bool SpecifiedForMassAndWeight = true
)

Parameters

Name
Type: SystemString
This is the name of a group. If this is the name of an existing group, that group is modified, otherwise a new group is added.
Color (Optional)
Type: SystemInt32
SpecifiedForSelection (Optional)
Type: SystemBoolean
This item is True if the group is specified to be used for selection; otherwise it is False.
SpecifiedForSectionCutDefinition (Optional)
Type: SystemBoolean
This item is True if the group is specified to be used for defining section cuts; otherwise it is False.
SpecifiedForSteelDesign (Optional)
Type: SystemBoolean
This item is True if the group is specified to be used for defining steel frame design groups; otherwise it is False.
SpecifiedForConcreteDesign (Optional)
Type: SystemBoolean
This item is True if the group is specified to be used for defining concrete frame design groups; otherwise it is False.
SpecifiedForAluminumDesign (Optional)
Type: SystemBoolean
This item is True if the group is specified to be used for defining aluminum frame design groups; otherwise it is False.
SpecifiedForColdFormedDesign (Optional)
Type: SystemBoolean
This item is True if the group is specified to be used for defining cold formed frame design groups; otherwise it is False.
SpecifiedForStaticNLActiveStage (Optional)
Type: SystemBoolean
This item is True if the group is specified to be used for defining stages for nonlinear static analysis; otherwise it is False.
SpecifiedForBridgeResponseOutput (Optional)
Type: SystemBoolean
This item is True if the group is specified to be used for reporting bridge response output; otherwise it is False.
SpecifiedForAutoSeismicOutput (Optional)
Type: SystemBoolean
This item is True if the group is specified to be used for reporting auto seismic loads; otherwise it is False.
SpecifiedForAutoWindOutput (Optional)
Type: SystemBoolean
This item is True if the group is specified to be used for reporting auto wind loads; otherwise it is False.
SpecifiedForMassAndWeight (Optional)
Type: SystemBoolean
This item is True if the group is specified to be used for reporting group masses and weight; otherwise it is False.

Return Value

Type: Int32
Returns zero if the group data is successfully set; otherwise it returns a nonzero value.
Remarks
Items SpecifiedForAluminumDesign, SpecifiedForColdFormedDesignSpecifiedForBridgeResponseOutput are not supported in ETABS.
Examples
VB
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)

   'define new group
       ret = SapModel.GroupDef.SetGroup("Group1")

   'close ETABS
       EtabsObject.ApplicationExit(False)

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