iText.Kernel.Pdf.Filespec.PdfFileSpec Class Reference

Inheritance diagram for iText.Kernel.Pdf.Filespec.PdfFileSpec:

Public Member Functions
virtual iText.Kernel.Pdf.Filespec.PdfFileSpec	SetFileIdentifier (PdfArray fileIdentifier)
virtual PdfArray	GetFileIdentifier ()
virtual iText.Kernel.Pdf.Filespec.PdfFileSpec	SetVolatile (PdfBoolean isVolatile)
virtual PdfBoolean	IsVolatile ()
virtual iText.Kernel.Pdf.Filespec.PdfFileSpec	SetCollectionItem (PdfCollectionItem item)
virtual iText.Kernel.Pdf.Filespec.PdfFileSpec	SetThumbnailImage (PdfImageXObject thumbnailImage)
	PDF 2.0. More...
virtual PdfImageXObject	GetThumbnailImage ()
	PDF 2.0. More...
virtual iText.Kernel.Pdf.Filespec.PdfFileSpec	Put (PdfName key, PdfObject value)
Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfObject >
virtual T	GetPdfObject ()
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document, PdfIndirectReference reference)
	Marks object behind wrapper to be saved as indirect. More...
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document)
	Marks object behind wrapper to be saved as indirect. More...
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	SetModified ()
virtual void	Flush ()
virtual bool	IsFlushed ()

Static Public Member Functions
static iText.Kernel.Pdf.Filespec.PdfFileSpec	WrapFileSpecObject (PdfObject fileSpecObject)
static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateExternalFileSpec (PdfDocument doc, String filePath, PdfName afRelationshipValue)
static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateExternalFileSpec (PdfDocument doc, String filePath)
static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, byte[] fileStore, String description, String fileDisplay, PdfName mimeType, PdfDictionary fileParameter, PdfName afRelationshipValue)
	Embed a file to a PdfDocument. More...
static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, byte[] fileStore, String description, String fileDisplay, PdfDictionary fileParameter, PdfName afRelationshipValue)
	Embed a file to a PdfDocument. More...
static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, byte[] fileStore, String fileDisplay, PdfDictionary fileParameter, PdfName afRelationshipValue)
	Embed a file to a PdfDocument. More...
static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, byte[] fileStore, String fileDisplay, PdfName afRelationshipValue)
	Embed a file to a PdfDocument. More...
static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, byte[] fileStore, String description, String fileDisplay, PdfName afRelationshipValue)
	Embed a file to a PdfDocument. More...
static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, String filePath, String description, String fileDisplay, PdfName mimeType, PdfDictionary fileParameter, PdfName afRelationshipValue)
	Embed a file to a PdfDocument. More...
static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, String filePath, String description, String fileDisplay, PdfName mimeType, PdfName afRelationshipValue)
	Embed a file to a PdfDocument. More...
static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, String filePath, String description, String fileDisplay, PdfName afRelationshipValue)
	Embed a file to a PdfDocument. More...
static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, String filePath, String fileDisplay, PdfName afRelationshipValue)
	Embed a file to a PdfDocument. More...
static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, Stream @is, String description, String fileDisplay, PdfName mimeType, PdfDictionary fileParameter, PdfName afRelationshipValue)
	Embed a file to a PdfDocument. More...
static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, Stream @is, String description, String fileDisplay, PdfName mimeType, PdfName afRelationshipValue)
	Embed a file to a PdfDocument. More...

Member Function Documentation

CreateEmbeddedFileSpec() [1/11]

static iText.Kernel.Pdf.Filespec.PdfFileSpec iText.Kernel.Pdf.Filespec.PdfFileSpec.CreateEmbeddedFileSpec ( PdfDocument  doc, byte[]  fileStore, String  description, String  fileDisplay, PdfDictionary  fileParameter, PdfName  afRelationshipValue  )

inlinestatic

Embed a file to a PdfDocument.

Parameters

