Inheritance diagram for iTextSharp.text.pdf.PdfFileSpecification:

Public Member Functions
	PdfFileSpecification ()

void	SetUnicodeFileName (String filename, bool unicode)

void	AddDescription (String description, bool unicode)

void	AddCollectionItem (PdfCollectionItem ci)

Public Member Functions inherited from iTextSharp.text.pdf.PdfDictionary
	PdfDictionary ()

	PdfDictionary (PdfName type)

override void	ToPdf (PdfWriter writer, Stream os)

void	Put (PdfName key, PdfObject value)

void	PutEx (PdfName key, PdfObject value)

void	Remove (PdfName key)

PdfObject	Get (PdfName key)

bool	IsFont ()

bool	IsPage ()

bool	IsPages ()

bool	IsCatalog ()

bool	IsOutlineTree ()

void	Merge (PdfDictionary other)

void	MergeDifferent (PdfDictionary other)

bool	Contains (PdfName key)

virtual IDictionaryEnumerator	GetEnumerator ()

override String	ToString ()

PdfObject	GetDirectObject (PdfName key)

PdfDictionary	GetAsDict (PdfName key)

PdfArray	GetAsArray (PdfName key)

PdfStream	GetAsStream (PdfName key)

PdfString	GetAsString (PdfName key)

PdfNumber	GetAsNumber (PdfName key)

PdfName	GetAsName (PdfName key)

PdfBoolean	GetAsBoolean (PdfName key)

PdfIndirectReference	GetAsIndirectObject (PdfName key)

Public Member Functions inherited from iTextSharp.text.pdf.PdfObject
virtual byte[]	GetBytes ()

bool	CanBeInObjStm ()

override string	ToString ()

bool	IsNull ()

bool	IsBoolean ()

bool	IsNumber ()

bool	IsString ()

bool	IsName ()

bool	IsArray ()

bool	IsDictionary ()

bool	IsStream ()

bool	IsIndirect ()

Static Public Member Functions
static PdfFileSpecification	Url (PdfWriter writer, String url)

static PdfFileSpecification	FileEmbedded (PdfWriter writer, String filePath, String fileDisplay, byte[] fileStore)

static PdfFileSpecification	FileEmbedded (PdfWriter writer, String filePath, String fileDisplay, byte[] fileStore, int compressionLevel)

static PdfFileSpecification	FileEmbedded (PdfWriter writer, String filePath, String fileDisplay, byte[] fileStore, bool compress)

static PdfFileSpecification	FileEmbedded (PdfWriter writer, String filePath, String fileDisplay, byte[] fileStore, bool compress, String mimeType, PdfDictionary fileParameter)

static PdfFileSpecification	FileEmbedded (PdfWriter writer, String filePath, String fileDisplay, byte[] fileStore, String mimeType, PdfDictionary fileParameter, int compressionLevel)

static PdfFileSpecification	FileExtern (PdfWriter writer, String filePath)

Protected Attributes
PdfWriter	writer

PdfIndirectReference	refi

Protected Attributes inherited from iTextSharp.text.pdf.PdfObject
byte[]	bytes

int	type

PRIndirectReference	indRef

Properties
PdfIndirectReference	Reference `[get]`

byte[]	MultiByteFileName `[set]`

bool	Volatile `[set]`

Properties inherited from iTextSharp.text.pdf.PdfDictionary
ICollection	Keys `[get]`

int	Size `[get]`

Properties inherited from iTextSharp.text.pdf.PdfObject
int	Length `[get]`

string	Content `[set]`

int	Type `[get]`

PRIndirectReference	IndRef `[get, set]`

Additional Inherited Members
Static Public Attributes inherited from iTextSharp.text.pdf.PdfDictionary
static PdfName	FONT = PdfName.FONT

static PdfName	OUTLINES = PdfName.OUTLINES

static PdfName	PAGE = PdfName.PAGE

static PdfName	PAGES = PdfName.PAGES

static PdfName	CATALOG = PdfName.CATALOG

