asiSetAnalysisOptionFormProperties
asiSetAnalysisOptionFormProperties(
o_analysis
[ ?type s_type ]
[ ?width x_width ]
[ ?columns x_columns ]
)
=> o_formObj / nil
Description
Sets the display characteristics for a new analysis options form.
Arguments
|
o_analysis
|
Analysis object.
|
|
?type s_type
|
Specifies the form type.
Valid Values: 'oneD—Specifies a sequential display of fields in one column.
-
'twoD—Specifies a two dimensional display of fields based on row and column positions. (Use the asiAddAnalysisOption, asiChangeAnalysisOption, or asiCreateAnalysisOption functions to specify values for the rows and columns.) -
'custom—Lets you specify the exact coordinate locations for each field. (Use the asiAddAnalysisOption, asiChangeAnalysisOption, or asiCreateAnalysisOption functions to specify the coordinates.) -
'matrix—Specifies a matrix of equally sized fields.
Default Value: 'oneD
|
|
?width x_width
|
Width of the form, in pixels.
Default Value: The minimum default width of the form is 400 pixels. If the fields require more space than this, the form defaults to the smallest width that can accommodate the fields.
|
|
?columns x_columns
|
|
|
Number of columns. Use this argument only with matrix type forms.
Default Value: 2
|
Value Returned
|
o_formObj
|
Returns the analysis option form object if successful.
|
|
nil
|
Unsuccessful operation.
|
Examples
The following example sets the form properties for the analysis options for a new XYZ analysis:
asiSetAnalysisOptionFormProperties( asiGetAnalysis( asiGetTool( 'XYZ_simulator ) 'XYZ_analysis ) ?width 500)
Related Topics
asiSetAnalysisFormFieldVal
asiGetAnalysis
Return to top
