2023-06-21 12:46:23 -04:00

490 lines
20 KiB
C#

using System;
using System.Text;
using System.Collections;
using System.util;
/*
* $Id: PdfAcroForm.cs,v 1.9 2008/05/13 11:25:18 psoares33 Exp $
*
*
* Copyright 2002 Bruno Lowagie
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* http://www.lowagie.com/iText/
*/
namespace iTextSharp.text.pdf {
/**
* Each PDF document can contain maximum 1 AcroForm.
*/
public class PdfAcroForm : PdfDictionary {
private PdfWriter writer;
/** This is a map containing FieldTemplates. */
private Hashtable fieldTemplates = new Hashtable();
/** This is an array containing DocumentFields. */
private PdfArray documentFields = new PdfArray();
/** This is an array containing the calculationorder of the fields. */
private PdfArray calculationOrder = new PdfArray();
/** Contains the signature flags. */
private int sigFlags = 0;
/** Creates new PdfAcroForm */
public PdfAcroForm(PdfWriter writer) : base() {
this.writer = writer;
}
public bool NeedAppearances {
set {
Put(PdfName.NEEDAPPEARANCES, value ? PdfBoolean.PDFTRUE : PdfBoolean.PDFFALSE);
}
}
/**
* Adds fieldTemplates.
*/
public void AddFieldTemplates(Hashtable ft) {
foreach (object key in ft.Keys) {
fieldTemplates[key] = ft[key];
}
}
/**
* Adds documentFields.
*/
public void AddDocumentField(PdfIndirectReference piref) {
documentFields.Add(piref);
}
/**
* Closes the AcroForm.
*/
public bool IsValid() {
if (documentFields.Size == 0) return false;
Put(PdfName.FIELDS, documentFields);
if (sigFlags != 0)
Put(PdfName.SIGFLAGS, new PdfNumber(sigFlags));
if (calculationOrder.Size > 0)
Put(PdfName.CO, calculationOrder);
if (fieldTemplates.Count == 0) return true;
PdfDictionary dic = new PdfDictionary();
foreach (PdfTemplate template in fieldTemplates.Keys) {
PdfFormField.MergeResources(dic, (PdfDictionary)template.Resources);
}
Put(PdfName.DR, dic);
Put(PdfName.DA, new PdfString("/Helv 0 Tf 0 g "));
PdfDictionary fonts = (PdfDictionary)dic.Get(PdfName.FONT);
if (fonts != null) {
writer.EliminateFontSubset(fonts);
}
return true;
}
/**
* Adds an object to the calculationOrder.
*/
public void AddCalculationOrder(PdfFormField formField) {
calculationOrder.Add(formField.IndirectReference);
}
/**
* Sets the signature flags.
*/
public int SigFlags {
set {
sigFlags |= value;
}
}
/**
* Adds a formfield to the AcroForm.
*/
public void AddFormField(PdfFormField formField) {
writer.AddAnnotation(formField);
}
public PdfFormField AddHtmlPostButton(string name, string caption, string value, string url, BaseFont font, float fontSize, float llx, float lly, float urx, float ury) {
PdfAction action = PdfAction.CreateSubmitForm(url, null, PdfAction.SUBMIT_HTML_FORMAT);
PdfFormField button = new PdfFormField(writer, llx, lly, urx, ury, action);
SetButtonParams(button, PdfFormField.FF_PUSHBUTTON, name, value);
DrawButton(button, caption, font, fontSize, llx, lly, urx, ury);
AddFormField(button);
return button;
}
public PdfFormField AddResetButton(string name, string caption, string value, BaseFont font, float fontSize, float llx, float lly, float urx, float ury) {
PdfAction action = PdfAction.CreateResetForm(null, 0);
PdfFormField button = new PdfFormField(writer, llx, lly, urx, ury, action);
SetButtonParams(button, PdfFormField.FF_PUSHBUTTON, name, value);
DrawButton(button, caption, font, fontSize, llx, lly, urx, ury);
AddFormField(button);
return button;
}
public PdfFormField AddMap(string name, string value, string url, PdfContentByte appearance, float llx, float lly, float urx, float ury) {
PdfAction action = PdfAction.CreateSubmitForm(url, null, PdfAction.SUBMIT_HTML_FORMAT | PdfAction.SUBMIT_COORDINATES);
PdfFormField button = new PdfFormField(writer, llx, lly, urx, ury, action);
SetButtonParams(button, PdfFormField.FF_PUSHBUTTON, name, null);
PdfAppearance pa = PdfAppearance.CreateAppearance(writer, urx - llx, ury - lly);
pa.Add(appearance);
button.SetAppearance(PdfAnnotation.APPEARANCE_NORMAL, pa);
AddFormField(button);
return button;
}
public void SetButtonParams(PdfFormField button, int characteristics, string name, string value) {
button.Button = characteristics;
button.Flags = PdfAnnotation.FLAGS_PRINT;
button.SetPage();
button.FieldName = name;
if (value != null) button.ValueAsString = value;
}
public void DrawButton(PdfFormField button, string caption, BaseFont font, float fontSize, float llx, float lly, float urx, float ury) {
PdfAppearance pa = PdfAppearance.CreateAppearance(writer, urx - llx, ury - lly);
pa.DrawButton(0f, 0f, urx - llx, ury - lly, caption, font, fontSize);
button.SetAppearance(PdfAnnotation.APPEARANCE_NORMAL, pa);
}
public PdfFormField AddHiddenField(string name, string value) {
PdfFormField hidden = PdfFormField.CreateEmpty(writer);
hidden.FieldName = name;
hidden.ValueAsName = value;
AddFormField(hidden);
return hidden;
}
public PdfFormField AddSingleLineTextField(string name, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury) {
PdfFormField field = PdfFormField.CreateTextField(writer, PdfFormField.SINGLELINE, PdfFormField.PLAINTEXT, 0);
SetTextFieldParams(field, text, name, llx, lly, urx, ury);
DrawSingleLineOfText(field, text, font, fontSize, llx, lly, urx, ury);
AddFormField(field);
return field;
}
public PdfFormField AddMultiLineTextField(string name, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury) {
PdfFormField field = PdfFormField.CreateTextField(writer, PdfFormField.MULTILINE, PdfFormField.PLAINTEXT, 0);
SetTextFieldParams(field, text, name, llx, lly, urx, ury);
DrawMultiLineOfText(field, text, font, fontSize, llx, lly, urx, ury);
AddFormField(field);
return field;
}
public PdfFormField AddSingleLinePasswordField(string name, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury) {
PdfFormField field = PdfFormField.CreateTextField(writer, PdfFormField.SINGLELINE, PdfFormField.PASSWORD, 0);
SetTextFieldParams(field, text, name, llx, lly, urx, ury);
DrawSingleLineOfText(field, text, font, fontSize, llx, lly, urx, ury);
AddFormField(field);
return field;
}
public void SetTextFieldParams(PdfFormField field, string text, string name, float llx, float lly, float urx, float ury) {
field.SetWidget(new Rectangle(llx, lly, urx, ury), PdfAnnotation.HIGHLIGHT_INVERT);
field.ValueAsString = text;
field.DefaultValueAsString = text;
field.FieldName = name;
field.Flags = PdfAnnotation.FLAGS_PRINT;
field.SetPage();
}
public void DrawSingleLineOfText(PdfFormField field, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury) {
PdfAppearance tp = PdfAppearance.CreateAppearance(writer, urx - llx, ury - lly);
PdfAppearance tp2 = (PdfAppearance)tp.Duplicate;
tp2.SetFontAndSize(font, fontSize);
tp2.ResetRGBColorFill();
field.DefaultAppearanceString = tp2;
tp.DrawTextField(0f, 0f, urx - llx, ury - lly);
tp.BeginVariableText();
tp.SaveState();
tp.Rectangle(3f, 3f, urx - llx - 6f, ury - lly - 6f);
tp.Clip();
tp.NewPath();
tp.BeginText();
tp.SetFontAndSize(font, fontSize);
tp.ResetRGBColorFill();
tp.SetTextMatrix(4, (ury - lly) / 2 - (fontSize * 0.3f));
tp.ShowText(text);
tp.EndText();
tp.RestoreState();
tp.EndVariableText();
field.SetAppearance(PdfAnnotation.APPEARANCE_NORMAL, tp);
}
public void DrawMultiLineOfText(PdfFormField field, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury) {
PdfAppearance tp = PdfAppearance.CreateAppearance(writer, urx - llx, ury - lly);
PdfAppearance tp2 = (PdfAppearance)tp.Duplicate;
tp2.SetFontAndSize(font, fontSize);
tp2.ResetRGBColorFill();
field.DefaultAppearanceString = tp2;
tp.DrawTextField(0f, 0f, urx - llx, ury - lly);
tp.BeginVariableText();
tp.SaveState();
tp.Rectangle(3f, 3f, urx - llx - 6f, ury - lly - 6f);
tp.Clip();
tp.NewPath();
tp.BeginText();
tp.SetFontAndSize(font, fontSize);
tp.ResetRGBColorFill();
tp.SetTextMatrix(4, 5);
System.util.StringTokenizer tokenizer = new System.util.StringTokenizer(text, "\n");
float yPos = ury - lly;
while (tokenizer.HasMoreTokens()) {
yPos -= fontSize * 1.2f;
tp.ShowTextAligned(PdfContentByte.ALIGN_LEFT, tokenizer.NextToken(), 3, yPos, 0);
}
tp.EndText();
tp.RestoreState();
tp.EndVariableText();
field.SetAppearance(PdfAnnotation.APPEARANCE_NORMAL, tp);
}
public PdfFormField AddCheckBox(string name, string value, bool status, float llx, float lly, float urx, float ury) {
PdfFormField field = PdfFormField.CreateCheckBox(writer);
SetCheckBoxParams(field, name, value, status, llx, lly, urx, ury);
DrawCheckBoxAppearences(field, value, llx, lly, urx, ury);
AddFormField(field);
return field;
}
public void SetCheckBoxParams(PdfFormField field, string name, string value, bool status, float llx, float lly, float urx, float ury) {
field.SetWidget(new Rectangle(llx, lly, urx, ury), PdfAnnotation.HIGHLIGHT_TOGGLE);
field.FieldName = name;
if (status) {
field.ValueAsName = value;
field.AppearanceState = value;
}
else {
field.ValueAsName = "Off";
field.AppearanceState = "Off";
}
field.Flags = PdfAnnotation.FLAGS_PRINT;
field.SetPage();
field.BorderStyle = new PdfBorderDictionary(1, PdfBorderDictionary.STYLE_SOLID);
}
public void DrawCheckBoxAppearences(PdfFormField field, string value, float llx, float lly, float urx, float ury) {
BaseFont font = BaseFont.CreateFont(BaseFont.ZAPFDINGBATS, BaseFont.WINANSI, BaseFont.NOT_EMBEDDED);
float size = (ury - lly);
PdfAppearance tpOn = PdfAppearance.CreateAppearance(writer, urx - llx, ury - lly);
PdfAppearance tp2 = (PdfAppearance)tpOn.Duplicate;
tp2.SetFontAndSize(font, size);
tp2.ResetRGBColorFill();
field.DefaultAppearanceString = tp2;
tpOn.DrawTextField(0f, 0f, urx - llx, ury - lly);
tpOn.SaveState();
tpOn.ResetRGBColorFill();
tpOn.BeginText();
tpOn.SetFontAndSize(font, size);
tpOn.ShowTextAligned(PdfContentByte.ALIGN_CENTER, "4", (urx - llx) / 2, (ury - lly) / 2 - (size * 0.3f), 0);
tpOn.EndText();
tpOn.RestoreState();
field.SetAppearance(PdfAnnotation.APPEARANCE_NORMAL, value, tpOn);
PdfAppearance tpOff = PdfAppearance.CreateAppearance(writer, urx - llx, ury - lly);
tpOff.DrawTextField(0f, 0f, urx - llx, ury - lly);
field.SetAppearance(PdfAnnotation.APPEARANCE_NORMAL, "Off", tpOff);
}
public PdfFormField GetRadioGroup(string name, string defaultValue, bool noToggleToOff) {
PdfFormField radio = PdfFormField.CreateRadioButton(writer, noToggleToOff);
radio.FieldName = name;
radio.ValueAsName = defaultValue;
return radio;
}
public void AddRadioGroup(PdfFormField radiogroup) {
AddFormField(radiogroup);
}
public PdfFormField AddRadioButton(PdfFormField radiogroup, string value, float llx, float lly, float urx, float ury) {
PdfFormField radio = PdfFormField.CreateEmpty(writer);
radio.SetWidget(new Rectangle(llx, lly, urx, ury), PdfAnnotation.HIGHLIGHT_TOGGLE);
string name = ((PdfName)radiogroup.Get(PdfName.V)).ToString().Substring(1);
if (name.Equals(value)) {
radio.AppearanceState = value;
}
else {
radio.AppearanceState = "Off";
}
DrawRadioAppearences(radio, value, llx, lly, urx, ury);
radiogroup.AddKid(radio);
return radio;
}
public void DrawRadioAppearences(PdfFormField field, string value, float llx, float lly, float urx, float ury) {
PdfAppearance tpOn = PdfAppearance.CreateAppearance(writer, urx - llx, ury - lly);
tpOn.DrawRadioField(0f, 0f, urx - llx, ury - lly, true);
field.SetAppearance(PdfAnnotation.APPEARANCE_NORMAL, value, tpOn);
PdfAppearance tpOff = PdfAppearance.CreateAppearance(writer, urx - llx, ury - lly);
tpOff.DrawRadioField(0f, 0f, urx - llx, ury - lly, false);
field.SetAppearance(PdfAnnotation.APPEARANCE_NORMAL, "Off", tpOff);
}
public PdfFormField AddSelectList(string name, string[] options, string defaultValue, BaseFont font, float fontSize, float llx, float lly, float urx, float ury) {
PdfFormField choice = PdfFormField.CreateList(writer, options, 0);
SetChoiceParams(choice, name, defaultValue, llx, lly, urx, ury);
StringBuilder text = new StringBuilder();
for (int i = 0; i < options.Length; i++) {
text.Append(options[i]).Append('\n');
}
DrawMultiLineOfText(choice, text.ToString(), font, fontSize, llx, lly, urx, ury);
AddFormField(choice);
return choice;
}
public PdfFormField AddSelectList(string name, string[,] options, string defaultValue, BaseFont font, float fontSize, float llx, float lly, float urx, float ury) {
PdfFormField choice = PdfFormField.CreateList(writer, options, 0);
SetChoiceParams(choice, name, defaultValue, llx, lly, urx, ury);
StringBuilder text = new StringBuilder();
for (int i = 0; i < options.GetLength(0); i++) {
text.Append(options[i, 1]).Append('\n');
}
DrawMultiLineOfText(choice, text.ToString(), font, fontSize, llx, lly, urx, ury);
AddFormField(choice);
return choice;
}
public PdfFormField AddComboBox(string name, string[] options, string defaultValue, bool editable, BaseFont font, float fontSize, float llx, float lly, float urx, float ury) {
PdfFormField choice = PdfFormField.CreateCombo(writer, editable, options, 0);
SetChoiceParams(choice, name, defaultValue, llx, lly, urx, ury);
if (defaultValue == null) {
defaultValue = options[0];
}
DrawSingleLineOfText(choice, defaultValue, font, fontSize, llx, lly, urx, ury);
AddFormField(choice);
return choice;
}
public PdfFormField AddComboBox(string name, string[,] options, string defaultValue, bool editable, BaseFont font, float fontSize, float llx, float lly, float urx, float ury) {
PdfFormField choice = PdfFormField.CreateCombo(writer, editable, options, 0);
SetChoiceParams(choice, name, defaultValue, llx, lly, urx, ury);
string value = null;
for (int i = 0; i < options.GetLength(0); i++) {
if (options[i, 0].Equals(defaultValue)) {
value = options[i, 1];
break;
}
}
if (value == null) {
value = options[0, 1];
}
DrawSingleLineOfText(choice, value, font, fontSize, llx, lly, urx, ury);
AddFormField(choice);
return choice;
}
public void SetChoiceParams(PdfFormField field, string name, string defaultValue, float llx, float lly, float urx, float ury) {
field.SetWidget(new Rectangle(llx, lly, urx, ury), PdfAnnotation.HIGHLIGHT_INVERT);
if (defaultValue != null) {
field.ValueAsString = defaultValue;
field.DefaultValueAsString = defaultValue;
}
field.FieldName = name;
field.Flags = PdfAnnotation.FLAGS_PRINT;
field.SetPage();
field.BorderStyle = new PdfBorderDictionary(2, PdfBorderDictionary.STYLE_SOLID);
}
public PdfFormField AddSignature(String name, float llx, float lly, float urx, float ury) {
PdfFormField signature = PdfFormField.CreateSignature(writer);
SetSignatureParams(signature, name, llx, lly, urx, ury);
DrawSignatureAppearences(signature, llx, lly, urx, ury);
AddFormField(signature);
return signature;
}
/**
* @param field
* @param name
* @param llx
* @param lly
* @param urx
* @param ury
*/
public void SetSignatureParams(PdfFormField field, String name, float llx, float lly, float urx, float ury) {
field.SetWidget(new Rectangle(llx, lly, urx, ury), PdfAnnotation.HIGHLIGHT_INVERT);
field.FieldName = name;
field.Flags = PdfAnnotation.FLAGS_PRINT;
field.SetPage();
field.MKBorderColor = Color.BLACK;
field.MKBackgroundColor = Color.WHITE;
}
/**
* @param field
* @param llx
* @param lly
* @param urx
* @param ury
*/
public void DrawSignatureAppearences(PdfFormField field, float llx, float lly, float urx, float ury) {
PdfAppearance tp = PdfAppearance.CreateAppearance(writer, urx - llx, ury - lly);
tp.SetGrayFill(1.0f);
tp.Rectangle(0, 0, urx - llx, ury - lly);
tp.Fill();
tp.SetGrayStroke(0);
tp.SetLineWidth(1);
tp.Rectangle(0.5f, 0.5f, urx - llx - 0.5f, ury - lly - 0.5f);
tp.ClosePathStroke();
tp.SaveState();
tp.Rectangle(1, 1, urx - llx - 2, ury - lly - 2);
tp.Clip();
tp.NewPath();
tp.RestoreState();
field.SetAppearance(PdfAnnotation.APPEARANCE_NORMAL, tp);
}
}
}