org.pdfclown.documents.interaction.actions.GoToEmbedded.PathElement Class Reference

Path information to the target document [PDF:1.6:8.5.3]. More...

Inheritance diagram for org.pdfclown.documents.interaction.actions.GoToEmbedded.PathElement:

List of all members.

Public Types
enum	RelationEnum { Parent, Child }
	Relationship between the target and the current document [PDF:1.6:8.5.3]. More...
Public Member Functions
virtual object	Clone (Document context)
	Gets a clone of the object, registered inside the given document context.
override object	Clone (Document context)
virtual bool	Delete ()
	Removes the object from its document context.
override bool	Equals (object obj)
override int	GetHashCode ()
	PathElement (Document context, object annotationPageRef, object annotationRef, PathElement next)
	Creates a new path element associated with a file attachment annotation.
	PathElement (Document context, string embeddedFileName, PathElement next)
	Creates a new path element located in the embedded files collection of the document.
	PathElement (Document context, PathElement next)
	Creates a new path element representing the parent of the document.
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
object	AnnotationPageRef [get, set]
	Gets/Sets the page reference to the file attachment annotation.
object	AnnotationRef [get, set]
	Gets/Sets the reference to the file attachment annotation.
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.
Document	Document [get]
	Gets the document context.
string	EmbeddedFileName [get, set]
	Gets/Sets the embedded file name.
File	File [get]
	Gets the file context.
PathElement	Next [get, set]
	Gets/Sets a further path information to the target document.
RelationEnum	Relation [get, set]
	Gets/Sets the relationship between the target and the current document.

---

Path information to the target document [PDF:1.6:8.5.3].

---

Member Enumeration Documentation

enum org::pdfclown::documents::interaction::actions::GoToEmbedded::PathElement::RelationEnum

Relationship between the target and the current document [PDF:1.6:8.5.3].

Enumerator:

Parent	Parent.
Child	Child.

---

Constructor & Destructor Documentation

org.pdfclown.documents.interaction.actions.GoToEmbedded.PathElement.PathElement	(	Document	context,
		PathElement	next
	)

Creates a new path element representing the parent of the document.

org.pdfclown.documents.interaction.actions.GoToEmbedded.PathElement.PathElement	(	Document	context,
		string	embeddedFileName,
		PathElement	next
	)

Creates a new path element located in the embedded files collection of the document.

org.pdfclown.documents.interaction.actions.GoToEmbedded.PathElement.PathElement	(	Document	context,
		object	annotationPageRef,
		object	annotationRef,
		PathElement	next
	)

Creates a new path element associated with a file attachment annotation.

---

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.

override object org.pdfclown.documents.interaction.actions.GoToEmbedded.PathElement.Clone

(

Document

context

)

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.

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

object org.pdfclown.documents.interaction.actions.GoToEmbedded.PathElement.AnnotationPageRef [get, set]

Gets/Sets the page reference to the file attachment annotation.

Returns:

Either the (zero-based) number of the page in the current document containing the file attachment annotation, or the name of a destination in the current document that provides the page number of the file attachment annotation.

object org.pdfclown.documents.interaction.actions.GoToEmbedded.PathElement.AnnotationRef [get, set]

Gets/Sets the reference to the file attachment annotation.

Returns:

Either the (zero-based) index of the annotation in the list of annotations associated to the page specified by the annotationPageRef property, or the name of the annotation.

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.

Document org.pdfclown.objects.PdfObjectWrapper.Document [get, inherited]

Gets the document context.

string org.pdfclown.documents.interaction.actions.GoToEmbedded.PathElement.EmbeddedFileName [get, set]

Gets/Sets the embedded file name.

File org.pdfclown.objects.PdfObjectWrapper.File [get, inherited]

Gets the file context.

PathElement org.pdfclown.documents.interaction.actions.GoToEmbedded.PathElement.Next [get, set]

Gets/Sets a further path information to the target document.

RelationEnum org.pdfclown.documents.interaction.actions.GoToEmbedded.PathElement.Relation [get, set]

Gets/Sets the relationship between the target and the current document.