描述
可用于设置文档参数。
接口
bool SetDocConfig(const char* doc_name, const char* json)| 参数名 | 必填 | 类型 | 说明 | 备注 |
|---|---|---|---|---|
| doc_name | 是 | string | 文档名 | 为””时表示当前选中文档 |
| json | 是 | json | 配置参数 | 桌面版接口：json字符串 web版接口：json对象 |
json参数
| 参数名 | 必填 | 类型 | 说明 | 备注 | 保存到xml |
|---|---|---|---|---|---|
| pasteCheckDocIdMode | 否 | enum | 粘贴时，检查文档(病历)ID。需配合设置docId | 0：不检查 1：禁止不提示 2：禁止并提示 3：提示用户是否选择粘贴 | / |
| docId | 否 | string | 设置文档-docId | 是 | |
| pasteCheckUserIdMode | 否 | enum | 粘贴时，检查用户Id。需配合设置userId | 0：不检查 1：禁止不提示 2：禁止并提示 3：提示用户是否选择粘 | / |
| userId | 否 | string | 设置用户Id-userId | 是 | |
| forbid_copy | 否 | bool | 禁止复制 | 0：允许复制 1：禁止复制 | / |
| forbid_paste | 否 | bool | 禁止粘贴 | 0：允许粘贴，粘贴行为可由”check_doc_id”、”check_visit_id”进一步控制 1：禁止粘贴 |
/ |
| series_split_mode | 否 | int | 分词拆分模式 | 0：跟随段落配置 1：全局允许分词 2：全局禁止分词E_CFG_MODE | 保存 |
| auto_jump_mode | 否 | int | 回车元素跳转模式 | 0：跟随元素配置 1：全局允许跳转 2：全局禁止跳转E_CFG_MODE | 保存 |
| docRename | 否 | string | 文档新名称 | / | |
| name | 否 | string | 文档名 | name与regName配合使用，详见设计手册 | 保存 |
| regName | 否 | string | 需使用的注册文档名 | name与regName配合使用，详见设计手册 | 保存 |
| passAppResult | 否 | string | 传递应用结果 | 主要应用于自定义运算场景 | / |
| passAppMsg | 否 | string | 传递应用消息 | 主要应用于自定义运算场景，”interrupt”:表示中止编辑器内置运算流程 “only-fill”:表示使用应用传递的运算结果，由编辑器继续执行自动填充显示结果流程 | / |
| forbidCopyEleObject | 否 | bool | 全局禁止复制元素对象，只复制元素内容 | 主要应用于用户编辑文档时，不再因复制而产生新的元素 | / |
| locked | 否 | bool | 正文内段落被锁定，不可编辑 | 0：解锁 1：锁定 | 保存 |
| dynamicLocked | 否 | bool | 正文内段落被锁定，不可编辑 | 0：解锁 1：锁定 | / |
| lockedBackColor | 否 | ARGB | 设置锁定内容背景颜色效果 | 透明：”00000000” 默认：灰色:”FFC0C0C0” 或 “C0C0C0” | / |
| forbidDocModifiedEvent | 否 | bool | 当有内容修改时，是否产生”docModified”事件 | 0：产生 1：禁止产生 | / |
| forbidDragModifyTableSize | 否 | bool | 禁止拖动修改文档中所有表格单元格的尺寸 | 0：不禁止 1：禁止 | / |
| disableReviseTip | 否 | bool | 是否显示痕迹悬浮提示框 | 0：显示 1：不显示 | / |
| disableParagraphLockedTip | 否 | bool | 是否显示段落悬浮提示框 | 0：显示 1：不显示 | / |
| strictEdit | 否 | bool | 严格编辑模式（表单模式） | 0：普通模式 1：表单模式 | / |
| excludeKeywords | 否 | string | 全文禁用关键字，多个时使用’;’分隔 | 示例：”咳嗽;编程;” | 保存 |
| commentForbidEdit | 否 | bool | 批注框是否禁止编辑 | 0：可编辑 1：不可编辑 | / |
页面布局相关
| 参数名 | 必填 | 类型 | 说明 | 备注 | 保存到xml |
|---|---|---|---|---|---|
| layoutPagesMode | 否 | string | 布局页面模式 | “ratio”: 按比例设定 “fillViewWidth”: 使用一页宽自动填充视图宽度 |
/ |
| layoutPagesScale | 否 | float | 显示比例。屏幕dpi为96时，设置为1.2显示效果较好。可通过SetEditorConfig.displayScaleMinValue/displayScaleMaxValue设置用户缩放范围 | 需配合 layoutPagesMode=”Ratio”使用 | / |
| layoutPagesIntervalX | 否 | float | 页左右间隔 | 单位：cm | / |
| layoutPagesIntervalY | 否 | float | 页上下间隔 | 单位：cm | / |
返回值
| 类型 | 说明 | 备注 |
|---|---|---|
| bool | 是否有更新 | 0：设置失败 1：设置成功 |
文档更新时间: 2025-01-10 11:17 作者：admin
