org.pdfclown.documents.Names Class Reference
Name dictionary [PDF:1.6:3.6.3]. More...
Public Member Functions | |
| virtual object | Clone (Document context) |
| Gets a clone of the object, registered inside the given document context. | |
| virtual bool | Delete () |
| Removes the object from its document context. | |
| override bool | Equals (object obj) |
| PdfObjectWrapper | Get (Type type, PdfString key) |
| PdfObjectWrapper | Get (Type type) |
| override int | GetHashCode () |
| Names (Document context) | |
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. | |
| PdfIndirectObject | DataContainer [get] |
| Gets the indirect object containing the base data object. | |
| NamedDestinations | Destinations [get, set] |
| Gets/Sets the named destinations. | |
| Document | Document [get] |
| Gets the document context. | |
| NamedEmbeddedFiles | EmbeddedFiles [get, set] |
| Gets/Sets the named embedded files. | |
| File | File [get] |
| Gets the file context. | |
| NamedJavaScripts | JavaScripts [get, set] |
| Gets/Sets the named JavaScript actions. | |
| NamedRenditions | Renditions [get, set] |
| Gets/Sets the named renditions. | |
Name dictionary [PDF:1.6:3.6.3].
Constructor & Destructor Documentation
| org.pdfclown.documents.Names.Names | ( | Document | context | ) |
Member Function Documentation
| 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: - VersionEnum
- Property name resolvable to an annotated getter method
- MemberInfo
| 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.
| 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).
Reimplemented in org.pdfclown.documents.interaction.annotations.Annotation, org.pdfclown.documents.interaction.navigation.page.Article, and org.pdfclown.documents.interaction.navigation.page.ArticleElement.
| override bool org.pdfclown.objects.PdfObjectWrapper.Equals | ( | object | obj | ) | [inherited] |
Reimplemented in org.pdfclown.documents.contents.fonts.Font.
| PdfObjectWrapper org.pdfclown.documents.Names.Get | ( | Type | type, | |
| PdfString | key | |||
| ) |
References org.pdfclown.documents.Names.Get().
Referenced by org.pdfclown.documents.Names.Get().
| PdfObjectWrapper org.pdfclown.documents.Names.Get | ( | Type | type | ) |
| static PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.GetBaseObject | ( | PdfObjectWrapper< PdfDictionary > | 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] |
Reimplemented in org.pdfclown.documents.contents.fonts.Font.
| 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.
Reimplemented in org.pdfclown.documents.multimedia.Rendition.
| PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.RetrieveNamedBaseObject | ( | ) | [protected, inherited] |
Retrieves the object name, if available; otherwise, behaves like PdfObjectWrapper.BaseObject.
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.
PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.DataContainer [get, inherited] |
Gets the indirect object containing the base data object.
NamedDestinations org.pdfclown.documents.Names.Destinations [get, set] |
Gets/Sets the named destinations.
Document org.pdfclown.objects.PdfObjectWrapper.Document [get, inherited] |
Gets the document context.
NamedEmbeddedFiles org.pdfclown.documents.Names.EmbeddedFiles [get, set] |
Gets/Sets the named embedded files.
File org.pdfclown.objects.PdfObjectWrapper.File [get, inherited] |
Gets the file context.
NamedJavaScripts org.pdfclown.documents.Names.JavaScripts [get, set] |
Gets/Sets the named JavaScript actions.
NamedRenditions org.pdfclown.documents.Names.Renditions [get, set] |
Gets/Sets the named renditions.
