Clipboard QML Type

If color content is available on the clipboard, returns it as an application/x-color MIME type. Otherwise, returns an empty string or can set text to the clipboard as HTML.

Returns true if there is any data on the clipboard. Otherwise, returns false.

Returns a string array of MIME data formats available on the clipboard.

If HTML content is available on the clipboard, returns it as a string of HTML. Otherwise, returns an empty string or can set text to the clipboard as HTML.

Returns true if the device supports sharing via the clipboard. Otherwise, returns false.

If text is available on the clipboard, returns it as a string. Otherwise, returns an empty string or can set text to the clipboard.

Signal emitted when the data kept on the clipboard has been changed.

Note: The corresponding handler is onDataChanged.

Clears the clipboard.

Copies the supplied value to the clipboard. This function performs different actions according to the type of value provided:

Strings are copied to the clipboard as text. Numbers, boolean values and dates are converted to strings before being copied to the clipboard. URLs are copied as the uri MIME type. Colors are copied as the application/x-color MIME type. JavaScript objects are converted into string JSON representation before being copied. And items are captured as an image snapshot, after which the image is copied to the clipboard.

The data parameter

The data being copied to the clipboard.

Returns the requested data as specified by the give mimeType. If the data is not available, returns either a BinaryData object or null.

The mimeType parameter

The format of data to retrieve from the clipboard.

See also setData().

Sets the given BinaryData object data to the clipboard, as the specified mimeType.

The mimeType parameter

The data type to set the data to the clipboard as.

The data parameter

The data being saved to the clipboard.

See also data().

Opens a native interface to share the payload data across apps, including email and social media.

This functionality is only supported on iOS, macOS, and Android.

This code sample demonstrates a common usage of sharing a file through providing a file URL, by using DocumentDialog to select a file on your device, then using resolvedPathURL to convert the resulting filepath to a file URL.

Make sure that you have enabled the External Storage and File Sharing capabilities in the Capabilities tab of the Settings tool in order to save a file.

Item {
property url shareURL
property bool storagePermissionGranted

        Column {
                Button {
                        text: qsTr("Select a File")
                        onClicked: {
                                if (storagePermissionGranted === false) {
                                        permissionDialog.open()
                                }

                                else {
                                        doc.open()
                                }
                        }
                }

                Button {
                        text: qsTr("View and Share a File")
                        onClicked: {
                                AppFramework.clipboard.share(shareURL)
                        }
                }
        }

        PermissionDialog {
                id: permissionDialog
                openSettingsWhenDenied: true
                permission: PermissionDialog.PermissionDialogTypeStorage

                onAccepted: {
                        doc.open()
                }
        }


        DocumentDialog {
                id: doc
                onAccepted: {
                        shareURL = AppFramework.resolvedPathUrl(filePath)
                }
        }

        // check for storage permission
        Component.onCompleted: {
                storagePermissionGranted = Permission.checkPermission(Permission.PermissionTypeStorage) === Permission.PermissionResultGranted
        }
}

The payload parameter

The data to share across apps. Currently, this supports text and URL data types. If the URL is to a file, the file itself will be shared.

Be aware that on Android devices, files saved in cloud-based storage cannot be shared directly. The file must be saved locally.

If data is available on the clipboard, opens a native interface to share this data across apps, including email and social media.

This functionality is only supported on iOS, macOS, and Android.

Item {
        property url urlInfo: "https://appstudio.arcgis.com/"

        Text {
                id: sampleURL
                text: urlInfo
        }

        Button {
                id: copyURL
                anchors.top: sampleURL.bottom
                text: "Copy as URL"

                onClicked: {
                        AppFramework.clipboard.copy(sampleURL.text)
                }
        }

        Button {
                id: shareURL
                anchors.top: copyURL.bottom
                text: "Share as URL"

                onClicked: {
                        AppFramework.clipboard.share()
                }
        }
}