CheckboxField

概述

CheckboxField 是 Aspose.PDF FOSS 中用于 .NET 的一个类。继承自：Field。

此类提供 33 个方法，用于在 .NET 程序中处理 CheckboxField 对象。可用的方法包括：Accept、AddOption、ChangeAfterResize、CheckboxField、Clone、CopyTo、ExecuteFieldJavaScript、ExportToJson、ExportValueToJson、Field、Flatten、GetCheckedStateName，以及另外 9 个方法。安装 Aspose.PDF FOSS for .NET 包后，所有公共成员对任何 .NET 应用程序均可访问。属性：Action、Actions、ActiveState、Alignment、AllowedStates、AlternateName，以及另外 78 项。

属性

名称	类型	访问	描述
`Style`	`BoxStyle`	读写	渲染的复选框图标的视觉样式 (/MK /CA)：Cross 绘制 X，Check 绘制对勾；其他样式回退为 X。
`ExportValue`	`string`	读写	在表单提交时发出到 FDF/XFDF 的导出值。
`ActiveState`	`string`	读写	当前选定的外观状态。
`AllowedStates`	`System.Collections.Generic.List<string>`	读取	在 /AP/N 下声明的所有外观状态键。
`Value`	`string`	读写	复选框值（/V 条目，名称类型）。
`OnValue`	`string`	读取	获取此复选框的 “On” 状态名称（不是 “Off” 的外观状态键）。
`IsChecked`	`bool`	读写	获取或设置是否已选中。
`Checked`	`bool`	读写	获取或设置已选中状态。
`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 条目）。
`Count`	`int`	读取	此字段的 /Kids 数组中的子项数量 — 可以是子字段（层次节点）或小部件注释（具有多个可视小部件的终端字段，例如分组的复选框/单选按钮）。
`Fields`	`Field[]`	读取	该字段的字段类型子项，以快照数组形式呈现 — 便捷访问器，镜像表单上的 Fields。
`DefaultValue`	`string?`	读取	默认值（/DV）。
`AlternateName`	`string?`	读写	备用字段名称 / 提示信息（/TU 条目）。
`Flags`	`Aspose.Pdf.Annotations.AnnotationFlags`	读写	小部件注释标志（/F 条目），例如。
`TabOrder`	`int`	读写	此字段的制表顺序索引。
`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`	读写	在该页面的 /Annots 数组中，此字段小部件的基于 1 的标签位置——数组顺序即为页面的标签顺序。
`FitIntoRectangle`	`bool`	读写	全局标志：当为 true 时，字段的值会自动调整大小以适应其部件矩形。
`IsGroup`	`bool`	读取	此字段是否为子字段的容器/组。
`IsSharedField`	`bool`	读写	此字段是否属于共享字段组。
`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 bit 2)。
`HighlightMode`	`string`	读取	高亮模式 (/H entry)。
`DefaultAppearanceString`	`string?`	读取	默认外观字符串 (/DA entry)。
`FieldValue`	`string?`	读取	字段值（/V entry）。
`DefaultFieldValue`	`string?`	读取	默认字段值（/DV entry）。
`FieldType`	`string?`	读取	字段类型（/FT entry）。
`InnerRect`	`Rectangle?`	读取	注释矩形通过 /RD（矩形差异）条目向内缩进——实际在 Rect 内绘制的区域。
`Width`	`double`	读写	注释矩形的宽度。
`Height`	`double`	读写	注释矩形的高度。
`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`	读写	/M（已修改）日期，以键入的 DateTime 形式。
`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 顺序索引。

方法

签名	描述
`CheckboxField()`	默认构造一个未绑定的复选框字段。
`CheckboxField(doc: Document)`	构造一个绑定到 doc 的复选框。
`CheckboxField(doc: Document, rect: Rectangle)`	使用给定的部件矩形构造一个绑定到 doc 的复选框。
`CheckboxField(page: Page, rect: Rectangle)`	在页面的给定矩形处构造一个复选框。
`AddOption(optionName: string)`	将 optionName 追加为此复选框的一个新可选状态（用于表现为单选按钮的分组复选框）。
`AddOption(optionName: string, rect: Rectangle)`	追加一个带有显式部件矩形的选项。
`AddOption(optionName: string, page: int, rect: Rectangle)`	追加一个针对给定页码及部件矩形的选项。
`Clone()`	对字段进行浅克隆。
`Field(doc: Document)`	创建一个绑定到文档的字段。
`GetEnumerator()`	遍历此字段在 /Kids 数组中的子字段的部件注释。
`CopyTo(array: Aspose.Pdf.Annotations.WidgetAnnotation[], index: int)`	将部件注释复制到从指定索引开始的数组中。
`CopyTo(array: Field[], index: int)`	将此字段的子字段（作为 Field 实例）复制到从指定索引开始的数组中。
`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)`	对该 CheckboxField 实例调用 Accept(visitor)。
`GetRectangle(considerRotation: bool)`	通过 considerRotation 调整了边界矩形。
`ChangeAfterResize(transform: Matrix)`	在用户调整页面或宿主矩形大小后，调整注释的几何形状。
`UpdateAppearances()`	根据注释当前的几何形状和颜色重新生成普通外观流 (/AP /N)。
`WriteXfdf(writer: System.Xml.XmlWriter)`	将此注释序列化为 XFDF 元素写入 writer（PDF 32000 §12.7.8 / XFDF 3.0）。

另请参阅

Aspose.PDF for .NET — Enterprise API Reference