ArkTS API 9 剪贴板的功能和使用原创

Min0915

发布于 2024-3-11 11:36

浏览

1收藏

剪贴板

剪贴板服务作为杂散子系统的功能组件，提供管理系统剪贴板的能力，为系统复制、粘贴功能提供支持。系统剪切板支持包文本、超本文、URI等内容操作。

剪贴板服务基本原理示意图：
ArkTS API 9 剪贴板的功能和使用-鸿蒙开发者社区

开发步骤：

1. 导入模块

import pasteboard from '@ohos.pasteboard';
1.

2. 构建剪贴板内容对象

const text = 'Hello World';
let pasteData = pasteboard.createData('text/plain', text);
1.
2.

系统预定义的数据类型常量

名称	类型	值	说明
MIMETYPE_TEXT_HTML	string	‘text/html’	HTML内容的MIME类型定义
MIMETYPE_TEXT_WANT	string	‘text/want’	Want内容的MIME类型定义。
MIMETYPE_TEXT_PLAIN	string	‘text/plain’	纯文本内容的MIME类型定义。
MIMETYPE_TEXT_URI	string	‘text/uri’	URI内容的MIME类型定义。
MIMETYPE_PIXELMAP	string	‘pixelMap’	PixelMap内容的MIME类型定义

const text = 'Hello World';
// 使用预定义的数据类型常量构建剪贴板内容对象
let pasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN, text);
1.
2.
3.

3. 配置剪贴板内容对象属性，当前仅支持设置 shareOption 属性（可选）

// 1.获取剪贴板内容的属性描述对象
let prop = pasteData.getProperty();
// 2.设置shareOption属性
// shareOption 默认是 CROSSDEVICE
prop.shareOption = pasteboard.ShareOption.INAPP;
// 3.把属性设置回对象
pasteData.setProperty(prop);
1.
2.
3.
4.
5.
6.
7.

shareOption 的范围类型枚举：

名称	值	说明
INAPP	0	表示仅允许同应用内粘贴。
LOCALDEVICE	1	表示允许在此设备中任何应用内粘贴。
CROSSDEVICE	2	表示允许跨设备在任何应用内粘贴

4. 获取系统剪切板

let systemPasteboard = pasteboard.getSystemPasteboard();
1.

5. 清空剪贴板

systemPasteboard.clearData().then(() => {
    console.info('Succeeded in clearing the pasteboard.');
}).catch((err) => {
    console.error(`Failed to clear the pasteboard. Cause: ${err.message}`);
});
1.
2.
3.
4.
5.

6. 将剪贴板内容对象写入系统剪贴板

systemPasteboard.setData(pasteData).then(() => {
    console.info('Succeeded in setting PasteData.');
}).catch((err) => {
    console.error('Failed to set PasteData. Cause: ' + err.message);
});
1.
2.
3.
4.
5.

7. 从系统剪贴板获取内容对象

检测系统剪贴板中是否存在数据

systemPasteboard.hasData().then((data: boolean) => {
    console.info(`Succeeded in checking the PasteData. Data: ${data}`);
}).catch((err: BusinessError) => {
    console.error(`Failed to check the PasteData. Cause: ${err.message}`);
});
1.
2.
3.
4.
5.

使用API获取

systemPasteboard.getData().then((pasteData) => {
    // 从剪贴板内容对象中获取文本内容
    let text = pasteData.getPrimaryText();
}).catch((err) => {
    console.error('Failed to get PasteData. Cause: ' + err.message);
})
1.
2.
3.
4.
5.
6.

输入框自带的粘贴事件获取

TextInput({ text: this.text1 })
        .onPaste((value: string) => {
          // value 为系统剪贴板中的内容
        })
1.
2.
3.
4.

完整示例代码

import pasteboard from '@ohos.pasteboard'
import promptAction from '@ohos.promptAction'
import { Logger } from '../utils/Logger'

