在 Xamarin.Mac 中使用情节提要

项目
04/27/2024

情节提要定义给定应用的所有 UI，这些 UI 细分为其视图控制器的功能概述。在 Xcode 的 Interface Builder 中，每个控制器都位于其自己的场景中。

情节提要是一个资源文件（扩展名 .storyboard为），在编译和交付时，该文件包含在 Xamarin.Mac 应用的捆绑包中。若要为应用定义起始情节提要，请编辑其 Info.plist 文件，然后从下拉列表框中选择“主界面”：

从代码加载

有时可能需要从代码加载特定的情节提要，并手动创建视图控制器。可以使用以下代码执行此操作：

// Get new window
var storyboard = NSStoryboard.FromName ("Main", null);
var controller = storyboard.InstantiateControllerWithIdentifier ("MainWindow") as NSWindowController;

// Display
controller.ShowWindow(this);

FromName 加载具有应用捆绑包中包含的给定名称的 Storyboard 文件。 InstantiateControllerWithIdentifier 使用给定标识创建视图控制器的实例。在设计 UI 时，在 Xcode 的 Interface Builder 中设置标识：

（可选）可以使用 InstantiateInitialController 方法加载 Interface Builder 中已分配初始控制器的视图控制器：

它由情节提要入口点和上面的开口箭头标记。

视图控制器

视图控制器定义了 Mac 应用内给定信息视图与提供该信息的数据模型之间的关系。情节提要中的每个顶级场景代表 Xamarin.Mac 应用代码中的一个视图控制器。

视图控制器生命周期

向 NSViewController 类添加了几个新方法，以支持 macOS 中的情节提要。最重要的是，以下方法用于响应由给定视图控制器控制的视图的生命周期：

ViewDidLoad - 从情节提要文件加载视图时调用此方法。
ViewWillAppear - 此方法是在屏幕上显示视图之前调用的。
ViewDidAppear - 此方法直接在屏幕上显示视图后调用。
ViewWillDisappear - 在从屏幕中删除视图之前，将调用此方法。
ViewDidDisappear - 在从屏幕中删除视图后，直接调用此方法。
UpdateViewConstraints - 定义视图自动布局位置和大小的约束需要更新时，将调用此方法。
ViewWillLayout - 此方法在屏幕布局此视图的子视图之前调用。
ViewDidLayout - 在屏幕布局视图子视图后，直接调用此方法。

响应方链

此外，NSViewControllers 现在是窗口响应者链的一部分：

因此，它们通过有线方式接收和响应剪切、复制和粘贴菜单项等事件。这种自动视图控制器连接仅在 macOS Sierra (10.12) 及更高级别的应用上运行。

遏制

在情节提要中，视图控制器（如拆分视图控制器和选项卡视图控制器）现在可以实现包含，以便它们可以“包含”其他子视图控制器：

子视图控制器包含的方法和属性，用于将它们关联回父视图控制器，并处理从屏幕中显示和删除视图。

macOS 中内置的所有容器视图控制器都有一个特定的布局，Apple 建议在创建自己的自定义容器视图控制器时遵循该布局：

集合视图控制器包含集合视图项的数组，每个数组都包含一个或多个包含其自己的视图的视图控制器。

Segues

Segues 提供定义应用 UI 的所有场景之间的关系。如果你熟悉 iOS 中情节提要的使用方式，则就会知道，iOS 的 Segue 通常定义全屏视图之间的转换。这不同于 macOS，Segues 通常定义“包含”，其中一个场景是父场景的子级。

在 macOS 中，大多数应用倾向于使用拆分视图和选项卡等 UI 元素将其视图分组在同一窗口中。与 iOS 不同的是，由于物理显示空间有限，视图需要在屏幕内外转换。

演示文稿 Segues

鉴于 macOS 的包容性倾向，在某些情况下会使用呈现 Segue，例如模态窗口、工作表视图和弹出窗口。 macOS 提供以下内置 segue 类型：

显示 - 将 Segue 的目标显示为非模式窗口。例如，使用此类型的 Segue 在应用中显示文档窗口的另一个实例。
模式 - 将 Segue 的目标呈现为模式窗口。例如，使用此类型的 Segue 来显示应用的“首选项”窗口。
工作表 - 将 Segue 的目标显示为附加到父窗口的工作表。例如，使用此类型的 segue 来显示“查找”和“替换工作表”。
弹出窗口 - 将 Segue 的目标呈现为弹出窗口。例如，当用户单击 UI 元素时，使用此 Segue 类型来显示选项。
自定义 - 使用开发人员定义的自定义 Segue 类型呈现 Segue 的目标。有关详细信息，请参阅下面的创建自定义 Segues 部分。

使用呈现 Segue 时，可以重写用于呈现的父视图控制器的 PrepareForSegue 方法，以初始化变量并向正在呈现的视图控制器提供任何数据。

触发的 Segues

触发的 Segues 允许你指定命名的 Segues（通过 Interface Builder 中的 Identifier 属性），并让用户通过单击按钮或调用代码中的 PerformSegue 方法等事件触发：

// Display the Scene defined by the given Segue ID
PerformSegue("MyNamedSegue", this);

在布局应用的 UI 时，Segue ID 在 Xcode 的 Interface Builder 中定义：

在充当 Segue 源的视图控制器中，应重写 PrepareForSegue 方法，并在执行 Segue 之前执行所需的任何初始化，并显示指定的视图控制器：

public override void PrepareForSegue (NSStoryboardSegue segue, NSObject sender)
{
    base.PrepareForSegue (segue, sender);

    // Take action based on Segue ID
    switch (segue.Identifier) {
    case "MyNamedSegue":
        // Prepare for the segue to happen
        ...
        break;
    }
}

（可选）可以重写 ShouldPerformSegue 方法，并控制是否通过 C# 代码实际执行 Segue。对于手动显示的视图控制器，请调用其 DismissController 方法，以便在不再需要视图控制器时将其从显示中删除。

创建自定义 Segues

有时，你的应用可能需要 macOS 中定义的内置 Segues 所不提供的 Segue 类型。如果是这种情况，可以在布局应用的 UI 时创建可在 Xcode 的 Interface Builder 中分配的自定义 Segue。

例如，若要创建一个新的 Segue 类型，该类型替换窗口内的当前视图控制器（而不是在新窗口中打开目标场景），可以使用以下代码：

using System;
using AppKit;
using Foundation;

namespace OnCardMac
{
    [Register("ReplaceViewSeque")]
    public class ReplaceViewSeque : NSStoryboardSegue
    {
        #region Constructors
        public ReplaceViewSeque() {

        }

        public ReplaceViewSeque (string identifier, NSObject sourceController, NSObject destinationController) : base(identifier,sourceController,destinationController) {

        }

        public ReplaceViewSeque (IntPtr handle) : base(handle) {
        }

        public ReplaceViewSeque (NSObjectFlag x) : base(x) {
        }
        #endregion

        #region Override Methods
        public override void Perform ()
        {
            // Cast the source and destination controllers
            var source = SourceController as NSViewController;
            var destination = DestinationController as NSViewController;

            // Swap the controllers
            source.View.Window.ContentViewController = destination;

            // Release memory
            source.RemoveFromParentViewController ();
        }
        #endregion

    }
        
}

此处要注意的几个事项：