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