跳转至

富文本编辑框控件 (SRichEdit)

富文本编辑框是一个功能强大的文本编辑控件,基于 Windows 的 RichEdit 控件实现。它支持富文本格式、样式设置、OLE 对象嵌入等高级功能。这是一个无窗口(Windowless)的实现,完全集成在 SOUI 的渲染体系中。

基本信息

  • 类名SRichEdit
  • 控件标签richedit
  • 基类SWindow
  • 功能:提供富文本编辑功能,支持文本样式、OLE对象等

属性说明

SRichEdit 标签为 edit(通过 SEdit 薄封装转发),继承自 TWindowProxy,是一个功能完整的富文本编辑框。

自身属性

属性名 类型 默认值 说明
text string - 编辑框内容
style int - 原始编辑风格位(一般不直设,用下列语义属性代替)
rich bool false 是否富文本模式(SEdit 默认纯文本)
multiLines bool false 是否多行
wordWrap bool true 多行时是否自动换行
vertical bool false 是否竖排文本
password bool false 是否密码框
passwordChar string - 密码掩码字符
readOnly bool false 是否只读
number bool false 仅允许数字
upperCase bool false 输入自动转大写
lowerCase bool false 输入自动转小写
wantReturn bool false 多行时是否允许回车换行
wantTab bool false 是否捕获 Tab 键
autoSel bool false 获得焦点时是否全选
autoWordSel bool false 双击是否按单词选中
allowBeep bool false 到达边界是否响铃
vcenter bool false 单行时垂直居中
disableCaret bool false 是否隐藏光标
transparent bool false 是否透明背景
maxBuf int - 最大字符数(- 表示不限)
hscrollBar / vscrollBar bool false 是否显示水平 / 垂直滚动条
autoHscroll / autoVscroll bool false 输入超界时是否自动滚动
colorText color - 文本颜色(自定义属性)
align enum left 水平对齐:left / center / right(自定义属性)
rtf string - 直接加载 RTF 内容
notifyChange bool - 内容变化时是否发通知
enableDragdrop bool - 是否允许拖放文本
cueText string - 占位提示文本(来自 SEdit 封装)
cueColor color #cccccc 占位提示颜色(来自 SEdit 封装)

字体、颜色、可用、可见等通用属性见通用属性SEditSRichEdit 属性完全一致,区别仅在于 SEdit 默认 rich=false

使用示例

基本富文本编辑框

<richedit name="reBasic" 
          pos="10,10,410,110" 
          multiLines="1"
          wantReturn="1"
          colorText="#333333"
          font="size:14"
          margin-x="5"
          margin-y="5"/>

只读富文本显示

<richedit name="reDisplay" 
          pos="10,120,410,220" 
          readOnly="1"
          rich="1"
          text="只读富文本内容"/>

带滚动条的多行编辑框

<richedit name="reMultiline" 
          pos="10,230,410,380" 
          multiLines="1"
          wordWrap="1"
          vscrollBar="1"
          autoVscroll="1"
          hscrollBar="1"
          autoHscroll="1"
          cueText="请输入多行文本..."/>

密码输入框

<richedit name="rePassword" 
          pos="10,390,200,420" 
          password="1"
          passwordChar="*"
          cueText="请输入密码"/>

RTF内容显示

<richedit name="reRTF" 
          pos="10,430,410,530" 
          readOnly="1"
          rich="1"
          rtf="rtf:help_document"/>

事件处理

富文本编辑框控件支持以下事件:

事件名 EventID 说明
EVT_RE_NOTIFY EventRENotify::EventID 富文本编辑通知事件
EN_CHANGE - 内容改变事件
EN_UPDATE - 内容更新事件
EN_SETFOCUS - 获得焦点事件
EN_KILLFOCUS - 失去焦点事件
// 事件处理示例
EVENT_MAP_BEGIN()
    EVENT_NAME_HANDLER(L"reBasic", EventRENotify::EventID, OnRENotify)
EVENT_MAP_END()

void OnRENotify(IEvtArgs *pEvt)
{
    EventRENotify *pRealEvt = sobj_cast<EventRENotify>(pEvt);
    // 处理富文本编辑事件
    switch(pRealEvt->iNotify)
    {
    case EN_CHANGE:
        // 内容改变
        break;
    case EN_SETFOCUS:
        // 获得焦点
        break;
    }
}

代码操作

// 查找富文本编辑框控件
SRichEdit *pRichEdit = FindChildByName2<SRichEdit>(L"reBasic");

// 设置文本
pRichEdit->SetWindowText(L"新文本");

// 获取文本
SStringT strText = pRichEdit->GetWindowText();

// 设置只读状态
pRichEdit->SetReadOnly(TRUE);

// 加载RTF内容
pRichEdit->LoadRtfFile(L"rtf:help_document");

// 获取选择文本
pRichEdit->GetSelText(strText);

最佳实践

  1. 合理配置滚动条:根据内容长度设置合适的 vscrollBarhscrollBar 属性
  2. 输入验证:使用 number 等属性限制输入类型
  3. 用户体验:为密码框设置 passwordChar 属性保护用户隐私
  4. 自动选择:在适当场景下使用 autoSel 提升用户体验
  5. 内容提示:通过 cueText 属性提供清晰的输入提示

常见问题

Q: 多行编辑框无法滚动怎么办?

A: 确保设置了 vscrollBarautoVscroll 属性。

Q: 富文本格式无法显示怎么办?

A: 检查是否设置了 rich 属性为 1。

Q: 密码框显示明文怎么办?

A: 检查是否设置了 passwordpasswordChar 属性。

相关控件