org.pdfclown.documents.files.RelatedFiles Class Reference

Embedded files referenced by another one (dependencies) [PDF:1.6:3.10.3]. More...

Inheritance diagram for org.pdfclown.documents.files.RelatedFiles:

List of all members.

Public Member Functions
void	Add (string key, EmbeddedFile 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, EmbeddedFile >[] entries, int index)
virtual bool	Delete ()
	Removes the object from its document context.
override bool	Equals (object obj)
override int	GetHashCode ()
	RelatedFiles (Document context)
bool	Remove (KeyValuePair< string, EmbeddedFile > entry)
bool	Remove (string key)
bool	TryGetValue (string key, out EmbeddedFile value)
Static Public Member Functions
static PdfDirectObject	GetBaseObject (PdfObjectWrapper wrapper)
	Gets the PDF object backing the specified wrapper.
static RelatedFiles	Wrap (PdfDirectObject baseObject)
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]
EmbeddedFile	this [string key] [get, set]
ICollection< EmbeddedFile >	Values [get]

---

Embedded files referenced by another one (dependencies) [PDF:1.6:3.10.3].

---

Constructor & Destructor Documentation

org.pdfclown.documents.files.RelatedFiles.RelatedFiles

(

Document

context

)

---

Member Function Documentation

void org.pdfclown.documents.files.RelatedFiles.Add	(	string	key,
		EmbeddedFile	value
	)

References org.pdfclown.objects.PdfArray.Add(), and org.pdfclown.objects.PdfObjectWrapper.BaseObject.

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

void org.pdfclown.documents.files.RelatedFiles.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.files.RelatedFiles.ContainsKey

(

string

key

)

References org.pdfclown.objects.PdfArray.Count.

void org.pdfclown.documents.files.RelatedFiles.CopyTo	(	KeyValuePair< string, EmbeddedFile >[]	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.files.RelatedFiles.Remove

(

KeyValuePair< string, EmbeddedFile >

entry

)

bool org.pdfclown.documents.files.RelatedFiles.Remove

(

string

key

)

References org.pdfclown.objects.PdfArray.Count, and org.pdfclown.objects.PdfArray.RemoveAt().

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.files.RelatedFiles.TryGetValue	(	string	key,
		out EmbeddedFile	value
	)

static RelatedFiles org.pdfclown.documents.files.RelatedFiles.Wrap

(

PdfDirectObject

baseObject

)

[static]

---

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.files.RelatedFiles.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]

Gets the file context.

bool org.pdfclown.documents.files.RelatedFiles.IsReadOnly [get]

ICollection<string> org.pdfclown.documents.files.RelatedFiles.Keys [get]

EmbeddedFile org.pdfclown.documents.files.RelatedFiles.this[string key] [get, set]

ICollection<EmbeddedFile> org.pdfclown.documents.files.RelatedFiles.Values [get]