doc	PdfDocument to add the file to
fileStore	byte[] containing the file
fileDisplay	actual file name stored in the pdf
fileParameter	Pdfdictionary containing fil parameters
afRelationshipValue	AFRelationship key value,

AFRelationshipValue. If

 null, @see AFRelationshipValue.Unspecified will be added. 
       

          
       

         PdfFileSpec containing the file specification of the file as Pdfobject 
       

CreateEmbeddedFileSpec() [2/11]

static iText.Kernel.Pdf.Filespec.PdfFileSpec iText.Kernel.Pdf.Filespec.PdfFileSpec.CreateEmbeddedFileSpec ( PdfDocument  doc, byte[]  fileStore, String  description, String  fileDisplay, PdfName  afRelationshipValue  )

inlinestatic

Embed a file to a PdfDocument.

Parameters

doc	PdfDocument to add the file to
fileStore	byte[] containing the file
description	file description
fileDisplay	actual file name stored in the pdf
afRelationshipValue	AFRelationship key value,

AFRelationshipValue. If

 null, @see AFRelationshipValue.Unspecified will be added. 
       

          
       

         PdfFileSpec containing the file specification of the file as Pdfobject 
       

CreateEmbeddedFileSpec() [3/11]

static iText.Kernel.Pdf.Filespec.PdfFileSpec iText.Kernel.Pdf.Filespec.PdfFileSpec.CreateEmbeddedFileSpec ( PdfDocument  doc, byte[]  fileStore, String  description, String  fileDisplay, PdfName  mimeType, PdfDictionary  fileParameter, PdfName  afRelationshipValue  )

inlinestatic

Embed a file to a PdfDocument.

Parameters

doc	PdfDocument to add the file to
fileStore	byte[] containing the file
description	file description
fileDisplay	actual file name stored in the pdf
mimeType	mime-type of the file
fileParameter	Pdfdictionary containing fil parameters
afRelationshipValue	AFRelationship key value,

AFRelationshipValue. If

 null, @see AFRelationshipValue.Unspecified will be added. 
       

          
       

         PdfFileSpec containing the file specification of the file as Pdfobject 
       

CreateEmbeddedFileSpec() [4/11]

static iText.Kernel.Pdf.Filespec.PdfFileSpec iText.Kernel.Pdf.Filespec.PdfFileSpec.CreateEmbeddedFileSpec ( PdfDocument  doc, byte[]  fileStore, String  fileDisplay, PdfDictionary  fileParameter, PdfName  afRelationshipValue  )

inlinestatic

Embed a file to a PdfDocument.

Parameters

doc	PdfDocument to add the file to
fileStore	byte[] containing the file
fileDisplay	actual file name stored in the pdf
fileParameter	Pdfdictionary containing fil parameters
afRelationshipValue	AFRelationship key value,

AFRelationshipValue. If

 null, @see AFRelationshipValue.Unspecified will be added. 
       

          
       

         PdfFileSpec containing the file specification of the file as Pdfobject 
       

CreateEmbeddedFileSpec() [5/11]

static iText.Kernel.Pdf.Filespec.PdfFileSpec iText.Kernel.Pdf.Filespec.PdfFileSpec.CreateEmbeddedFileSpec ( PdfDocument  doc, byte[]  fileStore, String  fileDisplay, PdfName  afRelationshipValue  )

inlinestatic

Embed a file to a PdfDocument.

Parameters

doc	PdfDocument to add the file to
fileStore	byte[] containing the file
fileDisplay	actual file name stored in the pdf
afRelationshipValue	AFRelationship key value,

AFRelationshipValue. If

 null, @see AFRelationshipValue.Unspecified will be added. 
       

          
       

         PdfFileSpec containing the file specification of the file as Pdfobject 
       

CreateEmbeddedFileSpec() [6/11]

static iText.Kernel.Pdf.Filespec.PdfFileSpec iText.Kernel.Pdf.Filespec.PdfFileSpec.CreateEmbeddedFileSpec ( PdfDocument  doc, Stream @  is, String  description, String  fileDisplay, PdfName  mimeType, PdfDictionary  fileParameter, PdfName  afRelationshipValue  )

