如何在PowerShell中添加事件动作处理程序

如何解决如何在PowerShell中添加事件动作处理程序

Terminal.Gui (gui.cs)为Button类提供了一个Clicked事件，定义为：

        public event Action Clicked;

我正在尝试在PowerShell中为Terminal.Gui编写示例应用程序，并且正在努力连接事件处理程序。

Add-Type -AssemblyName Terminal.Gui
[Terminal.Gui.Application]::Init() 
$win = New-Object Terminal.Gui.Window
$win.Title = "Hello World"
$btn = New-Object Terminal.Gui.Button
$btn.X = [Terminal.Gui.Pos]::Center()
$btn.Y = [Terminal.Gui.Pos]::Center()
$btn.Text= "Press me"

# Here lies dragons
[Action]$btn.Clicked = {
    [Terminal.Gui.Application]::RequestStop() 
}

$win.Add($btn)

[Terminal.Gui.Application]::Top.Add($win)
[Terminal.Gui.Application]::Run()

上面的示例中的Clicked =分配返回错误：

InvalidOperation: The property 'Clicked' cannot be found on this object. Verify that the property exists and can be set.

但是智能感知为我自动完成Clicked ...所以我猜这是类型问题？

我在[Action]上找不到任何PowerShell文档，而且我发现的其他示例都没有给我带来任何快乐。

如何在PowerShell中为基于Action的dotnet事件定义事件处理程序？

解决方法

C＃代码将添加一个lambda：

btn.Clicked += ...

因此在PowerShell中，您需要显式调用Add_Clicked（）方法：

$btn.Add_Clicked({
    param($sender,$e)
    [Terminal.Gui.Application]::RequestStop()
})

这些参数与方法签名匹配，尽管在此示例中未使用。

此更改不会显示错误，但事件似乎正在触发。

Register-ObjectEvent -InputObject $btn -EventName Clicked --Action {
        [Terminal.Gui.Application]::RequestStop() 
}

编辑：

@Steve Lee的解决方案就像一个咒语，但是还需要在末尾添加[Terminal.Gui.Application]::Shutdown()。不需要param($sender,$e)，因为它不是EventHandler而是event Action。谢谢。

Steve Lee's helpful answer提供了至关重要的指针；让我补充背景信息：

PowerShell提供了两种基本的事件订阅机制：

（a） .NET-native ，如史蒂夫的答案所示，其中您将script block（{ ... }）附加为 delegate 通过<Name>实例方法到达对象的.add_<Name>()事件（委托是一段由用户提供的回调代码，在偶数触发时被调用）-请参见下一节。
（b） PowerShell介导的，并使用Register-ObjectEvent和相关cmdlet：
- 类似于（a）的基于回调的方法可以通过将脚本块传递给-Action参数来实现。
- 或者，可以通过Get-Event cmdlet根据需要检索排队的事件。

方法（b）的回调方法只能在 PowerShell 控制前台线程时及时起作用，在这种情况下并非如此，因为[Terminal.Gui.Application]::Run()调用阻止。因此，必须使用方法（a）。

关于（a）：

C＃以操作符+=和-=的形式提供语法糖，用于附加和分离事件处理程序委托，其外观类似于分配，但实际上已转换为add_<Event>()和remove_<Event>() 方法调用。

以[Timers.Timer]类型为例，您可以看到以下方法名称：

PS> [powershell].GetEvents() | select Name,*Method,EventHandlerType


