RadioButtonField

概述

RadioButtonField 是 Aspose.PDF FOSS 为 .NET 提供的一个类。继承自：ChoiceField。

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

属性

名称	类型	访问	描述
`NoToggleToOff`	`bool`	读写	/Ff bit 15 (NoToggleToOff): 当为真时，用户无法通过再次点击来取消已选的单选按钮。
`Style`	`BoxStyle`	读写	单选按钮图标的视觉样式 (/MK /CA)。
`Shape`	`BoxShape`	读写	单选按钮部件的外边框形状。
`PageIndex`	`int`	读取	字段的第一个部件的基于1的页面索引。
`Options`	`OptionCollection`	读取	单选按钮选项集合。
`IsRadio`	`bool`	读取	是否为单选按钮（对 RadioButtonField 始终为 true）。
`IsPushbutton`	`bool`	读取	是否为推按钮（对 RadioButtonField 始终为 false）。
`SelectedValue`	`string?`	读取	当前选中的值，如果未选中则为 null。
`Selected`	`int`	读写	获取或设置在 kid 小部件 /AP/N 外观状态中所选单选按钮选项的 1 基索引（不包括通用的 “Off” 状态）。
`Value`	`string?`	读写	覆盖 Value。
`IsCombo`	`bool`	读取	获取 is combo。
`IsEditable`	`bool`	读取	获取是否可编辑。
`IsMultiSelect`	`bool`	读取	获取是否为多选。
`IsSorted`	`bool`	读取	获取是否已排序。
`MultiSelect`	`bool`	读写	获取/设置 MultiSelect (/Ff 第22位 — 基于0的第21位)。
`CommitImmediately`	`bool`	读写	获取/设置 CommitOnSelChange (/Ff bit 27 — 0-based 26).
`SelectedItems`	`int[]`	读写	基于0的已选选项索引（public-API 形状 int[] SelectedIndices 的兄弟；setter 从匹配的选项重写 /V）。
`SelectedValues`	`IReadOnlyList<string>`	读写	当前选定的值。
`SelectedIndices`	`IReadOnlyList<int>`	读取	Options 列表中所选值的基于 0 的索引。
`Type`	`FieldType`	读取	字段类型。
`FullName`	`string?`	读取	完全限定的字段名称。
`TextHorizontalAlignment`	`Aspose.Pdf.HorizontalAlignment`	读写	对字段小部件外观应用的文本特定水平对齐覆盖。
`PartialName`	`string?`	读写	部分字段名称 (/T)。
`NormalAppearance`	`XForm?`	读取	字段的“Normal”外观（/AP /N 条目）。
`Appearance`	`Aspose.Pdf.Annotations.AppearanceDictionary`	读取	字段小部件的外观流（/AP 条目），以外观名称为键。
`OnActivated`	`Annotations.PdfAction?`	读写	当此字段被激活时触发的操作（/A 条目）。
`Count`	`int`	读取	此字段的 /Kids 数组中子项的数量 — 可以是子字段（层次节点）或小部件注释（具有多个可视小部件的终端字段，例如分组的复选框/单选框）。
`Fields`	`Field[]`	读取	此字段的字段类型子项（kids）以快照数组形式呈现 — 便利的访问器，镜像表单上的 Fields。
`DefaultValue`	`string?`	读取	默认值 (/DV)。
`AlternateName`	`string?`	读写	备用字段名称 / 工具提示 (/TU 条目)。
`Flags`	`Aspose.Pdf.Annotations.AnnotationFlags`	读写	小部件注释标志 (/F 条目)，例如.
`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`	读写	此字段小部件在其页面的 /Annots 数组中的基于 1 的标签位置——数组顺序即为页面的标签顺序。
`FitIntoRectangle`	`bool`	读写	全局标志：当为真时，字段的值会自动调整大小以适应其小部件矩形。
`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 位 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`	读写	将 /M（modified）日期作为已键入的 DateTime。
`AnnotationFlags`	`AnnotationFlags`	读写	匹配公开表面、将 AnnotationFlags 公开为属性的 Flags 的已键入别名。
`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 索引。

方法

签名	描述
`RadioButtonField(page: Page)`	创建一个新的 radio-button 字段，绑定到提供的页面的 reader。
`RadioButtonField(page: Page, rect: Rectangle)`	使用字段级的 /Rect 设置进行构造。
`RadioButtonField(doc: Document)`	在此 RadioButtonField 实例上调用 RadioButtonField(doc)。
`AddOption(optionName: string, rect: Rectangle)`	在提供的矩形区域添加一个具有给定外观状态名称的选项。
`AddOption(optionName: string)`	仅通过名称添加单选项；它会遮蔽继承的 ChoiceField 版本，从而在此类型上通过反射呈现。
`Add(option: RadioButtonOptionField)`	将已配置的 RadioButtonOptionField 添加为此单选组的子部件。
`SetPosition(point: Aspose.Pdf.Point)`	将字段的部件矩形移动到 point，保持当前的宽度/高度。
`ChoiceField(doc: Document)`	在此 RadioButtonField 实例上调用 ChoiceField(doc)。
`ChoiceField(doc: Document, rect: Rectangle)`	构造一个绑定到 . 的复选框。
`ChoiceField(page: Page, rect: Rectangle)`	在此 RadioButtonField 实例上调用 ChoiceField(page, rect)。
`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 注释复制到从索引开始的数组中。
`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()`	从其计算脚本重新计算字段的值。
`WidgetAnnotation(doc: Document)`	编程构造函数 — 创建一个与文档读取器关联的裸部件注释。
`ExportToJson(stream: System.IO.Stream)`	将此部件的字段序列化为 JSON 到流。
`ExportToJson(stream: System.IO.Stream, options: ExportFieldsToJsonOptions?)`	将此部件的字段序列化为单个 FieldExportingData JSON 对象到流。
`GetCheckedStateName()`	返回表示此小部件的 “on” / “checked” 状态（通常为 “Yes”）的外观状态名称，从 /AP/N dict 的键中查找（任何不是 “Off” 的键）。
`Accept(visitor: AnnotationSelector)`	对该 RadioButtonField 实例调用 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）。
`Clone()`	浅克隆 — 复制标量/引用共享状态。

另请参阅

Aspose.PDF for .NET — Enterprise API Reference