Hide Table of Contents
GetPlotPositionFormatOptions Method (ICWResults)

Gets the position format options for the specified plot.

.NET Syntax

Visual Basic (Declaration) 
Function GetPlotPositionFormatOptions( _
   ByVal SPlotName As System.String, _
   ByRef ErrorCode As System.Integer _
) As System.Object
Visual Basic (Usage) 
Dim instance As ICWResults
Dim SPlotName As System.String
Dim ErrorCode As System.Integer
Dim value As System.Object
 
value = instance.GetPlotPositionFormatOptions(SPlotName, ErrorCode)
C# 
System.object GetPlotPositionFormatOptions( 
   System.string SPlotName,
   out System.int ErrorCode
)
C++/CLI 
System.Object^ GetPlotPositionFormatOptions( 
&   System.String^ SPlotName,
&   [Out] System.int ErrorCode
)

Parameters

SPlotName
Plot name
ErrorCode
Error as defined in swsResultsError_e

Return Value

Array of plot position/format options (see Remarks)

Example

Remarks

The 0-based array contains eight elements:

Array element... Contains...
0 Double [0,1]; horizontal position from the left of the graphics area; percentage of the window width
1 Double[0,1]; vertical position from the top of the graphics area; percentage of the window height
2 Chart width option as defined in swsColorChartWidthOptionValue_e
3 Chart number format as defined in swsColorChartNumberFormatOptionValue_e
4 0 <= Number of decimal places to display <= 16
5 Boolean; whether to display chart numbers with a 1000 comma separator; valid only if array element 3 is swsColorChartNumberFormatOptionValue_e.swsColorChartNumberFormatFloating or swsColorChartNumberFormatOptionValue_e.swsColorChartNumberFormatGeneral
6 Boolean; whether to use different number format for small numbers (0.001 < |x| < 1000); valid only if array element 3 is swsColorChartNumberFormatOptionValue_e.swsColorChartNumberFormatScientific
7 Number format for small numbers as defined in swsColorNumberFormatUseDiffNumberFormatOptionValue_e; valid only if array element 6 = true
 

See Also

Availability

SOLIDWORKS Simulation API 2015 SP0


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

 
*Email:  
Subject:   Feedback on Help Topics
Page:   GetPlotPositionFormatOptions Method (ICWResults)
*Comment:  
*   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:

x

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
x

Web Help Content Version: API Help (English only) 2015 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.

0.20.48