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)
	Wrap the passed iText.Kernel.Pdf.PdfObject to the specific PdfFileSpec object, according to the type of the passed pdf object. More...

static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateExternalFileSpec (PdfDocument doc, String filePath, PdfName afRelationshipValue)
	Create an external file specification. More...

static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateExternalFileSpec (PdfDocument doc, String filePath)
	Create an external file specification. More...

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

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

static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, byte[] fileStore, String fileDisplay, PdfDictionary fileParameter, PdfName afRelationshipValue)
	Create an embedded file specification. More...

static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, byte[] fileStore, String fileDisplay, PdfName afRelationshipValue)
	Create an embedded file specification. More...

static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, byte[] fileStore, String description, String fileDisplay, PdfName afRelationshipValue)
	Create an embedded file specification. More...

static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, String filePath, String description, String fileDisplay, PdfName mimeType, PdfDictionary fileParameter, PdfName afRelationshipValue)
	Create an embedded file specification. More...

static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, String filePath, String description, String fileDisplay, PdfName mimeType, PdfName afRelationshipValue)
	Create an embedded file specification. More...

static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, String filePath, String description, String fileDisplay, PdfName afRelationshipValue)
	Create an embedded file specification. More...

static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, String filePath, String fileDisplay, PdfName afRelationshipValue)
	Create an embedded file specification. More...

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

static iText.Kernel.Pdf.Filespec.PdfFileSpec	CreateEmbeddedFileSpec (PdfDocument doc, Stream @is, String description, String fileDisplay, PdfName mimeType, PdfName afRelationshipValue)
	Create an embedded file specification. More...

Package Functions
	PdfFileSpec (PdfObject pdfObject)

override bool	IsWrappedObjectMustBeIndirect ()
	Defines if the object behind this wrapper must be an indirect object in the resultant document. More...

Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfObject >
	PdfObjectWrapper (T pdfObject)

virtual void	SetPdfObject (T pdfObject)

virtual void	SetForbidRelease ()

virtual void	UnsetForbidRelease ()

virtual void	EnsureUnderlyingObjectHasIndirectReference ()

Additional Inherited Members
Static Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfObject >
static void	MarkObjectAsIndirect (PdfObject pdfObject)

static void	EnsureObjectIsAddedToDocument (PdfObject @object)
	Some wrappers use object's indirect reference to obtain the `PdfDocument` to which the object belongs to. 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

Create an embedded file specification.

Parameters

doc

iText.Kernel.Pdf.PdfDocument instance to make this file specification indirect

Parameters

fileStore	byte[] containing the file
fileDisplay	actual file name stored in the pdf
fileParameter

iText.Kernel.Pdf.PdfDictionary containing fil parameters

Parameters

afRelationshipValue	value that represents the relationship between the component of the passed PDF document that refers to this file specification and the associated file. If `null`, iText.Kernel.Pdf.PdfName.Unspecified will be added.
description	the file description

Returns

PdfFileSpec containing the file specification of the file

◆ 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

Create an embedded file specification.

Parameters

doc

iText.Kernel.Pdf.PdfDocument instance to make this file specification indirect

Parameters

fileStore	byte[] containing the file
description	file description
fileDisplay	actual file name stored in the pdf
afRelationshipValue	value that represents the relationship between the component of the passed PDF document that refers to this file specification and the associated file. If `null`, iText.Kernel.Pdf.PdfName.Unspecified will be added.

Returns

PdfFileSpec containing the file specification of the file

◆ 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

Create an embedded file specification.

Parameters

doc

iText.Kernel.Pdf.PdfDocument instance to make this file specification indirect

Parameters

fileStore	byte[] containing the file
description	file description
fileDisplay	actual file name stored in the pdf
mimeType	subtype of the embedded file. The value of this entry shall conform to the MIME media type names
fileParameter

iText.Kernel.Pdf.PdfDictionary containing fil parameters

Parameters

afRelationshipValue value that represents the relationship between the component of the passed PDF document that refers to this file specification and the associated file. If null, iText.Kernel.Pdf.PdfName.Unspecified will be added.

