org.pdfclown.documents.files.EmbeddedFile Class Reference
Embedded file [PDF:1.6:3.10.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) |
| override int | GetHashCode () |
Static Public Member Functions | |
| static EmbeddedFile | Get (Document context, bytes::IInputStream stream) |
| Creates a new embedded file inside the document. | |
| static EmbeddedFile | Get (Document context, string path) |
| Creates a new embedded file inside the document. | |
| static PdfDirectObject | GetBaseObject (PdfObjectWrapper wrapper) |
| Gets the PDF object backing the specified wrapper. | |
| static EmbeddedFile | Wrap (PdfDirectObject baseObject) |
| Instantiates an existing embedded file. | |
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. | |
| DateTime | CreationDate [get, set] |
| Gets/Sets the creation date of this file. | |
| bytes::IBuffer | Data [get] |
| Gets the data contained within this file. | |
| 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. | |
| string | MimeType [get, set] |
| Gets/Sets the MIME media type name of this file [RFC 2046]. | |
| DateTime | ModificationDate [get, set] |
| Gets/Sets the modification date of this file. | |
| int | Size [get, set] |
| Gets/Sets the size of this file, in bytes. | |
Embedded file [PDF:1.6:3.10.3].
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).
| override bool org.pdfclown.objects.PdfObjectWrapper.Equals | ( | object | obj | ) | [inherited] |
| static EmbeddedFile org.pdfclown.documents.files.EmbeddedFile.Get | ( | Document | context, | |
| bytes::IInputStream | stream | |||
| ) | [static] |
Creates a new embedded file inside the document.
- Parameters:
-
context Document context. stream File stream to embed.
| static EmbeddedFile org.pdfclown.documents.files.EmbeddedFile.Get | ( | Document | context, | |
| string | path | |||
| ) | [static] |
Creates a new embedded file inside the document.
- Parameters:
-
context Document context. path Path of the file to embed.
| static PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.GetBaseObject | ( | PdfObjectWrapper< PdfStream > | 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] |
| 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.
| static EmbeddedFile org.pdfclown.documents.files.EmbeddedFile.Wrap | ( | PdfDirectObject | baseObject | ) | [static] |
Instantiates an existing embedded file.
- Parameters:
-
baseObject Base object.
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.
DateTime org.pdfclown.documents.files.EmbeddedFile.CreationDate [get, set] |
Gets/Sets the creation date of this file.
bytes::IBuffer org.pdfclown.documents.files.EmbeddedFile.Data [get] |
Gets the data contained within this file.
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] |
Gets the file context.
string org.pdfclown.documents.files.EmbeddedFile.MimeType [get, set] |
Gets/Sets the MIME media type name of this file [RFC 2046].
DateTime org.pdfclown.documents.files.EmbeddedFile.ModificationDate [get, set] |
Gets/Sets the modification date of this file.
int org.pdfclown.documents.files.EmbeddedFile.Size [get, set] |
Gets/Sets the size of this file, in bytes.