inlinestatic

Embed a file to a PdfDocument.

Parameters

doc	Parameters is Parameters description Parameters fileDisplay Parameters mimeType Parameters fileParameter Parameters afRelationshipValue

CreateEmbeddedFileSpec() [7/11]

static iText.Kernel.Pdf.Filespec.PdfFileSpec iText.Kernel.Pdf.Filespec.PdfFileSpec.CreateEmbeddedFileSpec ( PdfDocument  doc, Stream @  is, String  description, String  fileDisplay, PdfName  mimeType, PdfName  afRelationshipValue  )

inlinestatic

Embed a file to a PdfDocument.

Parameters

doc	Parameters is Parameters description Parameters fileDisplay Parameters mimeType Parameters afRelationshipValue

CreateEmbeddedFileSpec() [8/11]

static iText.Kernel.Pdf.Filespec.PdfFileSpec iText.Kernel.Pdf.Filespec.PdfFileSpec.CreateEmbeddedFileSpec ( PdfDocument  doc, String  filePath, String  description, String  fileDisplay, PdfName  afRelationshipValue  )

inlinestatic

Embed a file to a PdfDocument.

Parameters

doc	Parameters filePath Parameters description Parameters fileDisplay Parameters afRelationshipValue Exceptions System.IO.IOException

CreateEmbeddedFileSpec() [9/11]

static iText.Kernel.Pdf.Filespec.PdfFileSpec iText.Kernel.Pdf.Filespec.PdfFileSpec.CreateEmbeddedFileSpec ( PdfDocument  doc, String  filePath, String  description, String  fileDisplay, PdfName  mimeType, PdfDictionary  fileParameter, PdfName  afRelationshipValue  )

inlinestatic

Embed a file to a PdfDocument.

Parameters

doc	Parameters filePath Parameters description Parameters fileDisplay Parameters mimeType Parameters fileParameter Parameters afRelationshipValue Exceptions System.IO.IOException

CreateEmbeddedFileSpec() [10/11]

static iText.Kernel.Pdf.Filespec.PdfFileSpec iText.Kernel.Pdf.Filespec.PdfFileSpec.CreateEmbeddedFileSpec ( PdfDocument  doc, String  filePath, String  description, String  fileDisplay, PdfName  mimeType, PdfName  afRelationshipValue  )

inlinestatic

Embed a file to a PdfDocument.

Parameters

doc	Parameters filePath Parameters description Parameters fileDisplay Parameters mimeType Parameters afRelationshipValue Exceptions System.IO.IOException

CreateEmbeddedFileSpec() [11/11]

static iText.Kernel.Pdf.Filespec.PdfFileSpec iText.Kernel.Pdf.Filespec.PdfFileSpec.CreateEmbeddedFileSpec ( PdfDocument  doc, String  filePath, String  fileDisplay, PdfName  afRelationshipValue  )

inlinestatic

Embed a file to a PdfDocument.

Parameters

doc	Parameters filePath Parameters fileDisplay Parameters afRelationshipValue Exceptions System.IO.IOException

GetThumbnailImage()

virtual PdfImageXObject iText.Kernel.Pdf.Filespec.PdfFileSpec.GetThumbnailImage ( )

inlinevirtual

PDF 2.0.

PDF 2.0. Gets a stream object defining the thumbnail image for the file specification.

Returns

image used as a thumbnail, or

 null 
         

if it is not set

SetThumbnailImage()

virtual iText.Kernel.Pdf.Filespec.PdfFileSpec iText.Kernel.Pdf.Filespec.PdfFileSpec.SetThumbnailImage ( PdfImageXObject  thumbnailImage )

inlinevirtual

PDF 2.0.

PDF 2.0. Sets a stream object defining the thumbnail image for the file specification.

Parameters

thumbnailImage

image used as a thumbnail

Returns

this PdfFileSpec instance