Edit

Share via

The ISEAddOnToolCollection Object

  • Article

The ISEAddOnToolCollection object is a collection of ISEAddOnTool objects. An example is the $psISE.CurrentPowerShellTab.VerticalAddOnTools object.

Methods

Add( Name, ControlType, [IsVisible] )

Supported in Windows PowerShell ISE 3.0 and later, and not present in earlier versions.

Adds a new add-on tool to the collection. It returns the newly added add-on tool. Before you run this command, you must install the add-on tool on the local computer and load the assembly.

  • Name - String - Specifies the display name of the add-on tool that's added to Windows PowerShell ISE.
  • ControlType - Type - Specifies the control that's added.
  • [IsVisible] - optional Boolean - If set to $true, the add-on tool is immediately visible in the associated tool pane.
# Load a DLL with an add-on and then add it to the ISE
[Reflection.Assembly]::LoadFile("C:testISESimpleSolutionISESimpleSolution.dll")
$psISE.CurrentPowerShellTab.VerticalAddOnTools.Add("Solutions", [ISESimpleSolution.Solution], $true)

Remove(Item)

Supported in Windows PowerShell ISE 3.0 and later, and not present in earlier versions.

Removes the specified add-on tool from the collection.

  • Item - Microsoft.PowerShell.Host.ISE.ISEAddOnTool - Specifies the object to be removed from Windows PowerShell ISE.
# Load a DLL with an add-on and then add it to the ISE
[Reflection.Assembly]::LoadFile("C:\test\ISESimpleSolution\ISESimpleSolution.dll")
$psISE.CurrentPowerShellTab.VerticalAddOnTools.Add("Solutions", [ISESimpleSolution.Solution], $true)

SetSelectedPowerShellTab(psTab)

Supported in Windows PowerShell ISE 3.0 and later, and not present in earlier versions.

Selects the PowerShell tab that the psTab parameter specifies.

  • psTab - Microsoft.PowerShell.Host.ISE.PowerShellTab -The PowerShell tab to select.
$newTab = $psISE.PowerShellTabs.Add()
# Change the DisplayName of the new PowerShell tab.
$newTab.DisplayName = 'Brand New Tab'

Remove(psTab)

Supported in Windows PowerShell ISE 3.0 and later, and not present in earlier versions.

Removes the PowerShell tab that the psTab parameter specifies.

  • psTab - Microsoft.PowerShell.Host.ISE.PowerShellTab - The PowerShell tab to remove.
$newTab = $psISE.PowerShellTabs.Add()
Change the DisplayName of the new PowerShell tab.
$newTab.DisplayName = 'This tab will go away in 5 seconds'
sleep 5
$psISE.PowerShellTabs.Remove($newTab)

See Also