tsc_PointStakeoutOptionsFormEventArgs

This eventArgs interface is passed to the Options form event handler (OnBeforeOptionsForm), which is called before the options form is displayed.

Public members

tsc_PointStakeoutGetOptionsInterface&  GetOptions;

This is a reference to the Options interface which allows current options to be accessed.  For instance, to obtain the current setting for use of the compass, one might write:

bool usingCompass = eventArgs.GetOptions.CompassEnabled();

tsc_PointStakeoutSetOptionsInterface&  SetOptions;

This is a reference to the Options setting interface, which allows options to be modified.  For instance, to enable the use of the compass, one might write:

eventArgs.SetOptions.CompassEnabled(true);

void ShowOptionsForm (bool show);

This method allows the Options form to be displayed or not.  The default is to display the standard stakeout options form.  If this is set to false, the options form is not displayed, and it is recommended that the plugin displays an options form in its place.  If nothing is displayed then the Options softkey would appear to the user to do nothing.  Alternatively the Options softkey can be hidden during the OnInitialConfig event, in which case the OnBeforeOptionsForm event will never occur.