Analysis Members

These members are objects related to analysis settings and output that can be recorded.

Functions

Name Description
Activate Brings the analysis to the front
ClearSavedOutputs Clear saved outputs
Close Closes an interactive Analysis
GoBack Moves the analysis back to the previous step.
Run Moves the analysis on to the next step. Return value: Integer.

Properties

Name Description
AnalysisOption Returns the analysis option for the analysis. Return value: Analysis option. This property is read only
Application Returns the application associated with the analysis. Return value: Application. This property is read only
ByGroupAccumulateTabularResults Get/set By Group accumulate tabular results in a single spreadsheet. Return/assignment value: Boolean
ByGroupEnabled Enable/disable by group. Return/assignment value: Boolean
ByGroupLabelOutputs Get/set labeling of individual outputs with group info. Return/assignment value: Boolean
ByGroupOutputAllGroupsResults Get/set whether the 'all groups' results are displayed. Return/assignment value: Boolean
ByGroupOutputToSingleFolder Get/set By Group output to single folder vs. one folder per group. Return/assignment value: Boolean
ByGroupSortOrder Get/set how group folders will be sorted in output workbook. Return/assignment value: SortOption.
ByGroupVariables Get/set By Group variables. Return/assignment value: Variant
CaseWeight Returns the case weight of the analysis. Return value: CaseWeight. This property is read only
CaseWeightSource Returns/sets the case weight source. Return/assignment value: CaseWeightSource.
DataFile Returns/sets the current input spreadsheet for this analysis. Return/assignment value: Object
Dialog Returns the dialog of the analysis. Return value: Object. This property is read only
DocumentId Get the document id, a guid string. Return value: String. This property is read only
FullName Returns a descriptive name of the analysis. Return value: String. This property is read only
MacroText Returns the current macro recording script from the analysis. Return value: String. This property is read only
MaxSavedAnalysisOutputs The analysis keeps a collection of output documents (returned by Outputs property); this is the maximum number of documents that will be stored and kept open. Return/assignment value: Long
Minimize Returns/sets minimized state of the Analysis. Return/assignment value: Boolean
Name Return value: String. This property is read only
NeverShowDialog Return/assignment value: Boolean
OutputOption Returns the output option for the analysis. Return value: OutputOption. This property is read only
Outputs Returns a collection of open Output documents associated with this analysis. Return value: StaDocuments. This property is read only
Parent Returns the application associated with the analysis. Return value: Application. This property is read only
RecordingSuspended Get/Set recording suspended state. When recording is suspended, macro code is not recorded behind the scenes. Return/assignment value: Boolean
RouteOutput Gets an AnalysisOutput object to route the output of the analysis. Return value: AnalysisOutput. This property is read only
SelectionCondition Returns the selection conditions for the analysis. Return value: SelectionCondition. This property is read only
SelectionConditionSource Returns/sets the selection conditions source. Return/assignment value: SelectionConditionSource.
State Returns a code identifying the current state. Return value: Integer. This property is read only
StatisticaModule Returns a code identifying the type of analysis. Return value: AnalysisIdentifier. This property is read only
UseGlobalOutputSettings Returns/sets whether the analysis uses the global output settings or its own settings. Return/assignment value: Boolean
Visible Returns/sets the visibility of the analysis. Return/assignment value: Boolean
WarnOnDataChange Return/assignment value: Boolean
Events Description
Activate Called when the analysis is brought to the front
BeforeClose Called before the analysis is closed
BeforeOutput Called before the analysis is sent to output
BeforeStart Called before a series of outputs are created
Deactivate Called when the analysis loses the focus
End Called when the analysis is finished processing
OnClose Called when the analysis is closed