org.pdfclown.documents.interaction.navigation.document.Bookmark Class Reference

Outline item [PDF:1.6:8.2.2]. More...

Inheritance diagram for org.pdfclown.documents.interaction.navigation.document.Bookmark:

List of all members.

Public Types
enum	FlagsEnum { Italic = 0x1, Bold = 0x2 }
	Bookmark flags [PDF:1.6:8.2.2]. More...
Public Member Functions
	Bookmark (Document context, string title, actions.Action action)
	Bookmark (Document context, string title, LocalDestination destination)
	Bookmark (Document context, string title)
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 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]
Bookmarks	Bookmarks [get]
	Gets the child bookmarks.
DeviceRGBColor	Color [get, set]
	Gets/Sets the bookmark text color.
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.
bool	Expanded [get, set]
	Gets/Sets whether this bookmark's children are displayed.
File	File [get]
	Gets the file context.
FlagsEnum	Flags [get, set]
	Gets/Sets the bookmark flags.
Bookmark	Parent [get]
	Gets the parent bookmark.
PdfObjectWrapper	Target [get, set]
	Gets/Sets the link target.
string	Title [get, set]
	Gets/Sets the text to be displayed for this bookmark.

---

Outline item [PDF:1.6:8.2.2].

---

Member Enumeration Documentation

enum org::pdfclown::documents::interaction::navigation::document::Bookmark::FlagsEnum

Bookmark flags [PDF:1.6:8.2.2].

Enumerator:

Italic	Display the item in italic.
Bold	Display the item in bold.

---

Constructor & Destructor Documentation

org.pdfclown.documents.interaction.navigation.document.Bookmark.Bookmark	(	Document	context,
		string	title
	)

org.pdfclown.documents.interaction.navigation.document.Bookmark.Bookmark	(	Document	context,
		string	title,
		LocalDestination	destination
	)

org.pdfclown.documents.interaction.navigation.document.Bookmark.Bookmark	(	Document	context,
		string	title,
		actions.Action	action
	)

---

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.

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.

Bookmarks org.pdfclown.documents.interaction.navigation.document.Bookmark.Bookmarks [get]

Gets the child bookmarks.

DeviceRGBColor org.pdfclown.documents.interaction.navigation.document.Bookmark.Color [get, set]

Gets/Sets the bookmark text color.

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.

bool org.pdfclown.documents.interaction.navigation.document.Bookmark.Expanded [get, set]

Gets/Sets whether this bookmark's children are displayed.

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

Gets the file context.

FlagsEnum org.pdfclown.documents.interaction.navigation.document.Bookmark.Flags [get, set]

Gets/Sets the bookmark flags.

Bookmark org.pdfclown.documents.interaction.navigation.document.Bookmark.Parent [get]

Gets the parent bookmark.

PdfObjectWrapper org.pdfclown.documents.interaction.navigation.document.Bookmark.Target [get, set]

Gets/Sets the link target.

Returns:

Either a Destination or an Action.

Implements org.pdfclown.documents.interaction.ILink.

string org.pdfclown.documents.interaction.navigation.document.Bookmark.Title [get, set]

Gets/Sets the text to be displayed for this bookmark.