Class

# iOSSplitView

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

## Description

A SplitView allows you to present master/detail views on a single iPad screen.

## Properties

<div class="rst-class">

table-centered_columns_3_and_4

</div>

| Name                                    | Type                                        | Read-Only | Shared |
|-----------------------------------------|---------------------------------------------|-----------|--------|
| `Detail<iossplitview.detail>`           | `iOSSplitContent</api/ios/iossplitcontent>` |           |        |
| `DisplayMode<iossplitview.displaymode>` | `DisplayModes<iossplitview.displaymodes>`   |           |        |
| `Master<iossplitview.master>`           | `iOSSplitContent</api/ios/iossplitcontent>` |           |        |

## Methods

<div class="rst-class">

table-centered_column_4

</div>

| Name                                                      | Parameters | Returns                                     | Shared |
|-----------------------------------------------------------|------------|---------------------------------------------|--------|
| `Available<iossplitview.available>`                       |            | `Boolean</api/data_types/boolean>`          |        |
| `ViewControllerHandle<iossplitview.viewcontrollerhandle>` |            | `Ptr</api/data_types/additional_types/ptr>` |        |

## Events

<div class="rst-class">

table-centered_column_4

</div>

| Name                                                | Parameters                                 | Returns |
|-----------------------------------------------------|--------------------------------------------|---------|
| `AppearanceChanged<iossplitview.appearancechanged>` | dark As `Boolean</api/data_types/boolean>` |         |

## Enumerations

<div id="iossplitview.displaymodes">

<div class="rst-class">

forsearch

</div>

</div>

iOSSplitView.DisplayModes

### DisplayModes

> The ways in which the split can be displayed.
>
> | Enum           | Description                                                                                                                                                                                                                                                                |
> |----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
> | AllVisible     | Both the master and the detail will be displayed.                                                                                                                                                                                                                          |
> | Automatic      | Same as PrimaryOverlay below.                                                                                                                                                                                                                                              |
> | PrimaryHidden  | Tapping on the Master `screen</api/user_interface/mobile/mobilescreen>` hides the Master, leaving only the Detail `screen</api/user_interface/mobile/mobilescreen>` showing. The Master can be redisplayed by swiping from the left edge of the screen towards the middle. |
> | PrimaryOverlay | Tapping on the Detail `screen</api/user_interface/mobile/mobilescreen>` hides the Master. The Master can be redisplayed by swiping from the left edge of the screen towards the middle.                                                                                    |

## Property descriptions

<div id="iossplitview.detail">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

iOSSplitView.Detail

**Detail** As `iOSSplitContent</api/ios/iossplitcontent>`

> The detail (or right-hand side) view or tab bar to display.

<div id="iossplitview.displaymode">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

iOSSplitView.DisplayMode

**DisplayMode** As `DisplayModes<iossplitview.displaymodes>`

> The way in which the Master section of the split view will be displayed.

<div id="iossplitview.master">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

iOSSplitView.Master

**Master** As `iOSSplitContent</api/ios/iossplitcontent>`

> The master (or left-hand side) view or tab bar to display.

## Method descriptions

<div id="iossplitview.available">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

iOSSplitView.Available

**Available** As `Boolean</api/data_types/boolean>`

> Indicates that a SplitView is available. This typically means that an iPad is being used.

<div id="iossplitview.viewcontrollerhandle">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

iOSSplitView.ViewControllerHandle

**ViewControllerHandle** As `Ptr</api/data_types/additional_types/ptr>`

> The handle to use when creating `Declares</api/language/declare>` to the underlying OS object.
>
> On iOS, the underlying OS object is a UIViewController.

## Event descriptions

<div id="iossplitview.appearancechanged">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

iOSSplitView.AppearanceChanged

**AppearanceChanged**(dark As `Boolean</api/data_types/boolean>`)

> Called when a user switches between Light and Dark mode.
>
> Use this event to update any graphics or other UI as needed.

## Notes

You can create an split in code by using MobileApplication.CurrentScreen like this:

``` xojo
Var split As New iOSSplitView

Var master As New MasterView
split.Master = master

Var detail As New DetailView
split.Detail = detail

App.CurrentScreen.Content = split
```

## Compatibility

|                       |        |
|-----------------------|--------|
| **Project Types**     | Mobile |
| **Operating Systems** | iOS    |

<div class="seealso">

`Object</api/data_types/additional_types/object>` parent class; `MobileScreen</api/user_interface/mobile/mobilescreen>`

</div>
