C# Class RevitPythonShell.ShellForm

Inheritance: System.Windows.Forms.Form
ファイルを表示 Open project: pterelaos/revitpythonshell Class Usage Examples

Public Methods

Method Description
ShellForm ( ) : System
ShowShell ( ExternalCommandData commandData, string &message, ElementSet elements ) : int

Displays the shell form modally until the user closes it. Provides the user with access to the parameters passed to the IExternalCommand implementation in RevitPythonShell so that it can be passed on. For convenience and backwards compatibility, commandData.Application is mapped to the variable "__revit__" If an InitScript is defined in RevitPythonShell.xml, then it will be run first.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Clean up any resources being used.

Private Methods

Method Description
GetCaretPos ( System &lpPoint ) : bool
GetUncompleted ( string textAtPrompt ) : string

returns the uncompleted portion of the current text at the prompt.

InitializeComponent ( ) : void

Required method for Designer support - do not modify the contents of this method with the code editor.

LoadCommands ( ) : void

Loads a list of commands from the XML file and adds them to the tool strip. These allow the user to save frequently used commands.

PerformCompletion ( string uncompleted ) : List

complete the current word, but only if a __completer__ function is defined in the InitScript If no __completer__ function is defined, it return null.

ReplaceUncompleted ( string textAtPrompt, string uncompleted, string completed ) : string

Replaces the uncompleted portion of textAtPrompt with the completed version.

ToolStripItemClick ( object sender, EventArgs e ) : void

Run one of the configured scripts.

btnConfigureScripts_Click ( object sender, EventArgs e ) : void

Show the dialog for configuring scripts.

ironTextBoxControl_CompletionRequested ( object sender, IronTextBox e ) : void

Show a tooltip with the completions for the current text in the IronTextBoxControl.

Method Details

Dispose() protected method

Clean up any resources being used.
protected Dispose ( bool disposing ) : void
disposing bool true if managed resources should be disposed; otherwise, false.
return void

ShellForm() public method

public ShellForm ( ) : System
return System

ShowShell() public method

Displays the shell form modally until the user closes it. Provides the user with access to the parameters passed to the IExternalCommand implementation in RevitPythonShell so that it can be passed on. For convenience and backwards compatibility, commandData.Application is mapped to the variable "__revit__" If an InitScript is defined in RevitPythonShell.xml, then it will be run first.
public ShowShell ( ExternalCommandData commandData, string &message, ElementSet elements ) : int
commandData ExternalCommandData
message string
elements ElementSet
return int