---
title: "documentInteractionControllerWillBeginPreview(_:)"
framework: uikit
role: symbol
role_heading: Instance Method
path: "uikit/uidocumentinteractioncontrollerdelegate/documentinteractioncontrollerwillbeginpreview(_:)"
---

# documentInteractionControllerWillBeginPreview(_:)

Called when a document interaction controller is about to display a preview for its document.

## Declaration

```swift
optional func documentInteractionControllerWillBeginPreview(_ controller: UIDocumentInteractionController)
```

## Parameters

- `controller`: The document interaction controller that is about to preview its document.

## Discussion

Discussion This method is called shortly before the view containing the document preview is presented modally. You can use this notification to set up any additional interface elements behind the preview elements.

## See Also

### Presenting the user interface

- [documentInteractionControllerDidEndPreview(_:)](uikit/uidocumentinteractioncontrollerdelegate/documentinteractioncontrollerdidendpreview(_:).md)
- [documentInteractionControllerWillPresentOptionsMenu(_:)](uikit/uidocumentinteractioncontrollerdelegate/documentinteractioncontrollerwillpresentoptionsmenu(_:).md)
- [documentInteractionControllerDidDismissOptionsMenu(_:)](uikit/uidocumentinteractioncontrollerdelegate/documentinteractioncontrollerdiddismissoptionsmenu(_:).md)
- [documentInteractionControllerWillPresentOpenInMenu(_:)](uikit/uidocumentinteractioncontrollerdelegate/documentinteractioncontrollerwillpresentopeninmenu(_:).md)
- [documentInteractionControllerDidDismissOpenInMenu(_:)](uikit/uidocumentinteractioncontrollerdelegate/documentinteractioncontrollerdiddismissopeninmenu(_:).md)