Meziantou.FrameworkPdfFormFieldOptions Class
The attributes of a field created by PdfInteractiveForm and of its widgets: PdfInteractiveForm.AddSignatureField uses them as they are; the other fields derive from it.
public class PdfFormFieldOptionsConstructors
| Name | Description |
|---|---|
| PdfFormFieldOptions() |
PdfFormFieldOptions()
PdfFormFieldOptions.cspublic PdfFormFieldOptions()No documentation is available.
Properties
| Name | Description |
|---|---|
| AlternateName | Gets or sets the alternate name of the field (/TU): the text the user interface shows, and assistive technologies read. |
| BackgroundColor | Gets or sets the color of the background, or null for a transparent background, the default. |
| BorderColor | Gets or sets the color of the border, or null for no border. The default is black. |
| BorderWidth | Gets or sets the width of the border. The default is 1. |
| Font | Gets or sets the font of the text, or null for Helvetica. It is added to the default resources of the form (PdfInteractiveForm.AddFont). Check boxes and radio buttons ignore it: they draw their symbols as paths, and their default appearance names ZapfDingbats. |
| FontSize | Gets or sets the font size; 0 fits the text in the widget. The default is 12, and 0 for check boxes and radio buttons. |
| IsReadOnly | Gets or sets a value indicating whether the user cannot change the value of the field. |
| IsRequired | Gets or sets a value indicating whether the field must have a value when the form is submitted. |
| SubsetFont | Gets or sets a value indicating whether an embedded PdfFormFieldOptions.Font keeps only the glyphs the document shows, even when the field is not read-only. The file is smaller, but viewers may not show the characters typed in the field that are not in the subset. |
| TextColor | Gets or sets the color of the text and of the symbol of check boxes and radio buttons, or null for black. |
AlternateName
PdfFormFieldOptions.csBackgroundColor
PdfFormFieldOptions.csBorderColor
PdfFormFieldOptions.csBorderWidth
PdfFormFieldOptions.csGets or sets the font of the text, or null for Helvetica. It is added to the default resources of the form (PdfInteractiveForm.AddFont). Check boxes and radio buttons ignore it: they draw their symbols as paths, and their default appearance names ZapfDingbats.
public PdfFont? Font { get; set; }Property value
Remarks
An embedded font is embedded whole when the field is not read-only, so that viewers can show the text typed in the field, unless PdfFormFieldOptions.SubsetFont is set.
FontSize
PdfFormFieldOptions.csIsReadOnly
PdfFormFieldOptions.csIsRequired
PdfFormFieldOptions.csSubsetFont
PdfFormFieldOptions.csGets or sets a value indicating whether an embedded PdfFormFieldOptions.Font keeps only the glyphs the document shows, even when the field is not read-only. The file is smaller, but viewers may not show the characters typed in the field that are not in the subset.
public bool SubsetFont { get; set; }