本页内容
自定义UI
"ComPDFKit.Controls" 文件夹包含了可引导快速集成ComPDFKit PDF SDK的UI组件。我们还使用这个UI组件库构建了六个独立的功能程序，分别是Viewer，Annotations，ContentEditor，Forms，DocsEditor 和 Digital Signature。此外，我们还开发了一个叫做PDFViewer的程序，它集成了所有以上提到的示例功能供您参考。在本节中，我们会从以下几部分介绍如何使用它：
- "ComPDFKit.Controls" 概述: 展示文件夹结构和对应的功能板块。
- UI 组件：介绍UI组件以及如何轻松快速地使用它们。
"ComPDFKit.Controls"概览
"ComPDFKit.Controls" 中有九个模块： "Common"、"Viewer"、"Annotations"、"ContentEditor"、"Forms"、"DocsEditor"、"DigitalSignature"、"Security" 和 "Watermark"。如下表所示，每个模块都包含对应 PDF 功能的代码和 UI 组件。
| 目录 | 二级目录 | 描述 |
|---|---|---|
| Common | BaseControl | 用于组成其他组件部分的基础组件, 例如:可通过侧边按钮增加减少的数字输入框：NumericalUpDown。 |
| Convert | 数据转换器 | |
| Helper | 用于对常用功能提供协助的静态类和静态方法，例如：可以唤起文件开启弹窗并取得选定的PDF文件路径的静态方法：GetFilePathOrEmpty()。 | |
| PasswordControl | 用于输入文件密码的控件和弹窗。 | |
| PropertyControl | 在各个模块中，用于处理指定数据类型输入的控件。 | |
| PDFView | PDFBookmark | 包含实现文档书签列表和页面跳转的 UI 组件以及视图控制器。 |
| PDFInfo | 提供了书签的创建信息、摘要信息、安全信息的组件。 | |
| PDFDisplaySettings | 提供了 PDF 文件的显示相关设置的控件，诸如翻页模式设置，色彩主题设置等。 | |
| PDFOutline | 包含实现文档大纲和大纲跳转的 UI 组件以及视图控制器。 | |
| PDFSearch | 包含实现文档搜索功能和生成搜索列表的 UI 组件以及视图控制器。 | |
| PDFThumbnail | 包含实现文档缩略图的UI组件以及视图控制器。 | |
| PropertyControl | 在各个模块中，用于处理指定数据类型输入的控件。 | |
| PropertyControl | 在各个模块中，用于处理指定数据类型输入的控件。 | |
| Annotations | PDFAnnotationBar | 包含实现修改注释属性和返回/撤销返回注释的操作的工具栏。 |
| PDFAnnotationPanel | 创建或修改注释时，显示指定属性面板并处理数据的控件。 | |
| PDFAnnotationList | 提供了显示全文所有注释、选中指定注释、删除指定注释和全部注释功能的注释列表组件。 | |
| ContentEditor | PDFImageEditControl | 图片编辑功能的操作和属性面板。 |
| PDFTextEditControl | 文字编辑功能的操作和属性面板。 | |
| Forms | FormBarControl | 可以在初始化时指定需要的表单类型和顺序的导航栏。 |
| FromPropertyControl | 创建或修改表单时，显示指定属性面板并处理数据的控件。 | |
| Docs Editor | PDFPageEditBar | 页面编辑导航栏。 |
| PDFPageEdit | 页面编辑控件，提供了页面略缩图，拖拽、右键菜单等功能。 | |
| PDFPageExtract | 页面提取弹窗，该弹窗只进行数据处理和传递，实际操作在 PDFPageEdit 处理。 | |
| PDFPageInsert | 页面插入弹窗，该弹窗只进行数据处理和传递，实际操作在 PDFPageEdit 处理。 | |
| Digital Signatures | AddCertificationDialog | 创建新证书，或使用已有证书的弹窗。 |
| CPDFSignatureListControl | 展示数字签名列表和签名状态的控件，可以跳转到指定签名位置或打开签名状态弹窗。 | |
| VerifyDigitalSignatureControl | 展示签名状态的弹窗。 | |
| SignatureStatusBarControl | 展示文档中所有签名状态的弹窗。 | |
| FillDigitalSignatureDialog | 创建签名样式的弹窗。 | |
| ViewCertificateDialog | 查看数字签名证书信息的弹窗。 |
UI 组件
本节主要介绍 "ComPDFKit.Controls" 的 UI 组件与 API 配置之间的联系，这不仅可以帮助你快速上手 ComPDFKit 默认的 UI，还可以帮助你查看相关的 API 配置。这些 UI 组件可以被使用和修改，以创建你自定义的 UI。
Part 1:
上图是 Viewer 模块 API 所关联的主要 UI 组件，同时也是 ComPDFKit.Controls 最基础的 UI 组件。其 UI 组件与关联的 API 如下表所示：
| 编号 | 名称 | 关联组件 | 描述 |
|---|---|---|---|
| 1-1 | Title bar | CPDFTitleBarControl | 标题栏。 |
| 1-2 | Open file button | / | 可以在当前页面内打开一个新的文档。 |
| 1-3 | Save button | / | 保存当前文件。 |
| 1-4 | Left panel button | CPDFBOTABarControl | 控制 BOTA 面板展示状态。 |
| 1-5 | Page scalling control | CPDFScalingControl | 改变 PDF 文件的缩放比例。 |
| 1-6 | Mode switcher | / | 功能模式切换。 |
| 1-7 | Search button | CPDFBOTABarControl | 展开 BOTA 面板并进入搜索。 |
| 1-8 | Display settings button | CPDFDisplaySettingsControl | 控制显示设置面板显示隐藏。 |
| 1-9 | Right panel button | CPDFAnnotationControl、FromPropertyControl、PDFContentEditControl | 控制 BOTA 面板展示状态。 |
| 1-10 | PDF info button | CPDFInfoControl | PDF 文件信息弹窗。 |
| 1-11 | Page turning control | PageNumberControl | 页码显示与跳转。 |
| 1-12 | PDFViewControl | PDFViewControl | PDF 部分交互。 |
Part 2:
上图是界面左侧面板的示意图，该面板包括的功能为大纲、书签、缩略图、注释列表、搜索。其UI组件与关联的 API如下表所示：
| 编号 | 名称 | 关联组件 | 描述 |
|---|---|---|---|
| 1-1 | Thumbnails | CPDFThumbnailControl | 显示缩略图，点击后跳转到指定页面。 |
| 1-2 | Outlines | CPDFOutlineControl | 显示大纲，点击后跳转指定页面。 |
| 1-3 | Bookmark | CPDFBookmarkControl | 创建，删除书签，点击后跳转指定页面。 |
| 1-4 | Annotation List | CPDFThumbnailControl | 选中注释，删除注释。 |
| 1-5 | Search | CPDFSearchControl | 搜索并高亮关键字。 |
Part 3:
上图是注释模块的示意图。其 UI 组件与关联的 API 如下表所示：
| 编号 | 名称 | 关联组件 | 描述 |
|---|---|---|---|
| 1-1 | Annotation bar | CPDFAnnotationBarControl | 注释模式导航栏，可以通过初始化指定注释顺序和种类。 |
| 1-2 | Undo redo | / | 返回与撤销返回对注释进行的操作。 |
| 1-3 | Annotation panel | CPDFAnnotationControl | 可以预设注释创建时属性，点击注释后会生成临时属性。 |
Part 4:
上图是 PDF 内容编辑模块的示意图。其 UI 组件与关联的 API 如下表所示：
| 编号 | 名称 | 关联组件 | 描述 |
|---|---|---|---|
| 1-1 | Content edit bar | / | 内容编辑的导航栏，点击文字编辑后进入创建文字和仅限文字编辑的状态，点击图片编辑后可以添加图片，未选择模式则图片和文字都可以编辑。 |
| 1-2 | Undo redo | / | 返回与撤销返回对 PDF 内容进行的操作。 |
| 1-3 | Content edit panel | PDFContentEditControl | 可以预设文字创建时属性，点击文字或图片后会生成临时属性。 |
Part 5:
上图是表单模块的示意图。其 UI 组件与关联的 API 如下表所示：
| 编号 | 名称 | 关联组件 | 描述 |
|---|---|---|---|
| 1-1 | Forms edit bar | CPDFFormBarControl | 表单功能的导航栏。 |
| 1-2 | Undo redo | / | 返回与撤销返回对 PDF 表单的操作。 |
| 1-3 | Forms panel | FromPropertyControl | 可以设置表单的属性。 |
Part 6:
上图是页面编辑模块的示意图。其 UI 组件与关联的 API 如下表所示：
| 编号 | 名称 | 关联组件 | 描述 |
|---|---|---|---|
| 1-1 | Docs edit bar | CPDFPageEditBarControl、CPDFPageExtractWindow、CPDFPageInsertWindow | 页面编辑功能的导航栏。 |
| 1-2 | Docs editor | CPDFPageEditControl | 展示缩略图并实现页面编辑功能的控件。 |
Part 7:
上图是数字签名模块的示意图。其 UI 组件与关联的 API 如下表所示：
| 编号 | 名称 | 关联组件 | 描述 |
|---|---|---|---|
| 1-1 | Signature bar | AddCertificationDialog、FillDigitalSignatureDialog | 添加签名域、验证所有签名。 |
| 1-2 | Signature status bar | SignatureStatusBarControl | 展示当前所有签名的状态。 |
| 1-3 | Signature list | ViewCertificateDialog | 展示所有签名的签名列表。 |