org.pdfclown.documents.interaction.forms.Fields Class Reference
Interactive form fields [PDF:1.6:8.6.1].
More...
List of all members.
Public Member Functions |
| void | Add (string key, Field value) |
| void | Add (Field value) |
| void | Clear () |
| virtual object | Clone (Document context) |
| | Gets a clone of the object, registered inside the given document context.
|
| bool | ContainsKey (string key) |
| void | CopyTo (KeyValuePair< string, Field >[] entries, int index) |
| virtual bool | Delete () |
| | Removes the object from its document context.
|
| override bool | Equals (object obj) |
| | Fields (Document context) |
| override int | GetHashCode () |
| bool | Remove (KeyValuePair< string, Field > entry) |
| bool | Remove (string key) |
| bool | TryGetValue (string key, out Field value) |
Static Public Member Functions |
| static PdfDirectObject | GetBaseObject (PdfObjectWrapper wrapper) |
| | Gets the PDF object backing the specified wrapper.
|
Protected Member Functions |
| void | CheckCompatibility (object feature) |
| | Checks whether the specified feature is compatible with the document's conformance version.
|
| virtual PdfString | RetrieveName () |
| | Retrieves the name possibly associated to this object, walking through the document's name dictionary.
|
| PdfDirectObject | RetrieveNamedBaseObject () |
| | Retrieves the object name, if available; otherwise, behaves like PdfObjectWrapper.BaseObject.
|
Properties |
| virtual PdfDirectObject | BaseObject [get, set] |
| PdfIndirectObject | Container [get] |
| | Gets the indirect object containing the base object.
|
| int | Count [get] |
| PdfIndirectObject | DataContainer [get] |
| | Gets the indirect object containing the base data object.
|
| Document | Document [get] |
| | Gets the document context.
|
| File | File [get] |
| | Gets the file context.
|
| bool | IsReadOnly [get] |
| ICollection< string > | Keys [get] |
| Field | this [string key] [get, set] |
| ICollection< Field > | Values [get] |
Interactive form fields [PDF:1.6:8.6.1].
Constructor & Destructor Documentation
| org.pdfclown.documents.interaction.forms.Fields.Fields |
( |
Document |
context |
) |
|
Member Function Documentation
| void org.pdfclown.documents.interaction.forms.Fields.Add |
( |
string |
key, |
|
|
Field |
value | |
|
) |
| | |
| void org.pdfclown.documents.interaction.forms.Fields.Add |
( |
Field |
value |
) |
|
| void org.pdfclown.objects.PdfObjectWrapper.CheckCompatibility |
( |
object |
feature |
) |
[protected, inherited] |
Checks whether the specified feature is compatible with the document's conformance version.
- Parameters:
-
| feature | Entity whose compatibility has to be checked. Supported types:
|
| void org.pdfclown.documents.interaction.forms.Fields.Clear |
( |
|
) |
|
| virtual object org.pdfclown.objects.PdfObjectWrapper.Clone |
( |
Document |
context |
) |
[virtual, inherited] |
Gets a clone of the object, registered inside the given document context.
- Parameters:
-
| context | Which document the clone has to be registered in. |
| bool org.pdfclown.documents.interaction.forms.Fields.ContainsKey |
( |
string |
key |
) |
|
| void org.pdfclown.documents.interaction.forms.Fields.CopyTo |
( |
KeyValuePair< string, Field >[] |
entries, |
|
|
int |
index | |
|
) |
| | |
| virtual bool org.pdfclown.objects.PdfObjectWrapper.Delete |
( |
|
) |
[virtual, inherited] |
Removes the object from its document context.
The object is no more usable after this method returns.
- Returns:
- Whether the object was actually decontextualized (only indirect objects can be decontextualize).
| override bool org.pdfclown.objects.PdfObjectWrapper.Equals |
( |
object |
obj |
) |
[inherited] |
| static PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.GetBaseObject |
( |
PdfObjectWrapper< PdfArray > |
wrapper |
) |
[static, inherited] |
Gets the PDF object backing the specified wrapper.
- Parameters:
-
| wrapper | Object to extract the base from. |
| override int org.pdfclown.objects.PdfObjectWrapper.GetHashCode |
( |
|
) |
[inherited] |
| bool org.pdfclown.documents.interaction.forms.Fields.Remove |
( |
KeyValuePair< string, Field > |
entry |
) |
|
| bool org.pdfclown.documents.interaction.forms.Fields.Remove |
( |
string |
key |
) |
|
| virtual PdfString org.pdfclown.objects.PdfObjectWrapper.RetrieveName |
( |
|
) |
[protected, virtual, inherited] |
Retrieves the name possibly associated to this object, walking through the document's name dictionary.
| PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.RetrieveNamedBaseObject |
( |
|
) |
[protected, inherited] |
Retrieves the object name, if available; otherwise, behaves like PdfObjectWrapper.BaseObject.
| bool org.pdfclown.documents.interaction.forms.Fields.TryGetValue |
( |
string |
key, |
|
|
out Field |
value | |
|
) |
| | |
Property Documentation
virtual PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.BaseObject [get, set, inherited] |
Gets the underlying reference object, if available; otherwise, gets the underlying data object.
PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.Container [get, inherited] |
Gets the indirect object containing the base object.
int org.pdfclown.documents.interaction.forms.Fields.Count [get] |
PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.DataContainer [get, inherited] |
Gets the indirect object containing the base data object.
Document org.pdfclown.objects.PdfObjectWrapper.Document [get, inherited] |
Gets the document context.
File org.pdfclown.objects.PdfObjectWrapper.File [get, inherited] |
bool org.pdfclown.documents.interaction.forms.Fields.IsReadOnly [get] |
ICollection<string> org.pdfclown.documents.interaction.forms.Fields.Keys [get] |
Field org.pdfclown.documents.interaction.forms.Fields.this[string key] [get, set] |
ICollection<Field> org.pdfclown.documents.interaction.forms.Fields.Values [get] |
