ParametersOnlyMode

Gets a value that indicates whether the Standard Import Routine is being executed only to edit the parameters.

This property tells the task whether it is being invoked during the first execution of a Standard Import Routine (in this case its value is false) or in standalone-mode (in this case its value is true) from within the Prepare Imported Data GUI. Using this information, the dialog task can adapt its behavior to the execution mode. For example, if ParametersOnlyMode is true, the dialog task knows that it is being called from within Prepare Imported Data and can load the values of its parameters that were collected the first time through from the context object and use them in its GUI.

Compatibility

Available as of IDEA version 9.1.1

Syntax

ParametersOnlyMode()

Remarks

If ParametersOnlyMode is true, the Standard Import Routine is being executed only to edit the parameters. In this mode only the dialog task is executed.

To read/store actual parameters, the execution context provides the dictionary named UserData. This collection is shared between all subtasks of a Standard Import Routine execution and is persisted at the end of a Standard Import Routine execution.

Type

Boolean

Example

Option Explicit 
'ParametersOnlyMode 
Sub Main() 
	If SmartContext.ParametersOnlyMode Then 
		MsgBox "The Standard Import Routine is being executed only to edit the parameters. In this mode only the dialog task is executed."" 
	Else 
		MsgBox "ParametersOnlyMode = false" 
	End If 
End Sub

Copy example