Returns

PdfFileSpec containing the file specification of the file

◆ 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

Create an embedded file specification.

Parameters

doc

iText.Kernel.Pdf.PdfDocument instance to make this file specification indirect

Parameters

fileStore	byte[] containing the file
fileDisplay	actual file name stored in the pdf
fileParameter

iText.Kernel.Pdf.PdfDictionary containing fil parameters

Parameters

afRelationshipValue value that represents the relationship between the component of the passed PDF document that refers to this file specification and the associated file. If null, iText.Kernel.Pdf.PdfName.Unspecified will be added.

Returns

PdfFileSpec containing the file specification of the file

◆ CreateEmbeddedFileSpec() [5/11]

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

inlinestatic

Create an embedded file specification.

Parameters

doc

iText.Kernel.Pdf.PdfDocument instance to make this file specification indirect

Parameters

fileStore	byte[] containing the file
fileDisplay	actual file name stored in the pdf
afRelationshipValue	value that represents the relationship between the component of the passed PDF document that refers to this file specification and the associated file. If `null`, iText.Kernel.Pdf.PdfName.Unspecified will be added.

Returns

PdfFileSpec containing the file specification of the file

◆ 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

Create an embedded file specification.

Parameters

doc

iText.Kernel.Pdf.PdfDocument instance to make this file specification indirect

Parameters

is	stream containing the file to embed
description	file description
fileDisplay	actual file name stored in the pdf
mimeType	subtype of the embedded file. The value of this entry shall conform to the MIME media type names
fileParameter	dictionary with file parameters
afRelationshipValue	value that represents the relationship between the component of the passed PDF document that refers to this file specification and the associated file. If `null`, iText.Kernel.Pdf.PdfName.Unspecified will be added.

Returns

PdfFileSpec containing the file specification of the file

◆ 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

Create an embedded file specification.

Parameters

doc

iText.Kernel.Pdf.PdfDocument instance to make this file specification indirect

Parameters

is	stream containing the file to embed
description	file description
fileDisplay	actual file name stored in the pdf
mimeType	subtype of the embedded file. The value of this entry shall conform to the MIME media type names
afRelationshipValue	value that represents the relationship between the component of the passed PDF document that refers to this file specification and the associated file. If `null`, iText.Kernel.Pdf.PdfName.Unspecified will be added.

Returns

PdfFileSpec containing the file specification of the file

◆ 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

Create an embedded file specification.

Parameters

doc

iText.Kernel.Pdf.PdfDocument instance to make this file specification indirect

Parameters

filePath	file specification string, describing the path to the file to embed
description	file description
fileDisplay	actual file name stored in the pdf
afRelationshipValue	value that represents the relationship between the component of the passed PDF document that refers to this file specification and the associated file. If `null`, iText.Kernel.Pdf.PdfName.Unspecified will be added.

Returns

PdfFileSpec containing the file specification of the file

◆ 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

Create an embedded file specification.

Parameters

doc

iText.Kernel.Pdf.PdfDocument instance to make this file specification indirect

Parameters

filePath	file specification string, describing the path to the file to embed
description	file description
fileDisplay	actual file name stored in the pdf
mimeType	subtype of the embedded file. The value of this entry shall conform to the MIME media type names
fileParameter	dictionary with file parameters
afRelationshipValue	value that represents the relationship between the component of the passed PDF document that refers to this file specification and the associated file. If `null`, iText.Kernel.Pdf.PdfName.Unspecified will be added.

Returns

PdfFileSpec containing the file specification of the file

◆ 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

Create an embedded file specification.

Parameters

doc

iText.Kernel.Pdf.PdfDocument instance to make this file specification indirect

Parameters

filePath	file specification string, describing the path to the file to embed
description	file description
fileDisplay	actual file name stored in the pdf
mimeType	subtype of the embedded file. The value of this entry shall conform to the MIME media type names
afRelationshipValue	value that represents the relationship between the component of the passed PDF document that refers to this file specification and the associated file. If `null`, iText.Kernel.Pdf.PdfName.Unspecified will be added.

