public Result Execute(ExternalCommandData commandData, ref string message, ElementSet elements)
{
// 1: ---------------------------------------------------------------------------------------------------------------------------------------------
#region Processing modifier keys
// Processing modifier keys
// Default script is the main script unless it is changed by modifier buttons
var _script = baked_scriptSource;
bool _refreshEngine = false;
bool _altScriptMode = false;
bool _forcedDebugMode = false;
bool ALT = Keyboard.IsKeyDown(Key.LeftAlt) || Keyboard.IsKeyDown(Key.RightAlt);
bool SHIFT = Keyboard.IsKeyDown(Key.LeftShift) || Keyboard.IsKeyDown(Key.RightShift);
bool CTRL = Keyboard.IsKeyDown(Key.LeftCtrl) || Keyboard.IsKeyDown(Key.RightCtrl);
bool WIN = Keyboard.IsKeyDown(Key.LWin) || Keyboard.IsKeyDown(Key.RWin);
// If Ctrl+Alt+Shift clicking on the tool run in clean engine
if (CTRL && ALT && SHIFT)
{
_refreshEngine = true;
}
// If Alt+Shift clicking on button, open the context menu with options.
else if (SHIFT && WIN)
{
// start creating context menu
ContextMenu pyRevitCmdContextMenu = new ContextMenu();
// menu item to open help url if exists
if (baked_helpSource != null && baked_helpSource != "")
{
MenuItem openHelpSource = new MenuItem();
openHelpSource.Header = "Open Help";
openHelpSource.Click += delegate { System.Diagnostics.Process.Start(baked_helpSource); };
pyRevitCmdContextMenu.Items.Add(openHelpSource);
}
// use a disabled menu item to show if the command requires clean engine
MenuItem cleanEngineStatus = new MenuItem();
cleanEngineStatus.Header = string.Format("Requests Clean Engine: {0}", baked_needsCleanEngine ? "Yes" : "No");
cleanEngineStatus.IsEnabled = false;
pyRevitCmdContextMenu.Items.Add(cleanEngineStatus);
// use a disabled menu item to show if the command requires full frame engine
MenuItem fullFrameEngineStatus = new MenuItem();
fullFrameEngineStatus.Header = string.Format("Requests FullFrame Engine: {0}", baked_needsFullFrameEngine ? "Yes" : "No");
fullFrameEngineStatus.IsEnabled = false;
pyRevitCmdContextMenu.Items.Add(fullFrameEngineStatus);
// menu item to copy script path to clipboard
MenuItem copyScriptPath = new MenuItem();
copyScriptPath.Header = "Copy Script Path";
copyScriptPath.Click += delegate { System.Windows.Forms.Clipboard.SetText(_script); };
pyRevitCmdContextMenu.Items.Add(copyScriptPath);
// menu item to copy alternate script path to clipboard, if exists
if (baked_alternateScriptSource != null && baked_alternateScriptSource != "")
{
MenuItem copyAltScriptPath = new MenuItem();
copyAltScriptPath.Header = "Copy Alternate Script Path";
copyAltScriptPath.Click += delegate { System.Windows.Forms.Clipboard.SetText(baked_alternateScriptSource); };
pyRevitCmdContextMenu.Items.Add(copyAltScriptPath);
}
// menu item to copy bundle path to clipboard
MenuItem copyBundlePath = new MenuItem();
copyBundlePath.Header = "Copy Bundle Path";
copyBundlePath.Click += delegate { System.Windows.Forms.Clipboard.SetText(Path.GetDirectoryName(_script)); };
pyRevitCmdContextMenu.Items.Add(copyBundlePath);
// menu item to copy command unique name (assigned by pyRevit) to clipboard
MenuItem copyUniqueName = new MenuItem();
copyUniqueName.Header = string.Format("Copy Unique Id ({0})", baked_cmdUniqueName);
copyUniqueName.Click += delegate { System.Windows.Forms.Clipboard.SetText(baked_cmdUniqueName); };
pyRevitCmdContextMenu.Items.Add(copyUniqueName);
// menu item to copy ;-separated sys paths to clipboard
// Example: "path1;path2;path3"
MenuItem copySysPaths = new MenuItem();
copySysPaths.Header = "Copy Sys Paths";
copySysPaths.Click += delegate { System.Windows.Forms.Clipboard.SetText(baked_syspaths.Replace(";", "\r\n")); };
pyRevitCmdContextMenu.Items.Add(copySysPaths);
// open the menu
pyRevitCmdContextMenu.IsOpen = true;
return(Result.Succeeded);
}
// If Ctrl+Shift clicking on button, run the script in debug mode and run config script instead.
else if (CTRL && (SHIFT || altScriptModeOverride))
{
_script = baked_alternateScriptSource;
_altScriptMode = true;
_forcedDebugMode = true;
}
// If Alt clicking on button, open the script in explorer and return.
else if (ALT)
{
// combine the arguments together
// it doesn't matter if there is a space after ','
string argument = "/select, \"" + _script + "\"";
System.Diagnostics.Process.Start("explorer.exe", argument);
return(Result.Succeeded);
}
// If Shift clicking on button, run config script instead
else if (SHIFT || altScriptModeOverride)
{
_script = baked_alternateScriptSource;
_altScriptMode = true;
}
// If Ctrl clicking on button, set forced debug mode.
else if (CTRL)
{
_forcedDebugMode = true;
}
#endregion
// 2: ---------------------------------------------------------------------------------------------------------------------------------------------
#region Setup pyRevit Command Runtime
var pyrvtCmdRuntime = new PyRevitCommandRuntime(cmdData: commandData,
elements: elements,
scriptSource: baked_scriptSource,
alternateScriptSource: baked_alternateScriptSource,
syspaths: baked_syspaths,
arguments: argumentList,
helpSource: baked_helpSource,
cmdName: baked_cmdName,
cmdBundle: baked_cmdBundle,
cmdExtension: baked_cmdExtension,
cmdUniqueName: baked_cmdUniqueName,
needsCleanEngine: baked_needsCleanEngine,
needsFullFrameEngine: baked_needsFullFrameEngine,
refreshEngine: _refreshEngine,
forcedDebugMode: _forcedDebugMode,
altScriptMode: _altScriptMode,
executedFromUI: executedFromUI);
#endregion
// 3: ---------------------------------------------------------------------------------------------------------------------------------------------
#region Execute and log results
// Executing the script and logging the results
// Get script executor and Execute the script
var executor = new ScriptExecutor();
pyrvtCmdRuntime.ExecutionResult = executor.ExecuteScript(ref pyrvtCmdRuntime);
// Log results
ScriptUsageLogger.LogUsage(pyrvtCmdRuntime.MakeLogEntry());
// GC cleanups
var re = pyrvtCmdRuntime.ExecutionResult;
pyrvtCmdRuntime.Dispose();
pyrvtCmdRuntime = null;
// Return results to Revit. Don't report errors since we don't want Revit popup with error results
if (re == 0)
{
return(Result.Succeeded);
}
else
{
return(Result.Cancelled);
}
#endregion
}
private ScriptEngine RefreshCachedEngine(ref PyRevitCommandRuntime pyrvtCmd)
{
return(CreateNewCachedEngine(ref pyrvtCmd));
}
