API Reference

Class

PdfFormFieldCreateOptions

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Modifiers sealed

Creates an AcroForm field and its widget or widgets on an existing page.

Inheritance

  • Object
  • PdfFormFieldCreateOptions

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Constructors

Properties

public String Name { get; set; } #

Unique fully qualified field name.

public PdfFormFieldCreationKind Kind { get; set; } #

Field kind.

public Int32 PageNumber { get; set; } #

One-based page number.

public Double X { get; set; } #

Widget left coordinate.

public Double Y { get; set; } #

Widget bottom coordinate.

public Double Width { get; set; } #

Widget width.

public Double Height { get; set; } #

Widget height.

public String Value { get; set; } #

Initial scalar value.

public String DefaultValue { get; set; } #

Optional default value.

public Int32 FieldFlags { get; set; } #

Raw field /Ff flags.

public Int32 WidgetFlags { get; set; } #

Raw widget annotation /F flags. Default enables printing.

public IReadOnlyList<String> ChoiceOptions { get; set; } #

Choice options for choice fields.

public String CheckedValueName { get; set; } #

Export name used for a checked checkbox.

public Boolean IsComboBox { get; set; } #

True to create a combo box; false creates a list box. Applies only to choice fields and defaults to false for compatibility.

public String Caption { get; set; } #

Visible push-button caption. Defaults to Button.

public String JavaScript { get; set; } #

Optional JavaScript source attached to widget activation. Push buttons use /A; other fields use /AA /U.

public Double FontSize { get; set; } #

Font size used for generated text, choice, and push-button appearances.

public Double RadioButtonSize { get; set; } #

Radio widget size in points. Applies only to radio-button groups.

public Double RadioButtonGap { get; set; } #

Vertical gap between radio widgets in points.

public PdfFormFieldStyle Style { get; set; } #

Visual and semantic field style used by generated widget appearances.