API Reference

Class

PdfFormFieldStyle

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf

Visual style for generated simple AcroForm fields.

Inheritance

  • Object
  • PdfFormFieldStyle

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

Methods

public PdfFormFieldStyle Clone() #
Returns: PdfFormFieldStyle

Creates a copy of this form field style.

Properties

public Nullable<PdfColor> BackgroundColor { get; set; } #

Background fill color. Set to null for transparent field appearance streams.

public Nullable<PdfColor> BorderColor { get; set; } #

Border stroke color. Set to null for no border stroke.

public PdfColor TextColor { get; set; } #

Text color for generated text and choice field appearance streams.

public PdfColor MarkColor { get; set; } #

Check mark or radio dot color for generated button field appearance streams.

public Boolean IsReadOnly { get; set; } #

When true, generated AcroForm fields emit the common read-only field flag.

public Boolean IsRequired { get; set; } #

When true, generated AcroForm fields emit the common required field flag.

public Boolean IsNoExport { get; set; } #

When true, generated AcroForm fields emit the common no-export field flag.

public Boolean IsMultiline { get; set; } #

When true, generated text fields emit the multiline field flag.

public Boolean IsPassword { get; set; } #

When true, generated text fields emit the password field flag.

public Boolean IsFileSelect { get; set; } #

When true, generated text fields emit the file-select field flag.

public Boolean DoesNotSpellCheck { get; set; } #

When true, generated text and choice fields emit the do-not-spell-check field flag.

public Boolean DoesNotScroll { get; set; } #

When true, generated text fields emit the do-not-scroll field flag.

public Boolean IsComb { get; set; } #

When true, generated text fields emit the comb field flag. Requires MaxLength.

public Boolean IsEditableChoice { get; set; } #

When true, generated combo choice fields emit the editable-choice field flag.

public Boolean IsSortedChoice { get; set; } #

When true, generated choice fields emit the sort field flag.

public Boolean CommitsOnSelectionChange { get; set; } #

When true, generated choice fields emit the commit-on-selection-change field flag.

public Nullable<Int32> MaxLength { get; set; } #

Optional maximum text length emitted as /MaxLen for generated text fields.

public Nullable<PdfFormFieldTextAlignment> TextAlignment { get; set; } #

Optional text alignment for generated text and choice fields. When null, document-level AcroForm defaults can apply.

public Double BorderWidth { get; set; } #

Border stroke width in points. Set to 0 to suppress border drawing.

public PdfFormFieldBorderStyle BorderStyle { get; set; } #

Border rendering style for generated field dictionaries and appearance streams.

public IReadOnlyList<Double> BorderDashPattern { get; set; } #

Optional border dash pattern emitted into generated appearance streams. Null or empty output means a solid border.

public String AlternateName { get; set; } #

Alternate field name emitted as AcroForm /TU metadata for accessibility-oriented field descriptions.

public String MappingName { get; set; } #

Mapping name emitted as AcroForm /TM metadata for export and assistive-processing workflows.