Static Public Attributes inherited from iTextSharp.text.pdf.PdfObject
const int	BOOLEAN = 1

const int	NUMBER = 2

const int	STRING = 3

const int	NAME = 4

const int	ARRAY = 5

const int	DICTIONARY = 6

const int	STREAM = 7

const int	NULL = 8

const int	INDIRECT = 10

const string	NOTHING = ""

const string	TEXT_PDFDOCENCODING = "PDF"

const string	TEXT_UNICODE = "UnicodeBig"

Protected Member Functions inherited from iTextSharp.text.pdf.PdfObject
	PdfObject (int type)

	PdfObject (int type, string content)

	PdfObject (int type, byte[] bytes)

Detailed Description

Specifies a file or an URL. The file can be extern or embedded.

Author: Paulo Soares (psoar.nosp@m.es@c.nosp@m.onsis.nosp@m.te.p.nosp@m.t)

Constructor & Destructor Documentation

◆ PdfFileSpecification()

iTextSharp.text.pdf.PdfFileSpecification.PdfFileSpecification ( )

Creates a new instance of PdfFileSpecification. The static methods are preferred.

Member Function Documentation

◆ AddCollectionItem()

void iTextSharp.text.pdf.PdfFileSpecification.AddCollectionItem ( PdfCollectionItem ci )

Adds the Collection item dictionary.

◆ AddDescription()

void iTextSharp.text.pdf.PdfFileSpecification.AddDescription	(	String	description,
		bool	unicode
	)

Adds a description for the file that is specified here.

Parameters

description	some text
unicode	if true, the text is added as a unicode string

◆ FileEmbedded() [1/5]

static PdfFileSpecification iTextSharp.text.pdf.PdfFileSpecification.FileEmbedded	(	PdfWriter	writer,
		String	filePath,
		String	fileDisplay,
		byte[]	fileStore
	)

static

Creates a file specification with the file embedded. The file may come from the file system or from a byte array. The data is flate compressed.

Parameters

writer	the `PdfWriter`
filePath	the file path
fileDisplay	the file information that is presented to the user
fileStore	the byte array with the file. If it is not `null` it takes precedence over `filePath`

Exceptions

IOException on error

Returns: the file specification

◆ FileEmbedded() [2/5]

static PdfFileSpecification iTextSharp.text.pdf.PdfFileSpecification.FileEmbedded	(	PdfWriter	writer,
		String	filePath,
		String	fileDisplay,
		byte[]	fileStore,
		bool	compress
	)

static

Creates a file specification with the file embedded. The file may come from the file system or from a byte array.

Parameters

writer	the `PdfWriter`
filePath	the file path
fileDisplay	the file information that is presented to the user
fileStore	the byte array with the file. If it is not `null` it takes precedence over `filePath`
compress	sets the compression on the data. Multimedia content will benefit little from compression

Exceptions

IOException on error

Returns: the file specification

◆ FileEmbedded() [3/5]

static PdfFileSpecification iTextSharp.text.pdf.PdfFileSpecification.FileEmbedded	(	PdfWriter	writer,
		String	filePath,
		String	fileDisplay,
		byte[]	fileStore,
		bool	compress,
		String	mimeType,
		PdfDictionary	fileParameter
	)

static

Creates a file specification with the file embedded. The file may come from the file system or from a byte array.

Parameters

writer	the `PdfWriter`
filePath	the file path
fileDisplay	the file information that is presented to the user
fileStore	the byte array with the file. If it is not `null` it takes precedence over `filePath`
compress	sets the compression on the data. Multimedia content will benefit little from compression
mimeType	the optional mimeType
fileParameter	the optional extra file parameters such as the creation or modification date

Exceptions

IOException on error

Returns: the file specification

◆ FileEmbedded() [4/5]

static PdfFileSpecification iTextSharp.text.pdf.PdfFileSpecification.FileEmbedded	(	PdfWriter	writer,
		String	filePath,
		String	fileDisplay,
		byte[]	fileStore,
		int	compressionLevel
	)

static

Creates a file specification with the file embedded. The file may come from the file system or from a byte array. The data is flate compressed.

