Class

# MobileDocumentPicker

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

## Description

This class allows Mobile users to select & save folder items beyond the own app Sandbox; that includes, files on the Device, shared folders/files, available remote synced volumes (iCloud, Dropbox, etc.).

## Properties

<div class="rst-class">

table-centered_columns_3_and_4

</div>

| Name                              | Type                             | Read-Only | Shared |
|-----------------------------------|----------------------------------|-----------|--------|
| `Name<mobiledocumentpicker.name>` | `String</api/data_types/string>` | ✓         |        |

## Methods

<div class="rst-class">

table-centered_column_4

</div>

| Name                                  | Parameters                                                                                                | Returns                                     | Shared |
|---------------------------------------|-----------------------------------------------------------------------------------------------------------|---------------------------------------------|--------|
| `Handle<mobiledocumentpicker.handle>` |                                                                                                           | `Ptr</api/data_types/additional_types/ptr>` |        |
| `Open<mobiledocumentpicker.open>`     | filter As `String</api/data_types/string>`, allowsMultipleSelection As `Boolean</api/data_types/boolean>` |                                             |        |
| `Save<mobiledocumentpicker.save>`     | file As `FolderItem</api/files/folderitem>`                                                               |                                             |        |

## Events

<div class="rst-class">

table-centered_column_4

</div>

| Name                                      | Parameters                                     | Returns |
|-------------------------------------------|------------------------------------------------|---------|
| `Canceled<mobiledocumentpicker.canceled>` |                                                |         |
| `Closing<mobiledocumentpicker.closing>`   |                                                |         |
| `Opening<mobiledocumentpicker.opening>`   |                                                |         |
| `Selected<mobiledocumentpicker.selected>` | files() As `FolderItem</api/files/folderitem>` |         |

## Property descriptions

<div id="mobiledocumentpicker.name">

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

</div>

<div class="rst-class">

forsearch

</div>

MobileDocumentPicker.Name

**Name** As `String</api/data_types/string>`

> The name of the control.
>
> This property is read-only.

## Method descriptions

<div id="mobiledocumentpicker.handle">

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

</div>

<div class="rst-class">

forsearch

</div>

MobileDocumentPicker.Handle

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

> The handle to the underlying native OS control.
>
> <div class="important">
>
> <div class="title">
>
> Important
>
> </div>
>
> This is supported for iOS only.
>
> </div>

<div id="mobiledocumentpicker.open">

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

</div>

<div class="rst-class">

forsearch

</div>

MobileDocumentPicker.Open

**Open**(filter As `String</api/data_types/string>`, allowsMultipleSelection As `Boolean</api/data_types/boolean>`)

> When *allowsMultipleSelection* is `True</api/language/true>`, the user can choose as many files he wants.

<div id="mobiledocumentpicker.save">

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

</div>

<div class="rst-class">

forsearch

</div>

MobileDocumentPicker.Save

**Save**(file As `FolderItem</api/files/folderitem>`)

> Opens the <span class="title-ref">MobileDocumentPicker</span> controller UI so the user can save the passed `FolderItem</api/files/folderitem>` in the selected path outside of the own app sandbox.
>
> For example, on iOS under the iCloud folder, on the Device itself (global), under the Shared folder (global) or any other folder the user may want to create during the process.

## Event descriptions

<div id="mobiledocumentpicker.canceled">

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

</div>

<div class="rst-class">

forsearch

</div>

MobileDocumentPicker.Canceled

**Canceled**

> Raised in combination with the `Open<mobiledocumentpicker.open>` method, when the user dismiss the dialog.

<div id="mobiledocumentpicker.closing">

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

</div>

<div class="rst-class">

forsearch

</div>

MobileDocumentPicker.Closing

**Closing**

> Called when the control's layout is closing.

<div id="mobiledocumentpicker.opening">

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

</div>

<div class="rst-class">

forsearch

</div>

MobileDocumentPicker.Opening

**Opening**

> Called when the control's layout is opening.
>
> This is where you typically put initialization code.
>
> This example in the Opening event of a label sets its text to "Hello":
>
> ``` xojo
> Me.Text = "Hello"
> ```

<div id="mobiledocumentpicker.selected">

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

</div>

<div class="rst-class">

forsearch

</div>

MobileDocumentPicker.Selected

**Selected**(files() As `FolderItem</api/files/folderitem>`)

> Receives an array of selected `FolderItems</api/files/folderitem>`.

## Compatibility

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

<div class="seealso">

`MobileControl</api/user_interface/mobile/mobilecontrol>` parent class, `FolderItem</api/files/folderitem>`

</div>