Name             : InvocationStateChanged
AddMethod        : Void add_InvocationStateChanged(System.EventHandler`1[System.Management.Automation.PSInvocationStateChangedEventArgs])
RemoveMethod     : Void remove_InvocationStateChanged(System.EventHandler`1[System.Management.Automation.PSInvocationStateChangedEventArgs])
RaiseMethod      : 
EventHandlerType : System.EventHandler`1[System.Management.Automation.PSInvocationStateChangedEventArgs]

PowerShell为附加/删除事件处理程序提供了 no 这样的语法糖，因此必须直接调用这些方法。

不幸的是，Get-Member和制表符补全都不知道这些方法，相反，原始事件 names 令人困惑地 do 却用制表符完成了，即使您不能直接对它们采取行动。

Github suggestion #12926旨在解决这两个问题。

用于事件定义的公约：

上面的EventHandlerType属性显示事件处理程序委托的类型名称，在这种情况下，该名称正确遵循使用基于通用类型{{3}的委托的惯例 }，其签名是：

public delegate void EventHandler<TEventArgs>(object? sender,TEventArgs e);

TEventArgs表示包含特定于事件的信息的实例的类型。另一个惯例是此类事件参数类型是从System.EventHandler<TEventArgs>类派生而来的，而System.EventArgs是此类。

根据约定提供事件的特定信息的事件使用非通用的PSInvocationStateChangedEventArgs委托：

public delegate void EventHandler(object? sender,EventArgs e);

大概是因为该委托在历史上是用于所有委托的，即使对于那些带有事件参数的代理-在.em中通用之前2-一个EventArgs参数仍然存在，约定是传递EventArgs.Empty而不是null来表示没有参数。
类似地，已建立很久的框架类型使用其特定的事件参数类型定义非通用的 custom 委托，例如System.EventHandler。

CLR都不强制执行这些约定，但是，有争议的事件被定义为public event Action Clicked;，使用了 parameterless 委托作为事件处理程序。

通常建议您遵守约定，以免违反用户的期望，即使有时不太方便。

在使用脚本块（{ ... }）作为委托时，PowerShell非常灵活，并且不通过{强制执行特定的参数签名。 {1}}：

无论脚本块声明了太多还是太少的参数，脚本块都是可以接受的，尽管那些绑定到脚本块参数的事件发起对象实际传递的参数必须是类型兼容的（假定脚本块的参数被明确键入）。

因此，史蒂夫的代码：

param(...)

尽管参数声明无用，但

仍然有效，因为System.Windows.Forms.KeyPressEventHandler委托类型是 parameterless ，因为没有参数传递给脚本块。

以下内容已足够：

$btn.Add_Clicked({
    param($sender,$e)
    [Terminal.Gui.Application]::RequestStop()
})

简化的示例代码：

$btn.Add_Clicked({ [Terminal.Gui.Application]::RequestStop() })版的注释：

至少在macOS上，要使终端在退出应用程序后将终端恢复为可用状态，还需要执行以下其他操作：
- 1.0.0-pre.4。如果没有它，在同一会话中重新调用该应用程序将无法正常工作。
- [Terminal.Gui.Application]::Shutdown()。没有它，以后的命令行编辑就会中断（特别是上下箭头）。
tput init类型对PowerShell不友好，原因有两个：
- Terminal.Gui及其子类实现[View]接口，这将导致PowerShell的默认输出格式尝试枚举，从而导致 no 输出。
  - 解决方法：IEnumerable
- 从概念上讲， text 属性不是作为$btn.psobject.Properties | select Name,Value,TypeNameOfValue类型实现的，而是作为[string]类型实现的；尽管您可以透明地使用[NStack.ustring]实例将这些属性分配，但 displaying 再次执行枚举并呈现该对象的代码点底层字符单独。
  - 解决方法：致电[string]。
- tig（OP）已提交System.Action来解决此问题。
从PowerShell 7.1开始，没有与NuGet软件包直接集成，因此将已安装的软件包的程序集加载到PowerShell会话中非常麻烦-请参见 {{3 }} ，它显示了如何使用 .NET Core SDK 下载程序包并使其依赖项可用。
- 请注意，.ToString()仅适用于 current 目录（与 script的目录相对）或PowerShell附带的程序集本身（PowerShell [Core] v6 +）/在GAC（Windows PowerShell）中。
- 鉴于当前从PowerShell中使用NuGet软件包的繁琐程度，此GitHub issue #951要求增强Add-Type -AssemblyName以直接支持NuGet软件包。

Add-Type

如何在PowerShell中添加事件动作处理程序

如何解决如何在PowerShell中添加事件动作处理程序

解决方法

相关推荐