跳到正文
QuireKit
插件文档
Alpha · API 持续演进
Classic 产品扩展查看 Markdown ↗

ClassicWordContentControl · Pro 内容控件编辑器

为行内、行和单元格内容控件提供编辑界面,连接模板与填写模式。通常由专业版预设填入 Word kit 的功能插槽。

为行内、行和单元格内容控件提供编辑界面,连接模板与填写模式。通常由专业版预设填入 Word kit 的功能插槽。

@quirekit/classic-pro · Commercial

编辑器适用范围

层次:Classic 产品适配

编辑器状态所需装配与边界
Classic直接支持createClassicWordProPreset — 使用 createClassicWordProPreset 安装专业产品能力;审阅界面还受 review 特性控制。不要再追加同名社区或专业扩展。
Block未支持Block 不消费 Classic 产品 contribution、plugins 或分页装配。请使用共享能力和 Block 适配入口,不能直接复制此入口的 Classic 配置。

“直接支持”指已有上述产品装配;具体交互、宿主服务和格式支持仍有各自条件。状态与接入规则。许可独立显示。

接入

当前 @quirekit/classic-pro 的包元数据标为 private。本站使用工作区源码;外部项目需先取得对应分发包,不能把下面的公开导出理解为已经能从公共 npm 安装。

此入口属于商业组件。使用前先取得相应分发与授权;安装命令仅适用于已配置该分发源的项目。

先使用 Word 专业预设。这里的单项适配器用于自定义预设或替换子项;不能向已有装配再追加同名扩展。

ts

安装时按包声明选择兼容版本,外部可用版本以分发源为准。本站使用工作区 Alpha;许可标签来自入口所属包,使用条件见支持与许可。

按编辑器接入

以下片段沿用已挂载的宿主元素 element,宿主负责容器尺寸与保存;退出页面时调用 instance.destroy()。已有预设装配的能力不要再重复追加;需要宿主端口的入口应先完成下方配置。

Classic · 直接支持

使用 createClassicWordProPreset 安装专业产品能力;审阅界面还受 review 特性控制。不要再追加同名社区或专业扩展。

createClassicWordProPreset
ts

配置

下面是扩展自身的默认选项。预设可以覆盖这些值;它们不等于当前文档属性。配置方法见配置插件。

ribbon

是否向 Classic 功能区贡献控件。直接使用适配器与由预设装配时的值可能不同。

类型:boolean

默认:false

displayMode

内容控件的初始边框、标签等显示策略,不写入 Word 持久属性。

类型:"alwaysShow" | "automatic" | "hide"

默认:"automatic"

authoringMode

初始模板创作或填写模式,不写入 Word 持久属性。

类型:"fill" | "template"

默认:"template"

resolveProtectedFillMode

读取规范文档保护策略,判断是否强制进入填写交互。

类型:(state: EditorState): boolean

默认:() => false

命令与运行方式

以下命令由此扩展直接提供,均在当前 Editor 上调用。命令是否可用由已安装 schema、当前选区与保护策略决定;可以先用 editor.can() 查询。

命令参数签名
setWordContentControlAuthoringModesetWordContentControlAuthoringMode(mode: WordContentControlAuthoringMode)
moveToWordContentControlmoveToWordContentControl(direction: WordContentControlTraversalDirection)
insertWordInlineCheckboxinsertWordInlineCheckbox(options?: InsertWordInlineCheckboxOptions | undefined)
setWordInlineCheckboxCheckedsetWordInlineCheckboxChecked(checked: boolean)
toggleWordInlineCheckboxtoggleWordInlineCheckbox()
toggleWordInlineCheckboxAtPositiontoggleWordInlineCheckboxAtPosition(options: ToggleWordInlineCheckboxAtPositionOptions)
configureWordInlineCheckboxconfigureWordInlineCheckbox(options: ConfigureWordInlineCheckboxOptions)
insertWordInlineDropDownListinsertWordInlineDropDownList(options?: InsertWordInlineListOptions | undefined)
insertWordInlineComboBoxinsertWordInlineComboBox(options?: InsertWordInlineListOptions | undefined)
selectWordInlineListItemselectWordInlineListItem(value: string)
setWordInlineComboBoxTextsetWordInlineComboBoxText(value: string)
configureWordInlineListconfigureWordInlineList(options: ConfigureWordInlineListOptions)
insertWordInlineDateinsertWordInlineDate(options?: InsertWordInlineDateOptions | undefined)
setWordInlineDateValuesetWordInlineDateValue(value: string)
configureWordInlineDateconfigureWordInlineDate(options: ConfigureWordInlineDateOptions)
insertWordInlinePictureContentControlinsertWordInlinePictureContentControl(options: InsertWordInlinePictureContentControlOptions)
setWordInlineContentControlDisplayModesetWordInlineContentControlDisplayMode(mode: WordInlineContentControlDisplayMode)
setWordInlineContentControlHoveredIdsetWordInlineContentControlHoveredId(controlId: string | null)
fillWordContentControlsfillWordContentControls(options: FillWordContentControlsOptions)
insertWordFormFieldinsertWordFormField(options: InsertWordFormFieldOptions)
insertWordInlineContentControlinsertWordInlineContentControl(options?: InsertWordInlineContentControlOptions | undefined)
exitWordInlineContentControlexitWordInlineContentControl(options: ExitWordInlineContentControlOptions)
updateWordInlineContentControlupdateWordInlineContentControl(options: UpdateWordInlineContentControlOptions)
unwrapWordInlineContentControlunwrapWordInlineContentControl()
deleteWordInlineContentControldeleteWordInlineContentControl()

这里只展示参数签名。接界面时见命令与控件,正文变更继续经过同一事务与历史。

下一步

返回全部插件,或阅读配置插件区分配置、文档属性与命令。

继续Classic 快速接入和配置与生命周期。开发自己的产品界面与服务时,见产品插件开发。

QuireKitQuireKit · Core、插件与 Classic 文档