AlteryxAllowDesktopInteraction

Version:
Current
Last modified: June 11, 2020

AlteryxAllowDesktopInteraction AlteryxEngine API method is used to tell Alteryx whether or not to display dialog boxes and choices to the user. Default: false.

Some Alteryx tools display dialog boxes to obtain user feedback. For example, the Street Geocoder tool displays a dialog box so users can choose between multiple matches.

Method Declaration

void AlteryxAllowDesktopInteraction(int bAllow);

bAllow values:

  • True: Allow dialog boxes and choices to display
  • False: Prevent dialog boxes and choices from displaying. If you are running in an environment that does not allow desktop interaction, such as a web process, pass a false value to prevent an error.

Example

if (allowDesktopInteraction)
{
	AlteryxAllowDesktopInteraction(true);
}
else
{
	AlteryxAllowDesktopInteraction(false);
}
Was This Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support.