PdfSharp.Pdf.AcroForms.PdfTextField Class Reference
Represents the text field. More...
Inheritance diagram for PdfSharp.Pdf.AcroForms.PdfTextField:
Classes | |
| class | Keys |
| Predefined keys of this dictionary. The description comes from PDF 1.4 Reference. More... | |
Properties | |
| string | Text [get, set] |
| Gets or sets the text value of the text field. More... | |
| XFont | Font [get, set] |
| Gets or sets the font used to draw the text of the field. More... | |
| XColor | ForeColor [get, set] |
| Gets or sets the foreground color of the field. More... | |
| XColor | BackColor [get, set] |
| Gets or sets the background color of the field. More... | |
| int | MaxLength [get, set] |
| Gets or sets the maximum length of the field. More... | |
| bool | MultiLine [get, set] |
| Gets or sets a value indicating whether the field has multiple lines. More... | |
| bool | Password [get, set] |
| Gets or sets a value indicating whether this field is used for passwords. More... | |
 Properties inherited from PdfSharp.Pdf.AcroForms.PdfAcroField | |
| string | Name [get] |
| Gets the name of this field. More... | |
| PdfAcroFieldFlags | Flags [get] |
| Gets the field flags of this instance. More... | |
| PdfItem | Value [get, set] |
| Gets or sets the value of the field. More... | |
| bool | ReadOnly [get, set] |
| Gets or sets a value indicating whether the field is read only. More... | |
| PdfAcroField | this[string name] [get] |
| Gets the field with the specified name. More... | |
| bool | HasKids [get] |
| Indicates whether the field has child fields. More... | |
| string[] | DescendantNames [get] |
| Gets the names of all descendants of this field. More... | |
| PdfAcroField.PdfAcroFieldCollection | Fields [get] |
| Gets the collection of fields within this field. More... | |
| Properties inherited from PdfSharp.Pdf.PdfDictionary | |
| DictionaryElements | Elements [get] |
| Gets the hashtable containing the elements of this dictionary. More... | |
| PdfStream | Stream [get, set] |
| 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. More... | |
| Properties inherited from PdfSharp.Pdf.PdfObject | |
| virtual PdfDocument | Owner [get] |
| Gets the PdfDocument this object belongs to. More... | |
| bool | IsIndirect [get] |
| Indicates whether the object is an indirect object. More... | |
| PdfObjectInternals | Internals [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. More... | |
| PdfReference | Reference [get, set] |
| Gets the indirect reference of this object. If the value is null, this object is a direct object. More... | |
Additional Inherited Members | |
| Public Member Functions inherited from PdfSharp.Pdf.PdfDictionary | |
| PdfDictionary () | |
| Initializes a new instance of the PdfDictionary class. More... | |
| PdfDictionary (PdfDocument document) | |
| Initializes a new instance of the PdfDictionary class. More... | |
| new PdfDictionary | Clone () |
| Creates a copy of this dictionary. Direct values are deep copied. Indirect references are not modified. More... | |
| IEnumerator | GetEnumerator () |
| Returns an enumerator that iterates through a collection. More... | |
| override string | ToString () |
| Returns a string with the content of this object in a readable form. Useful for debugging purposes only. More... | |
| PdfStream | CreateStream (byte[] value) |
| Creates the stream of this dictionary and initializes it with the specified byte array. The function must not be called if the dictionary already has a stream. More... | |
| Public Member Functions inherited from PdfSharp.Pdf.PdfObject | |
| new PdfObject | Clone () |
| Creates a copy of this object. The clone does not belong to a document, i.e. its owner and its iref are null. More... | |
| Public Member Functions inherited from PdfSharp.Pdf.PdfItem | |
| PdfItem | Clone () |
| Creates a copy of this object. More... | |
| Protected Member Functions inherited from PdfSharp.Pdf.AcroForms.PdfAcroField | |
| PdfAcroField (PdfDictionary dict) | |
| Initializes a new instance of the PdfAcroField class. Used for type transformation. More... | |
| virtual PdfAcroField | GetValue (string name) |
| Gets a child field by name. More... | |
| Protected Member Functions inherited from PdfSharp.Pdf.PdfDictionary | |
| PdfDictionary (PdfDictionary dict) | |
| Initializes a new instance from an existing dictionary. Used for object type transformation. More... | |
| override object | Copy () |
| This function is useful for importing objects from external documents. The returned object is not yet complete. irefs refer to external objects and directed objects are cloned but their document property is null. A cloned dictionary or array needs a 'fix-up' to be a valid object. More... | |
| Protected Member Functions inherited from PdfSharp.Pdf.PdfObject | |
| PdfObject () | |
| Initializes a new instance of the PdfObject class. More... | |
| PdfObject (PdfDocument document) | |
| Initializes a new instance of the PdfObject class. More... | |
| PdfObject (PdfObject obj) | |
| Initializes a new instance from an existing object. Used for object type transformation. More... | |
| override object | Copy () |
| Implements the copy mechanism. Must be overridden in derived classes. More... | |
| Protected Attributes inherited from PdfSharp.Pdf.PdfDictionary | |
| DictionaryElements | elements |
| The elements of the dictionary. More... | |
Detailed Description
Represents the text field.
Property Documentation
◆ BackColor
|
getset |
Gets or sets the background color of the field.
◆ Font
|
getset |
Gets or sets the font used to draw the text of the field.
◆ ForeColor
|
getset |
Gets or sets the foreground color of the field.
◆ MaxLength
|
getset |
Gets or sets the maximum length of the field.
The length of the max.
◆ MultiLine
|
getset |
Gets or sets a value indicating whether the field has multiple lines.
◆ Password
|
getset |
Gets or sets a value indicating whether this field is used for passwords.
◆ Text
|
getset |
Gets or sets the text value of the text field.
The documentation for this class was generated from the following file:
- PdfSharp.Pdf.AcroForms/PdfTextField.cs
