Contents

instantiateController(identifier:creator:)

Creates the specified window controller from the storyboard and initializes it using your custom initialization code.

Declaration

func instantiateController<Controller>(identifier: NSStoryboard.SceneIdentifier, creator: ((NSCoder) -> Controller?)? = nil) -> Controller where Controller : NSWindowController

Parameters

  • identifier:

    A string that uniquely identifies the window controller in the storyboard file. At design time, put this same string in the Storyboard ID attribute of your window controller in Interface Builder. This identifier is not a property of the window controller object. The storyboard uses it to locate the appropriate data for your controller.

    If the specified identifier does not exist in the storyboard file, this method raises an exception.

  • creator:

    A block that contains your custom creation code for the window controller. Use this block to create the window controller, initialize it with the provided coder object and any custom information you require, and return the result. This block returns a new window controller object and takes the following parameter:

    coder

    The coder object that contains the storyboard data to use when configuring the window controller.

    If you return nil from your block, this method creates the window controller using the default Init(coder:) method.

Return Value

The window controller that corresponds to the specified identifier string. If no window controller has the given identifier, this method throws an exception.

Discussion

Use this method to create a window controller object programmatically. Each time you call this method, it creates a new instance of the window controller using the block you provide.

In your creator block, create the window controller using your custom constructor method. Your custom initialization method must accept an NSCoder object as a parameter and must call the inherited init(coder:) method at some point during its execution. Not doing so is a programmer error. After initializing the storyboard state, initialize your window controller’s custom properties.

See Also

Instantiating Storyboard Controllers