# SecPasteButton
安全组件的粘贴按钮,用户通过点击该粘贴按钮,可以临时获取读取剪贴板权限,而不会触发toast提示。
> **说明:**
>
> 该组件从API Version 10开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 子组件
不支持。
## 接口
**方法1:** SecPasteButton()
默认创建带有图标、文本、背景的粘贴按钮。
**方法2:** SecPasteButton(option:{icon?: PasteIconStyle, text?: PasteDescription, buttonType?: ButtonType})
创建包含指定元素的粘贴按钮。
**参数:**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ------ | ----------------------------------- | ---- | -------------- |
| icon | [PasteIconStyle](#pasteiconstyle枚举说明) |否 | 设置粘贴按钮的图标风格。
不传入该参数表示没有图标,icon和text至少存在一个。 |
| text | [PasteDescription](#pastedescription枚举说明) | 否 | 设置粘贴按钮的文本描述。
不传入该参数表示没有文字描述,icon和text至少存在一个。 |
| buttonType | [ButtonType](ts-basic-components-button.md#ButtonType枚举说明) | 否 | 设置粘贴按钮的背景样式。
不传入该参数表示没有背景。 |
## 属性
不支持通用属性,仅继承[安全组件通用属性](ts-universal-attributes-securitycomponent.md#属性)。
## PasteIconStyle枚举说明
| 名称 | 描述 |
| ------------------- | ------------------ |
| LINES | 粘贴按钮展示线条样式图标。 |
## PasteDescription枚举说明
| 名称 | 描述 |
| ------------------- | ------------------ |
| PASTE | 粘贴按钮的文字描述为“粘贴”。 |
## SecPasteButtonOnClickResult枚举说明
| 名称 | 描述 |
| ------------------- | ------------------ |
| SUCCESS | 粘贴按钮点击成功。 |
| TEMPORARY_AUTHORIZATION_FAILED | 粘贴按钮点击后权限授权失败。 |
## 事件
不支持通用事件,仅支持以下事件:
| 名称 | 功能描述 |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| onClick((result: [SecPasteButtonOnClickResult](#secpastebuttononclickresult枚举说明), event?: [ClickEvent](ts-universal-events-click.md#clickevent对象说明)) => void) | 点击动作触发该回调。
result:剪贴板权限的授权结果,授权后可以读取当前剪贴板内容,如果内容发生变化再次读取仍需授权。
event:见ClickEvent对象说明。 |
## 示例
```ts
// xxx.ets
@Entry
@Component
struct Index {
build() {
Row() {
Column({space:10}) {
// 默认参数下,图标、文字、背景都存在
SecPasteButton()
// 传入参数即表示元素存在,不传入的参数表示元素不存在,例如:只显示图标
SecPasteButton({icon:PasteIconStyle.LINES})
// 只显示图标+背景
SecPasteButton({icon:PasteIconStyle.LINES, buttonType:ButtonType.Capsule})
// 图标、文字、背景都存在
SecPasteButton({icon:PasteIconStyle.LINES, text:PasteDescription.PASTE, buttonType:ButtonType.Capsule})
}.width('100%')
}.height('100%')
}
}
```
