Test

PrintPDF/PdfSharp/Pdf.AcroForms/enums/PdfAcroFieldFlags.cs

@@ -0,0 +1,151 @@
+#region PDFsharp - A .NET library for processing PDF
+//
+// Authors:
+//   Stefan Lange
+//
+// Copyright (c) 2005-2017 empira Software GmbH, Cologne Area (Germany)
+//
+// http://www.pdfsharp.com
+// http://sourceforge.net/projects/pdfsharp
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the "Software"),
+// to deal in the Software without restriction, including without limitation
+// the rights to use, copy, modify, merge, publish, distribute, sublicense,
+// and/or sell copies of the Software, and to permit persons to whom the
+// Software is furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
+// DEALINGS IN THE SOFTWARE.
+#endregion
+
+using System;
+
+namespace PdfSharp.Pdf.AcroForms
+{
+    /// <summary>
+    /// Specifies the flags of AcroForm fields.
+    /// </summary>
+    [Flags]
+    public enum PdfAcroFieldFlags
+    {
+        // ----- Common to all fields -----------------------------------------------------------------
+
+        /// <summary>
+        /// If set, the user may not change the value of the field. Any associated widget
+        /// annotations will not interact with the user; that is, they will not respond to 
+        /// mouse clicks or change their appearance in response to mouse motions. This
+        /// flag is useful for fields whose values are computed or imported from a database.
+        /// </summary>
+        ReadOnly = 1 << (1 - 1),
+
+        /// <summary>
+        /// If set, the field must have a value at the time it is exported by a submit-form action.
+        /// </summary>
+        Required = 1 << (2 - 1),
+
+        /// <summary>
+        /// If set, the field must not be exported by a submit-form action.
+        /// </summary>
+        NoExport = 1 << (3 - 1),
+
+        // ----- Specific to button fields ------------------------------------------------------------
+
+        /// <summary>
+        /// If set, the field is a pushbutton that does not retain a permanent value.
+        /// </summary>
+        Pushbutton = 1 << (17 - 1),
+
+        /// <summary>
+        /// If set, the field is a set of radio buttons; if clear, the field is a checkbox.
+        /// This flag is meaningful only if the Pushbutton flag is clear.
+        /// </summary>
+        Radio = 1 << (16 - 1),
+
+        /// <summary>
+        /// (Radio buttons only) If set, exactly one radio button must be selected at all times;
+        /// clicking the currently selected button has no effect. If clear, clicking
+        /// the selected button deselects it, leaving no button selected.
+        /// </summary>
+        NoToggleToOff = 1 << (15 - 1),
+
+        // ----- Specific to text fields --------------------------------------------------------------
+
+        /// <summary>
+        /// If set, the field may contain multiple lines of text; if clear, the field<6C>s text
+        /// is restricted to a single line.
+        /// </summary>
+        Multiline = 1 << (13 - 1),
+
+        /// <summary>
+        /// If set, the field is intended for entering a secure password that should
+        /// not be echoed visibly to the screen. Characters typed from the keyboard
+        /// should instead be echoed in some unreadable form, such as
+        /// asterisks or bullet characters.
+        /// To protect password confidentiality, viewer applications should never
+        /// store the value of the text field in the PDF file if this flag is set.
+        /// </summary>
+        Password = 1 << (14 - 1),
+
+        /// <summary>
+        /// (PDF 1.4) If set, the text entered in the field represents the pathname of
+        /// a file whose contents are to be submitted as the value of the field.
+        /// </summary>
+        FileSelect = 1 << (21 - 1),
+
+        /// <summary>
+        /// (PDF 1.4) If set, the text entered in the field will not be spell-checked.
+        /// </summary>
+        DoNotSpellCheckTextField = 1 << (23 - 1),
+
+        /// <summary>
+        /// (PDF 1.4) If set, the field will not scroll (horizontally for single-line
+        /// fields, vertically for multiple-line fields) to accommodate more text
+        /// than will fit within its annotation rectangle. Once the field is full, no
+        /// further text will be accepted.
+        /// </summary>
+        DoNotScroll = 1 << (24 - 1),
+
+        // ----- Specific to choice fields ------------------------------------------------------------
+
+        /// <summary>
+        /// If set, the field is a combo box; if clear, the field is a list box.
+        /// </summary>
+        Combo = 1 << (18 - 1),
+
+        /// <summary>
+        /// If set, the combo box includes an editable text box as well as a drop list;
+        /// if clear, it includes only a drop list. This flag is meaningful only if the
+        /// Combo flag is set.
+        /// </summary>
+        Edit = 1 << (19 - 1),
+
+        /// <summary>
+        /// If set, the field<6C>s option items should be sorted alphabetically. This flag is
+        /// intended for use by form authoring tools, not by PDF viewer applications;
+        /// viewers should simply display the options in the order in which they occur 
+        /// in the Opt array.
+        /// </summary>
+        Sort = 1 << (20 - 1),
+
+        /// <summary>
+        /// (PDF 1.4) If set, more than one of the field<6C>s option items may be selected
+        /// simultaneously; if clear, no more than one item at a time may be selected.
+        /// </summary>
+        MultiSelect = 1 << (22 - 1),
+
+        /// <summary>
+        /// (PDF 1.4) If set, the text entered in the field will not be spell-checked.
+        /// This flag is meaningful only if the Combo and Edit flags are both set.
+        /// </summary>
+        DoNotSpellCheckChoiseField = 1 << (23 - 1),
+    }
+}