ComboBoxField

概述

ComboBoxField 是 Aspose.PDF FOSS 中用于 .NET 的类。继承自：ChoiceField。

组合框（下拉）表单字段 — 一个已设置 Combo 标志的 ChoiceField。

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

属性

名称	类型	访问	描述
`Editable`	`bool`	读写	用户是否可以输入自由格式的值（/Ff 位 19，Edit）。
`SpellCheck`	`bool`	读写	是否启用拼写检查（/Ff 位 23，DoNotSpellCheck 取反）。
`IsCombo`	`bool`	读取	获取 is combo。
`IsEditable`	`bool`	读取	获取是否可编辑。
`IsMultiSelect`	`bool`	读取	获取是否为多选。
`IsSorted`	`bool`	读取	获取是否已排序。
`MultiSelect`	`bool`	读写	获取/设置 MultiSelect（/Ff 位 22 — 基于 0 的 21）。
`CommitImmediately`	`bool`	读写	获取/设置 CommitOnSelChange（/Ff 位 27 — 基于 0 的 26）。
`SelectedItems`	`int[]`	读写	基于 0 的已选择选项索引（public-API 形状 int[]，SelectedIndices 的 sibling；setter 从匹配的选项重写 /V）。
`SelectedValues`	`IReadOnlyList<string>`	读写	当前选定的值。
`SelectedIndices`	`IReadOnlyList<int>`	读取	在 Options 列表中已选择值的基于 0 的索引。
`Options`	`OptionCollection`	读取	选择选项的集合。
`Selected`	`int`	读写	当前选中选项的 1 基索引；如果未选中任何选项或无法在选项列表中匹配，则为 -1。
`Value`	`string?`	读写	字段值 (/V)。
`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 entry)。
`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`	读写	基于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 bit 2)。
`HighlightMode`	`string`	读取	高亮模式 (/H entry)。
`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`	读写	将 /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-order 索引。

方法

签名	描述
`ComboBoxField()`	无参数构造函数（调用方稍后绑定到页面）。
`ComboBoxField(doc: Document)`	绑定到文档的构造函数；矩形默认为空。
`ComboBoxField(doc: Document, rect: Rectangle)`	带有显式矩形的文档绑定构造函数。
`ComboBoxField(page: Page, rect: Rectangle)`	在指定页面上使用给定的矩形创建一个新的组合框字段。
`ChoiceField(doc: Document)`	在此 ComboBoxField 实例上调用 ChoiceField(doc)。
`ChoiceField(doc: Document, rect: Rectangle)`	在此 ComboBoxField 实例上调用 ChoiceField(doc, rect)。
`ChoiceField(page: Page, rect: Rectangle)`	在此 ComboBoxField 实例上调用 ChoiceField(page, rect)。
`AddOption(optionName: string)`	向选择字段添加一个选项。
`AddOption(export: string, name: string)`	添加一个选项，并分别设置导出值和显示值。
`DeleteOption(optionName: string)`	删除第一个匹配 optionName 的选项（可以是裸的 PdfString，也可以是 [export, name] 对中的显示部分）。
`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)`	Programmatic ctor — 创建一个与文档读取器关联的裸小部件注释。
`ExportToJson(stream: System.IO.Stream)`	将此小部件的字段序列化为 JSON 并写入流。
`ExportToJson(stream: System.IO.Stream, options: ExportFieldsToJsonOptions?)`	将此 widget 的字段序列化为单个 FieldExportingData JSON 对象到流中。
`GetCheckedStateName()`	返回表示此 widget 的 “on” / “checked” 状态（通常为 “Yes”）的外观状态名称，该名称从 /AP/N dict 的键中查找（任何不是 “Off” 的键）。
`Accept(visitor: AnnotationSelector)`	对该 ComboBoxField 实例调用 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()`	浅克隆 — 复制标量/引用共享状态。

另请参阅

Aspose.PDF for .NET — Enterprise API Reference