Hide Table of Contents
SetDisplacementControlOptions Method (ICWNonLinearStudyOptions)

Sets displacement control options for this nonlinear study.

.NET Syntax

Visual Basic (Declaration) 
Function SetDisplacementControlOptions( _
   ByVal DispEntity As System.Object, _
   ByVal NDisplacementComponent As System.Integer, _
   ByVal nUnit As System.Integer _
) As System.Integer
Visual Basic (Usage) 
Dim instance As ICWNonLinearStudyOptions
Dim DispEntity As System.Object
Dim NDisplacementComponent As System.Integer
Dim nUnit As System.Integer
Dim value As System.Integer
value = instance.SetDisplacementControlOptions(DispEntity, NDisplacementComponent, nUnit)
System.int SetDisplacementControlOptions( 
   System.object DispEntity,
   System.int NDisplacementComponent,
   System.int nUnit
System.int SetDisplacementControlOptions( 
&   System.Object^ DispEntity,
&   System.int NDisplacementComponent,
&   System.int nUnit


Vertex or reference point to control the analysis
Displacement component for the selected location (see Remarks)
Units as defined in swLinearUnit_e

Return Value

Status as defined in swsNonLinearStudyOptionsError_e


ICWNonLinearStudyOptions::ControlMethodType must be set to swsNonLinearOptionControlMethodType_e.swsNonLinearControl_Displacement to set displacement control options.

Valid displacement components are:

UX: X Translation. displacement in the Global X-direction

UY: Y Translation. displacement in the Global Y-direction

UZ: Z Translation. displacement in the Global Z-direction

RX: X Rotation. rotation about the Global X-direction for shell studies only

RY: Y Rotation. rotation about the Global Y-direction for shell studies only

RZ: Z Rotation. rotation about the Global Z-direction for shell studies only


See Also


SolidWorks Simulation API 2010 SP3.0

Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

Subject:   Feedback on Help Topics
Page:   SetDisplacementControlOptions Method (ICWNonLinearStudyOptions)
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:


We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again

Web Help Content Version: API Help (English only) 2014 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.