Namespace: PdfSharp.Pdf.AcroForms
Represents the base class for all choice field dictionaries.
public abstract class PdfChoiceField : PdfAcroField, System.ICloneable, System.Collections.Generic.IEnumerable`1[[System.Collections.Generic.KeyValuePair`2[[System.String, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[PdfSharp.Pdf.PdfItem, PdfSharp, Version=0.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.IEnumerable
Inheritance Object → PdfItem → PdfObject → PdfDictionary → PdfAcroField → PdfChoiceField
Implements ICloneable, IEnumerable<KeyValuePair<String, PdfItem>>, IEnumerable
Gets or sets the Value for the Field. For fields supporting multiple values (e.g. ListBox) use PdfListBoxField.SelectedIndices instead
public PdfItem Value { get; set; }
Gets or sets the Default value for the field
public PdfItem DefaultValue { get; set; }
Gets or sets the List of options (entries) available for selection. This is the list of values shown in the UI.
public ICollection<string> Options { get; set; }
Gets the list of values for this Field.
May or may not be equal to PdfChoiceField.Options but has always the same amount of items.
public ICollection<string> Values { get; }
Gets the name of this field.
public string Name { get; set; }
Gets the alternative Name of the Field (/TU)
public string AlternateName { get; set; }
Gets the mapping Name of the Field (/TM)
public string MappingName { get; set; }
Gets the fully qualified name of this field, that is: “parent-name.field-name”
If the field has no parent, this is equal to PdfAcroField.Name
public string FullyQualifiedName { get; }
Gets the Parent of this field or null, if the field has no parent
public PdfAcroField Parent { get; internal set; }
Gets the field flags of this instance.
public PdfAcroFieldFlags Flags { get; }
Gets or sets the font used to draw the text of the field.
public XFont Font { get; set; }
Gets the font size that was obtained by analyzing the Fields’ content-stream.
public double DeterminedFontSize { get; internal set; }
Gets or sets the foreground color of the field.
public XColor ForeColor { get; set; }
Gets or sets the alignment for the text of this field.
public TextAlignment TextAlign { get; set; }
Gets or sets a value indicating whether the field is read only.
public bool ReadOnly { get; set; }
public PdfAcroField Item { get; }
Indicates whether the field has child fields and/or annotations.
public bool HasKids { get; }
Indicates whether the field has child fields.
public bool HasChildFields { get; }
Use GetDescendantNames
Gets the names of all descendants of this field.
public String[] DescendantNames { get; }
Gets the collection of fields within this field.
public PdfAcroFieldCollection Fields { get; }
Gets the annotations for this field. The elements in this list are of type PdfWidgetAnnotation.
public PdfAnnotationArray Annotations { get; }
Gets the dictionary containing the elements of this dictionary.
public DictionaryElements Elements { get; }
Gets or sets the PDF stream belonging to this dictionary. Returns null if the dictionary has no stream. To create the stream, call the CreateStream function.
public PdfStream Stream { get; set; }
Gets the PdfDocument this object belongs to.
public PdfDocument Owner { get; }
Indicates whether the object is an indirect object.
public bool IsIndirect { get; }
Gets the PdfInternals object of this document, that grants access to some internal structures which are not part of the public interface of PdfDocument.
public PdfObjectInternals Internals { get; }
Gets the indirect reference of this object. If the value is null, this object is a direct object.
public PdfReference Reference { get; internal set; }
Gets the indirect reference of this object. Throws if it is null.
public PdfReference ReferenceNotNull { get; }
InvalidOperationException
The indirect reference must be not null here.
Gets the index of the specified string in the /Opt array or -1, if no such string exists.
protected int IndexInOptArray(string value, bool useExportValue)
value
String
Value, for which the index should be retrieved
useExportValue
Boolean
true if value is the export value, false if value is the text shown in the UI
Gets the value or the display text from the index in the /Opt array.
internal string ValueInOptArray(int index, bool useExportValue)
index
Int32
Index of the value that should be retrieved
useExportValue
Boolean
true to get the export value, false to get the text shown in the UI