Returns

PdfFileSpec containing the file specification of the file

◆ CreateEmbeddedFileSpec() [11/11]

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

inlinestatic

Create an embedded file specification.

Parameters

doc

iText.Kernel.Pdf.PdfDocument instance to make this file specification indirect

Parameters

filePath	path to the file to embed
fileDisplay	actual file name stored in the pdf
afRelationshipValue	value that represents the relationship between the component of the passed PDF document that refers to this file specification and the associated file. If `null`, iText.Kernel.Pdf.PdfName.Unspecified will be added.

Returns

PdfFileSpec containing the file specification of the file

◆ CreateExternalFileSpec() [1/2]

static iText.Kernel.Pdf.Filespec.PdfFileSpec iText.Kernel.Pdf.Filespec.PdfFileSpec.CreateExternalFileSpec	(	PdfDocument	doc,
		String	filePath
	)

inlinestatic

Create an external file specification.

Parameters

doc

iText.Kernel.Pdf.PdfDocument instance to make this file specification indirect

Parameters

filePath file specification string, describing the path to the external file

Returns

PdfFileSpec containing the file specification of the file

◆ CreateExternalFileSpec() [2/2]

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

inlinestatic

Create an external file specification.

Parameters

doc

iText.Kernel.Pdf.PdfDocument instance to make this file specification indirect

Parameters

filePath	file specification string, describing the path to the external file
afRelationshipValue	value that represents the relationship between the component of the passed PDF document that refers to this file specification and the associated file. If `null`, iText.Kernel.Pdf.PdfName.Unspecified will be added.

Returns

PdfFileSpec containing the file specification of the file

◆ 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

◆ IsWrappedObjectMustBeIndirect()

override bool iText.Kernel.Pdf.Filespec.PdfFileSpec.IsWrappedObjectMustBeIndirect ( )

inlinepackagevirtual

Defines if the object behind this wrapper must be an indirect object in the resultant document.

Defines if the object behind this wrapper must be an indirect object in the resultant document.

If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

Return value of this method shouldn't depend on any logic, it should return always true or false.

Returns: true if in the resultant document the object behind the wrapper must be indirect, otherwise false.

Implements iText.Kernel.Pdf.PdfObjectWrapper< PdfObject >.

Reimplemented in iText.Kernel.Pdf.Filespec.PdfStringFS.

◆ 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

◆ WrapFileSpecObject()

static iText.Kernel.Pdf.Filespec.PdfFileSpec iText.Kernel.Pdf.Filespec.PdfFileSpec.WrapFileSpecObject ( PdfObject fileSpecObject )

inlinestatic

Wrap the passed iText.Kernel.Pdf.PdfObject to the specific PdfFileSpec object, according to the type of the passed pdf object.

Parameters

fileSpecObject object to wrap

Returns: wrapped PdfFileSpec instance

Public Member Functions

Static Public Member Functions

Package Functions

Additional Inherited Members

Member Function Documentation

◆ CreateEmbeddedFileSpec() [1/11]

◆ CreateEmbeddedFileSpec() [2/11]

◆ CreateEmbeddedFileSpec() [3/11]

◆ CreateEmbeddedFileSpec() [4/11]

◆ CreateEmbeddedFileSpec() [5/11]

◆ CreateEmbeddedFileSpec() [6/11]

◆ CreateEmbeddedFileSpec() [7/11]

◆ CreateEmbeddedFileSpec() [8/11]

◆ CreateEmbeddedFileSpec() [9/11]

◆ CreateEmbeddedFileSpec() [10/11]

◆ CreateEmbeddedFileSpec() [11/11]

◆ CreateExternalFileSpec() [1/2]

◆ CreateExternalFileSpec() [2/2]

◆ GetThumbnailImage()

◆ IsWrappedObjectMustBeIndirect()

◆ SetThumbnailImage()

◆ WrapFileSpecObject()