# 变更记录
| 产品版本 | 更新内容 | 更新日期 |
| --- | --- | --- |
| V6.0.9 | 增加了富文本字段，实现自动绑定、存储、取值、展示，提升研发效率和用户体验 | 2024-04-10 |
# 1 功能介绍
当需要进行图文混排，在文字内进行插入表情、修改样式、进行排版、嵌入表格以及显示代码等功能时使用。
*备注：1.功能与富文本控件基本一致，并兼容富文本控件数据。*
*2.支持PC端和移动端,，移动端仅支持展示数据。*
# 2 控件对象
```java
kd.bos.form.field.RichTextEdit
```
# 3 适用版本
金蝶云苍穹BOS_V6.0.9及以上
# 4 视觉展示
* **PC端**
* **移动端**
# 5 属性说明
## 5.1 通用属性
通用属性包含字段和控件的一些公有的属性，如宽高，帮助文本等等。请参考[通用属性](https://vip.kingdee.com/article/215559076720798976)
## 5.2 样式属性
样式属性是每个控件在设计器右侧样式栏可以设置的属性，请参考[样式属性](https://vip.kingdee.com/article/252017936767406336)
## 5.3 业务属性
| 属性名 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| 锁定时高度自适应 | 复选框 | false | 锁定状态下，开启该属性，富文本字段高度由内容撑开 |
| 工具栏 | | - |
配置自定义的富文本工具栏项，详情见富文本控件支持自定义工具栏 |
## 5.4 二开属性
| 属性名 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| useRelativePath | boolean | false | 上传图片的路径是否使用相对路径。默认使用绝对路径，为true时，新上传的图片将使用相对路径 |
# 6 接口介绍
## 6.1 控件编程模型
### 6.1.1 控件编程模型定义
富文本字段的控件编程模型RichTextEdit，派生自字段控件编程模型基类FieldEdit：
```java
package kd.bos.form.field;
public class RichTextEdit extends FieldEdit {
```
## 6.2 数据模型
富文本字段的属性对象类型为RichTextProp，派生自字段属性对象基类FieldProp，存储String类型的字段值：
```java
package kd.bos.entity.property;
import java.sql.Types;
public class RichTextProp extends FieldProp {
```
RichTextProp重写、新增的方法：
| 方法 | 来源 | 说明 |
| --- | --- | --- |
| getDbType | 重写 | java.sql.Types. NCLOB |
| getPropertyType | 重写 | String.class |
注意：
* 通过数据模型的getValue方法，返回的字段值类型是String，值可能为null；
* 通过数据模型的setValue方法，必须传入String类型的值。
示例：如何获取、设置字段值。
```java
package kd.bos.plugin.sample.dynamicform.pcform.field.bizcase;
import kd.bos.form.plugin.AbstractFormPlugin;
*/***
* * @Author lloam_li*
* * @Date 2024-04-09*
* */*
public class RichTextFieldSample extends AbstractFormPlugin {
public static final String KEY_RICHTEXTFIELD = "richtextfield";
* /***
* * 演示如何读取、设置字段值*
* */*
private void demoFieldValue(){
*// 读取字段值*
String fieldValue = (String) this.getModel().getValue(KEY_RICHTEXTFIELD);
*// 设置字段值*
this.getModel().setValue(KEY_RICHTEXTFIELD, fieldValue);
}
}
```
## 6.3 插件事件
富文本字段，继承了字段标准的插件事件：
| 事件 | 触发时机 |
| --- | --- |
| propertyChanged | 修改字段值之后触发；
以下场景例外：界面数据初始时，不触发此事件；即在afterCreateNewData事件中，修改字段值，不会触发此事件 |
