1# PasteButton 2 3<!--Kit: ArkUI--> 4<!--Subsystem: Security--> 5<!--Owner: @harylee--> 6<!--Designer: @linshuqing; @hehehe-li--> 7<!--Tester: @leiyuqian--> 8<!--Adviser: @zengyawen--> 9 10安全控件的粘贴控件。用户点击粘贴控件，应用可以临时获取读取剪贴板权限。 11 12> **说明：** 13> 14> 该组件从API version 10开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 15 16## 子组件 17 18不支持。 19 20## 接口 21 22### PasteButton 23 24PasteButton() 25 26默认创建带有图标、文本、背景的粘贴控件。 27 28为避免因控件样式不合法而导致授权失败，请开发者先了解安全控件样式的[约束与限制](../../../security/AccessToken/security-component-overview.md#约束与限制)。 29 30**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 31 32**系统能力：** SystemCapability.ArkUI.ArkUI.Full 33 34### PasteButton 35 36PasteButton(options: PasteButtonOptions) 37 38创建包含指定元素的粘贴控件。 39 40为避免因控件样式不合法而导致授权失败，请开发者先了解安全控件样式的[约束与限制](../../../security/AccessToken/security-component-overview.md#约束与限制)。 41 42**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 43 44**系统能力：** SystemCapability.ArkUI.ArkUI.Full 45 46**参数：** 47 48| 参数名 | 类型 | 必填 | 说明 | 49| -------- | -------- | -------- | -------- | 50| options | [PasteButtonOptions](#pastebuttonoptions) | 是 | 创建包含指定元素的粘贴控件。<br/>默认值：<br/>{<br/>icon: PasteIconStyle.LINES,<br/>text: PasteDescription.PASTE,<br/>buttonType: ButtonType.Capsule <br/>} | 51 52## PasteButtonOptions 53 54用于指定粘贴控件的图标、文本等指定元素。 55 56> **说明：** 57> 58> - icon或text需至少传入一个。<br> 59> - 如果icon、text都不传入，[PasteButton](#pastebutton-1)中的options参数不起效，创建的PasteButton为默认样式。 60> 61> - PasteIconStyle默认样式为LINES。 62> 63> - PasteDescription默认样式为PASTE。 64> 65> - ButtonType默认样式为Capsule。 66> - icon、text和buttonType不支持动态修改。 67 68**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 69 70**系统能力：** SystemCapability.ArkUI.ArkUI.Full 71 72| 名称 | 类型 | 只读 | 可选 | 说明 | 73| -------- | -------- | -------- | -------- | -------- | 74| icon | [PasteIconStyle](#pasteiconstyle枚举说明) | 否 | 是 | 设置粘贴控件的图标风格。<br/>不传入该参数表示没有图标。 | 75| text | [PasteDescription](#pastedescription枚举说明) | 否 | 是 | 设置粘贴控件的文本描述。<br/>不传入该参数表示没有文字描述。 | 76| buttonType | [ButtonType](ts-securitycomponent-attributes.md#buttontype枚举说明) | 否 | 是 | 设置粘贴控件的背景样式。<br/>不传入该参数，系统默认提供Capsule类型按钮。 | 77 78## 属性 79 80不支持通用属性，仅继承[安全控件通用属性](ts-securitycomponent-attributes.md)。 81 82## PasteIconStyle枚举说明 83 84粘贴控件的图标风格。 85 86**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 87 88**系统能力：** SystemCapability.ArkUI.ArkUI.Full 89 90| 名称 | 值 | 说明 | 91| -------- | -------- | -------- | 92| LINES | 0 | 粘贴控件展示线条样式图标。 | 93 94## PasteDescription枚举说明 95 96粘贴控件的文本描述。 97 98**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 99 100**系统能力：** SystemCapability.ArkUI.ArkUI.Full 101 102| 名称 | 值 | 说明 | 103| -------- | -------- | -------- | 104| PASTE | 0 | 粘贴控件的文字描述为“粘贴”。 | 105 106## PasteButtonOnClickResult枚举说明 107 108粘贴控件点击后的授权结果。 109 110**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 111 112**系统能力：** SystemCapability.ArkUI.ArkUI.Full 113 114| 名称 | 值 | 说明 | 115| -------- | -------- | -------- | 116| SUCCESS | 0 | 粘贴控件点击后权限授权成功。 | 117| TEMPORARY_AUTHORIZATION_FAILED | 1 | 粘贴控件点击后权限授权失败。 | 118 119## PasteButtonCallback<sup>18+</sup> 120 121type PasteButtonCallback = (event: ClickEvent, result: PasteButtonOnClickResult, error?: BusinessError<void>) => void 122 123点击粘贴控件触发该回调。 124 125**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。 126 127**系统能力：** SystemCapability.ArkUI.ArkUI.Full 128 129**参数：** 130 131| 参数名 | 类型 | 必填 | 说明 | 132|------------|------|-------|---------| 133| event | [ClickEvent](ts-universal-events-click.md#clickevent对象说明) |是 |见ClickEvent对象说明。| 134| result | [PasteButtonOnClickResult](#pastebuttononclickresult枚举说明)| 是 | 剪贴板权限的授权结果，授权后可以读取当前剪贴板内容。| 135| error | [BusinessError<void>](../../apis-basic-services-kit/js-apis-base.md#businesserror) | 否 | 点击按钮时的错误码和错误信息。<br>错误码0表示点击粘贴控件授权成功。<br>错误码1表示系统内部错误。<br>错误码2表示属性设置错误，包括但不限于：<br>1. 字体或图标设置过小。<br>2. 字体或图标与背托颜色相近。<br>3. 字体或图标颜色过于透明。<br>4. padding为负值。<br>5. 按钮被其他组件或窗口遮挡。<br>6. 文本超出背托范围。<br>7. 按钮超出窗口或屏幕。<br>8. 按钮整体尺寸过大。<br>9. 按钮文本被截断，显示不全。<br>10. 相关属性设置影响安全控件显示。| 136 137## 事件 138 139不支持通用事件，仅支持以下事件： 140 141### onClick 142 143onClick(event: PasteButtonCallback) 144 145点击动作触发该回调。 146 147**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 148 149**系统能力：** SystemCapability.ArkUI.ArkUI.Full 150 151**参数：** 152 153| 参数名 | 类型 | 必填 | 说明 | 154|------------|------|-------|---------| 155| event | [PasteButtonCallback](#pastebuttoncallback18) |是 |见PasteButtonCallback。<br>在API10-17时，参数类型为：(event: [ClickEvent](ts-universal-events-click.md#clickevent对象说明), result: [PasteButtonOnClickResult](#pastebuttononclickresult枚举说明)) => void。<br>从API18开始，变更为PasteButtonCallback。| 156 157## 示例 158 159```ts 160// xxx.ets 161import { BusinessError } from '@kit.BasicServicesKit'; 162 163@Entry 164@Component 165struct Index { 166 handlePasteButtonClick: PasteButtonCallback = 167 (event: ClickEvent, result: PasteButtonOnClickResult, error?: BusinessError<void>) => { 168 if (result === PasteButtonOnClickResult.SUCCESS) { 169 console.info("success"); 170 } else { 171 console.error("errCode: " + error?.code); 172 console.error("errMessage: " + error?.message); 173 } 174 }; 175 176 build() { 177 Row() { 178 Column({ space: 10 }) { 179 // 默认参数下，图标、文字、背景都存在。 180 PasteButton().onClick(this.handlePasteButtonClick) 181 // 传入参数即表示元素存在，不传入的参数表示元素不存在，如果不传入buttonType，会默认添加ButtonType.Capsule配置，显示图标+背景。 182 PasteButton({ icon: PasteIconStyle.LINES }) 183 // 只显示图标+背景，如果设置背景色高八位的α值低于0x1a，则会被系统强制调整为0xff。 184 PasteButton({ icon: PasteIconStyle.LINES, buttonType: ButtonType.Capsule }) 185 .backgroundColor(0x10007dff) 186 // 图标、文字、背景都存在，如果设置背景色高八位的α值低于0x1a，则会被系统强制调整为0xff。 187 PasteButton({ icon: PasteIconStyle.LINES, text: PasteDescription.PASTE, buttonType: ButtonType.Capsule }) 188 // 图标、文字、背景都存在，如果设置宽度小于当前属性组合下允许的最小宽度时，宽度仍为设置值，此时按钮文本信息会自动换行，以保证安全控件显示的完整性。 189 PasteButton({ icon: PasteIconStyle.LINES, text: PasteDescription.PASTE, buttonType: ButtonType.Capsule }) 190 .fontSize(16) 191 .width(30) 192 // 图标、文字、背景都存在，如果设置宽度小于当前属性组合下允许的最小宽度时，宽度仍为设置值，此时按钮文本信息会自动换行，以保证安全控件显示的完整性。 193 PasteButton({ icon: PasteIconStyle.LINES, text: PasteDescription.PASTE, buttonType: ButtonType.Capsule }) 194 .fontSize(16) 195 .size({ width: 30, height: 30 }) 196 // 图标、文字、背景都存在，如果设置宽度小于当前属性组合下允许的最小宽度时，宽度仍为设置值，此时按钮文本信息会自动换行，以保证安全控件显示的完整性。 197 PasteButton({ icon: PasteIconStyle.LINES, text: PasteDescription.PASTE, buttonType: ButtonType.Capsule }) 198 .fontSize(16) 199 .constraintSize({ 200 minWidth: 0, 201 maxWidth: 30, 202 minHeight: 0, 203 maxHeight: 30 204 }) 205 }.width('100%') 206 }.height('100%') 207 } 208} 209``` 210 211 212