@Entry
@Component
struct Index {
@State strList: Array<string> = ['这是被复制的示例文本1', '这是被复制的示例文本2', '这是被复制的示例文本3',]
@State text1: string = ''
@State text2: string = ''
@State text3: string = ''

build() {
 Column({ space: 32 }) {
   ForEach(this.strList, (item: string) => {
     Row({ space: 24 }) {
       Text(item)
         .layoutWeight(1)
       Button('复制', { type: ButtonType.Normal })
         .onClick(() => {
           this.handleCopyText(item)
         })
     }
     .width('100%')
   })

   Text('TextInput 文本输入框')
   TextInput({ text: this.text1, placeholder: '请输入内容...' })
     .onChange((value: string) => {
       this.text1 = value
     })

   Text('TextArea 多行文本输入框')
   TextArea({ text: this.text2, placeholder: '请输入内容...', })
     .onChange((value: string) => {
       this.text2 = value
     })

   Text('Text 组件')
   Row({ space: 24 }) {
     Text(this.text3)
       .height(40)
       .layoutWeight(1)
       .padding({
         left: 16
       })
       .border({
         width: { bottom: 1 },
         color: '#33182431'
       })

     Button('粘贴', { type: ButtonType.Normal })
       .onClick(() => {
         this.handlePasteText()
           .then((text: string) => {
             this.text3 = text
           })
           .catch((err) => {
           })
       })
   }
   .width('100%')
 }
 .width('100%')
 .height('100%')
 .padding({
   left: 16,
   right: 16
 })
}

/**
* 复制文本到系统剪贴板
* @param text
*/
handleCopyText(text) {
 // 创建剪贴板内容对象
 let pasteData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN, text);

 // 设置可以被粘贴的范围(可选)
 // let prop = pasteData.getProperty();
 // 不设置则 shareOption 属性默认为 CROSSDEVICE  
 // prop.shareOption = pasteboard.ShareOption.INAPP;
 // pasteData.setProperty(prop);

 // 获取系统剪贴板
 let systemPasteboard = pasteboard.getSystemPasteboard()
 // 清空系统剪贴板
 systemPasteboard.clearData().then(() => {
   Logger.info('Succeeded in clearing the pasteboard.');
   // 将数据写入系统剪贴板
   systemPasteboard.setData(pasteData).then(() => {
     promptAction.showToast({
       message: '复制成功',
     })
   }).catch((err) => {
     promptAction.showToast({
       message: err.message,
     })
   });
 }).catch((err) => {
   Logger.error(`Failed to clear the pasteboard. Cause: ${err.message}`);
 });
}

/**
* 从系统剪贴板获取复制的文本
*/
handlePasteText() {
 let systemPasteboard = pasteboard.getSystemPasteboard()
 return new Promise((resolve, reject) => {
   // 判断系统剪贴板中是否存在数据
   systemPasteboard.hasData()
     .then((hasData: boolean) => {
       Logger.info('has data in PasteData:', JSON.stringify(hasData))
       if (!hasData) {
         promptAction.showToast({
           message: '系统剪贴板中不否存在数据',
         })
         return
       }

       // 获取系统剪贴板中的数据
       systemPasteboard.getData()
         .then((pasteData: pasteboard.PasteData) => {
           // 从PasteData对象中获取被复制的文本内容
           let text: string = pasteData.getPrimaryText()
           Logger.info('pasteboard content:', JSON.stringify(text))
           resolve(text)
         })
         .catch((err) => {
           Logger.error('Failed to get PasteData. Cause: ', err.message)
           reject(err)
         })
     })
     .catch((err) => {
       Logger.error('Failed to check the PasteData. Cause:', err.message)
       reject(err)
     })
 })
}
}
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
55.
56.
57.
58.
59.
60.
61.
62.
63.
64.
65.
66.
67.
68.
69.
70.
71.
72.
73.
74.
75.
76.
77.
78.
79.
80.
81.
82.
83.
84.
85.
86.
87.
88.
89.
90.
91.
92.
93.
94.
95.
96.
97.
98.
99.
100.
101.
102.
103.
104.
105.
106.
107.
108.
109.
110.
111.
112.
113.
114.
115.
116.
117.
118.
119.
120.
121.
122.
123.
124.
125.
126.
127.
128.
129.
130.
131.
132.
133.
134.
135.
136.
137.
138.
139.
140.
141.
142.