Parameters

writer	the `PdfWriter`
filePath	the file path
fileDisplay	the file information that is presented to the user
fileStore	the byte array with the file. If it is not `null` it takes precedence over `filePath`
compressionLevel	the compression level to be used for compressing the file it takes precedence over `filePath`

Exceptions

IOException on error

Returns: the file specification

Since: 2.1.3

◆ FileEmbedded() [5/5]

static PdfFileSpecification iTextSharp.text.pdf.PdfFileSpecification.FileEmbedded	(	PdfWriter	writer,
		String	filePath,
		String	fileDisplay,
		byte[]	fileStore,
		String	mimeType,
		PdfDictionary	fileParameter,
		int	compressionLevel
	)

static

Creates a file specification with the file embedded. The file may come from the file system or from a byte array.

Parameters

writer	the `PdfWriter`
filePath	the file path
fileDisplay	the file information that is presented to the user
fileStore	the byte array with the file. If it is not `null` it takes precedence over `filePath`
mimeType	the optional mimeType
fileParameter	the optional extra file parameters such as the creation or modification date
compressionLevel	the level of compression

Exceptions

IOException on error

Returns: the file specification

Since: 2.1.3

◆ FileExtern()

static PdfFileSpecification iTextSharp.text.pdf.PdfFileSpecification.FileExtern	(	PdfWriter	writer,
		String	filePath
	)

static

Creates a file specification for an external file.

Parameters

writer	the `PdfWriter`
filePath	the file path

Returns: the file specification

◆ SetUnicodeFileName()

void iTextSharp.text.pdf.PdfFileSpecification.SetUnicodeFileName	(	String	filename,
		bool	unicode
	)

Adds the unicode file name (the key /UF). This entry was introduced in PDF 1.7. The filename must have the slash and backslash escaped according to the file specification rules.

Parameters

filename	the filename
unicode	if true, the filename is UTF-16BE encoded; otherwise PDFDocEncoding is used;

◆ Url()

static PdfFileSpecification iTextSharp.text.pdf.PdfFileSpecification.Url	(	PdfWriter	writer,
		String	url
	)

static

Creates a file specification of type URL.

Parameters

writer	the `PdfWriter`
url	the URL

Returns: the file specification

Member Data Documentation

◆ refi

PdfIndirectReference iTextSharp.text.pdf.PdfFileSpecification.refi

protected

◆ writer

PdfWriter iTextSharp.text.pdf.PdfFileSpecification.writer

protected

Property Documentation

◆ MultiByteFileName

byte [] iTextSharp.text.pdf.PdfFileSpecification.MultiByteFileName

set

Sets the file name (the key /F) string as an hex representation to support multi byte file names. The name must have the slash and backslash escaped according to the file specification rules

Parameters

fileName the file name as a byte array

◆ Reference

PdfIndirectReference iTextSharp.text.pdf.PdfFileSpecification.Reference

get

Gets the indirect reference to this file specification. Multiple invocations will retrieve the same value.

Exceptions

IOException on error

Returns: the indirect reference

◆ Volatile

bool iTextSharp.text.pdf.PdfFileSpecification.Volatile

set

Sets a flag that indicates whether an external file referenced by the file specification is volatile. If the value is true, applications should never cache a copy of the file.

Parameters

volatile_file if true, the external file should not be cached

The documentation for this class was generated from the following file:

src/core/iTextSharp/text/pdf/PdfFileSpecification.cs

Public Member Functions

Static Public Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PdfFileSpecification()

Member Function Documentation

◆ AddCollectionItem()

◆ AddDescription()

◆ FileEmbedded() [1/5]

◆ FileEmbedded() [2/5]

◆ FileEmbedded() [3/5]

◆ FileEmbedded() [4/5]

◆ FileEmbedded() [5/5]

◆ FileExtern()

◆ SetUnicodeFileName()

◆ Url()

Member Data Documentation

◆ refi

◆ writer

Property Documentation

◆ MultiByteFileName

◆ Reference

◆ Volatile