SignatureField
概述
SignatureField 是 Aspose.PDF FOSS 用于 .NET 的一个类。继承自:Field。
此类提供 34 个用于在 .NET 程序中处理 SignatureField 对象的方法。可用的方法包括:Accept、ChangeAfterResize、Clone、CopyTo、ExecuteFieldJavaScript、ExportToJson、ExportValueToJson、ExtractCertificate、ExtractCertificateObject、ExtractImage、Field、Flatten,以及另外 12 个方法。安装 Aspose.PDF FOSS for .NET 包后,所有公共成员对任何 .NET 应用程序均可访问。属性:Action、Actions、ActiveState、Alignment、AlternateName、AnnotationFlags,以及另外 74 项。
属性
| 名称 | 类型 | 访问 | 描述 |
|---|---|---|---|
SignedBytes | byte[]? | 读取 | 返回最新的已签名字节,如果该字段尚未通过 Sign(Signature) 签名,则返回 null。 |
Signature | Signature? | 读取 | 关于此字段中数字签名的信息。 |
Type | FieldType | 读取 | 字段类型。 |
FullName | string? | 读取 | 完整限定的字段名称。 |
TextHorizontalAlignment | Aspose.Pdf.HorizontalAlignment | 读写 | 针对文本的水平对齐覆盖,应用于字段小部件的外观。 |
PageIndex | int | 读取 | 拥有此字段小部件的页面的基于1的索引。 |
PartialName | string? | 读写 | 部分字段名称 (/T)。 |
NormalAppearance | XForm? | 读取 | 字段的 “Normal” 外观(/AP /N 条目)。 |
Appearance | Aspose.Pdf.Annotations.AppearanceDictionary | 读取 | 字段小部件的外观流(/AP 条目),按外观名称键入。 |
OnActivated | Annotations.PdfAction? | 读写 | 当此字段被激活时触发的操作(/A 条目)。 |
Value | string? | 读写 | 字段值 (/V)。 |
Count | int | 读取 | 此字段的 /Kids 数组中的子项数量——可以是子字段(层次节点)或小部件注释(具有多个可视小部件的终端字段,例如分组的复选框/单选框)。 |
Fields | Field[] | 读取 | 此字段的字段类型子项(child kids)作为快照数组——便捷访问器,映射表单上的 Fields。 |
DefaultValue | string? | 读取 | 默认值 (/DV)。 |
AlternateName | string? | 读写 | 备用字段名称 / 工具提示 (/TU entry)。 |
Flags | Aspose.Pdf.Annotations.AnnotationFlags | 读写 | 小部件注释标志 (/F entry),例如。 |
TabOrder | int | 读写 | 此字段的 Tab 顺序索引。 |
IsReadOnly | bool | 读取 | 字段是否为只读。 |
ReadOnly | bool | 读写 | 字段是否为只读(可设置的 API 奇偶校验别名)。 |
IsRequired | bool | 读取 | 字段是否为必填。 |
Characteristics | Aspose.Pdf.Annotations.Characteristics | 读取 | 外观特征(边框/背景颜色,部件旋转)。 |
DefaultAppearance | Aspose.Pdf.Annotations.DefaultAppearance | 读写 | 字段的默认外观(字体、大小、颜色)——WidgetAnnotation 的字段级对应。 |
Rect | Rectangle? | 读写 | 字段矩形。 |
Color | Color | 读写 | 字段颜色(存储在 /DA 默认外观字符串中,采用 RGB)。 |
AnnotationIndex | int | 读写 | 以 1 为基准的标签位置,指该字段的部件在其页面的 /Annots 数组中的位置——数组顺序即页面的标签顺序。 |
FitIntoRectangle | bool | 读写 | 全局标志:当为 true 时,字段的值会自动调整大小以适应其部件矩形。 |
IsGroup | bool | 读取 | 此字段是否为子字段的容器/组。 |
IsSharedField | bool | 读写 | 此字段是否属于 shared-fields 组。 |
IsSynchronized | bool | 读取 | 集合是否是线程安全的。 |
SyncRoot | object | 读取 | 同步根;返回此实例。 |
MaxFontSize | double | 读写 | 字段外观自动适配使用的最大字体大小。 |
MinFontSize | double | 读写 | 字段外观自动适配使用的最小字体大小。 |
MappingName | string? | 读写 | 映射名称,用于外部脚本识别该字段。 |
AnnotationType | AnnotationType | 读取 | 始终为 Widget。 |
Border | Border? | 读写 | 边框宽度、样式和虚线模式从小部件的 BS 字典中解析(表单字段的边框信息存放在那里,而不是在 /Border 中)。 |
Actions | AnnotationActionCollection | 读取 | 小部件的 /AA 树的动作槽。 |
Exportable | bool | 读写 | 是否在表单提交时导出小部件的值。 |
Highlighting | HighlightingMode | 读写 | 当用户点击小部件时使用的视觉高亮模式(/H 条目)。 |
Parent | Forms.Field? | 读取 | 当此小部件是 AcroForm 字段的视觉子项时的父字段。 |
Required | bool | 读写 | 在提交之前小部件是否必须填写(/Ff 位 2)。 |
HighlightMode | string | 读取 | 高亮模式 (/H 条目)。 |
DefaultAppearanceString | string? | 读取 | 默认外观字符串 (/DA 条目)。 |
FieldValue | string? | 读取 | 字段值 (/V 条目)。 |
DefaultFieldValue | string? | 读取 | 默认字段值 (/DV 条目)。 |
FieldType | string? | 读取 | 字段类型 (/FT 条目)。 |
InnerRect | Rectangle? | 读取 | 注释矩形通过 /RD(矩形差异)条目向内缩进——实际在 Rect 内绘制的区域。 |
Width | double | 读写 | 注释矩形的宽度。 |
Height | double | 读写 | 注释矩形的高度。 |
ActiveState | string? | 读写 | 当前活动的外观状态(/AS 条目)。 |
Alignment | TextAlignment | 读写 | 文本对齐(用于携带富文本的自由文本/小部件注释)。 |
HorizontalAlignment | Aspose.Pdf.HorizontalAlignment | 读写 | 水平对齐(除 Alignment 外另行公开;两者可以独立设置)。 |
States | AppearanceDictionary | 读取 | 外观状态字典(AP/N 的每个状态子字典,例如. |
UpdateAppearanceOnConvert | bool | 读写 | 是否在注释保存到已转换文档时重新生成外观流。 |
UseFontSubset | bool | 读写 | 是否应对嵌入的字体(如果有)进行子集化。 |
Contents | string? | 读写 | 注释内容(文本)。 |
Opacity | double | 读写 | 注释不透明度(0.0 = 透明,1.0 = 不透明)。 |
InteriorColor | Color? | 读写 | 注释的内部颜色(/IC 条目,用于圆形/方形/线条注释)。 |
Title | string? | 读写 | 注释标题(标记注释的作者)。 |
Name | string? | 读写 | 注释名称(唯一标识符——/NM 条目)。 |
Subject | string? | 读写 | 注释主题(/Subj 条目)。 |
ModifiedDate | string? | 读取 | 修改日期。 |
Modified | DateTime | 读写 | 作为已键入的 DateTime 的 /M(modified)日期。 |
AnnotationFlags | AnnotationFlags | 读写 | 已键入的 Flags 别名,匹配公开表面并将 AnnotationFlags 作为属性暴露。 |
Action | PdfAction? | 读写 | 与此注释关联的操作(/A 条目)。 |
Author | string? | 读取 | 注释作者(/T 条目)。 |
AnnotationState | string? | 读取 | 注释状态(/State 条目),例如。 |
AnnotationStateModel | string? | 读取 | 标注状态模型(/StateModel 条目),例如: |
ReplyType | string? | 读取 | 回复类型(/RT 条目),例如: |
InReplyTo | Annotation? | 读写 | 此回复所对应的标注(/IRT 条目)。 |
QuadPoints | Point[] | 读写 | QuadPoints 作为 Point 值的数组。 |
Page | Page? | 读取 | 拥有此注释的页面,如果无法解析则为 null(例如. |
VerticalAlignment | VerticalAlignment | 读写 | 此段落的垂直对齐方式。 |
Margin | MarginInfo | 读写 | 外边距信息已应用于此段落。 |
IsFirstParagraphInColumn | bool | 读写 | 强制段落在新列中开始。 |
IsKeptWithNext | bool | 读写 | 保持此段落与下一段位于同一页。 |
IsInNewPage | bool | 读写 | 强制段落在新页开始。 |
IsInLineParagraph | bool | 读写 | 内联段落标记(不另起新行)。 |
HyperlinkText | string? | 读写 | 遗留的字符串类型超链接目标。 |
Hyperlink | Hyperlink? | 读写 | 已对段落应用类型化的超链接装饰。 |
ZIndex | int | 读写 | DOM 渲染器使用的 Z 顺序索引。 |
方法
| 签名 | 描述 |
|---|---|
SignatureField(doc: Document, rect: Rectangle) | 在文档的首页创建一个大小为 rect 的空签名字段。 |
SignatureField(page: Page, rect: Rectangle) | 在页面上创建一个大小为 rect 的空签名字段。 |
Sign(signature: Signature) | 使用提供的签名的嵌入式证书对该字段进行签名。 |
Sign(signature: Signature, pfx: Stream, pass: string) | 使用来自流的 PFX + 密码进行签名 — 相比 Sign(Signature) 更方便。 |
ExtractCertificate() | 提取此字段的 /V 的签名证书为 DER 字节流 (.cer)。 |
ExtractCertificateObject() | 将签名证书提取为 X509Certificate2。 |
ExtractImage() | 提取可见签名外观(/AP /N 流)为 Stream。 |
ExtractImage(format: System.Drawing.Imaging.ImageFormat) | 提取可见签名外观并将其重新编码为 format。 |
Field(doc: Document) | 创建一个绑定到文档的字段。 |
GetEnumerator() | 遍历此字段在 /Kids 数组中的子项的 widget 注释。 |
CopyTo(array: Aspose.Pdf.Annotations.WidgetAnnotation[], index: int) | 将 widget 注释复制到从 index 开始的数组中。 |
CopyTo(array: Field[], index: int) | 将此字段的子项(作为 Field 实例)复制到从 index 开始的数组中。 |
ExecuteFieldJavaScript(javaScriptAction: Aspose.Pdf.Annotations.JavascriptAction) | 对该字段执行提供的 JavaScript 操作。 |
ExportToJson(stream: Stream) | 通过提供的流将此字段序列化为 JSON(单个 FieldExportingData 对象)。 |
ExportToJson(fileName: string) | 将此字段序列化为 JSON 文件。 |
ExportToJson(stream: Stream, options: ExportFieldsToJsonOptions?) | 通过提供的流将此字段序列化为 JSON。 |
ExportToJson(fileName: string, options: ExportFieldsToJsonOptions?) | 将此字段序列化为 JSON 文件。 |
ExportValueToJson(outputJsonStream: Stream, indented: bool) | 将字段的名称、标志和值写入 JSON 流。 |
Flatten() | 将此字段扁平化——把其值转换为静态页面内容。 |
GetWidgetEnumerator() | 枚举器类型为 WidgetAnnotation。 |
ImportValueFromJson(inputJsonStream: Stream) | 从 JSON 流读取此字段的值。 |
ImportValueFromJson(inputJsonStream: Stream, fieldFullNameInJSON: string) | 从 JSON 流读取命名字段的值——单个字段对象(可能通过 ChildFields 嵌套)或它们的数组——并使用点路径匹配 fieldFullNameInJSON 的条目的值。 |
Recalculate() | 根据其计算脚本重新计算字段的值。 |
SetPosition(point: Aspose.Pdf.Point) | 将字段的第一个小部件矩形移动到提供的点(左上角)。 |
WidgetAnnotation(doc: Document) | 程序化 ctor — 创建一个与文档的阅读器关联的裸部件注释。 |
ExportToJson(stream: System.IO.Stream) | 将此部件的字段序列化为 JSON 到流中。 |
ExportToJson(stream: System.IO.Stream, options: ExportFieldsToJsonOptions?) | 将此部件的字段序列化为单个 FieldExportingData JSON 对象到流中。 |
GetCheckedStateName() | 返回表示此部件“on”/“checked”状态的外观状态名称(通常为 “Yes”),该名称从 /AP/N 字典的键中查找(任何不是 “Off” 的键)。 |
Accept(visitor: AnnotationSelector) | 在此 SignatureField 实例上调用 Accept(visitor)。 |
GetRectangle(considerRotation: bool) | 通过 considerRotation 调整的边界矩形。 |
ChangeAfterResize(transform: Matrix) | 在用户调整页面或宿主矩形大小后,调整注释的几何形状。 |
UpdateAppearances() | 从注释当前的几何形状和颜色重新生成普通外观流 (/AP /N)。 |
WriteXfdf(writer: System.Xml.XmlWriter) | 将此注释序列化为 XFDF 元素写入器 (PDF 32000 §12.7.8 / XFDF 3.0)。 |
Clone() | 浅克隆 — 复制标量/引用共享状态。 |