Class PdfFileSpec

Namespace

iText.Kernel.Pdf.Filespec

Assembly

itext.kernel.dll

public class PdfFileSpec : PdfObjectWrapper<PdfObject>

Inheritance

object

PdfObjectWrapper<PdfObject>

PdfFileSpec

Derived

PdfDictionaryFS

PdfStringFS

Inherited Members

PdfObjectWrapper<PdfObject>.GetPdfObject()

PdfObjectWrapper<PdfObject>.MakeIndirect(PdfDocument, PdfIndirectReference)

PdfObjectWrapper<PdfObject>.MakeIndirect(PdfDocument)

PdfObjectWrapper<PdfObject>.SetModified()

PdfObjectWrapper<PdfObject>.Flush()

PdfObjectWrapper<PdfObject>.IsFlushed()

PdfObjectWrapper<PdfObject>.SetPdfObject(PdfObject)

PdfObjectWrapper<PdfObject>.SetForbidRelease()

PdfObjectWrapper<PdfObject>.UnsetForbidRelease()

PdfObjectWrapper<PdfObject>.EnsureUnderlyingObjectHasIndirectReference()

PdfObjectWrapper<PdfObject>.MarkObjectAsIndirect(PdfObject)

PdfObjectWrapper<PdfObject>.EnsureObjectIsAddedToDocument(PdfObject)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PdfFileSpec(PdfObject)

protected PdfFileSpec(PdfObject pdfObject)

Parameters

pdfObject PdfObject

Methods

CreateEmbeddedFileSpec(PdfDocument, byte[], string, string, PdfDictionary, PdfName)

Create an embedded file specification.

public static PdfFileSpec CreateEmbeddedFileSpec(PdfDocument doc, byte[] fileStore, string description, string fileDisplay, PdfDictionary fileParameter, PdfName afRelationshipValue)

Parameters

doc PdfDocument

PdfDocument instance to make this file specification indirect

fileStore byte[]

byte[] containing the file

description string

the file description

fileDisplay string

actual file name stored in the pdf

fileParameter PdfDictionary

PdfDictionary containing fil parameters

afRelationshipValue PdfName

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, Unspecified will be added.

Returns

PdfFileSpec

PdfFileSpec containing the file specification of the file

CreateEmbeddedFileSpec(PdfDocument, byte[], string, string, PdfName)

Create an embedded file specification.

public static PdfFileSpec CreateEmbeddedFileSpec(PdfDocument doc, byte[] fileStore, string description, string fileDisplay, PdfName afRelationshipValue)

Parameters

doc PdfDocument

PdfDocument instance to make this file specification indirect

fileStore byte[]

byte[] containing the file

description string

file description

fileDisplay string

actual file name stored in the pdf

afRelationshipValue PdfName

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, Unspecified will be added.

Returns

PdfFileSpec

PdfFileSpec containing the file specification of the file

CreateEmbeddedFileSpec(PdfDocument, byte[], string, string, PdfName, PdfDictionary, PdfName)

Create an embedded file specification.

public static PdfFileSpec CreateEmbeddedFileSpec(PdfDocument doc, byte[] fileStore, string description, string fileDisplay, PdfName mimeType, PdfDictionary fileParameter, PdfName afRelationshipValue)

Parameters

doc PdfDocument

PdfDocument instance to make this file specification indirect

fileStore byte[]

byte[] containing the file

description string

file description

fileDisplay string

actual file name stored in the pdf

mimeType PdfName

subtype of the embedded file. The value of this entry shall conform to the MIME media type names

fileParameter PdfDictionary

PdfDictionary containing fil parameters

afRelationshipValue PdfName

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, Unspecified will be added.

Returns

PdfFileSpec

PdfFileSpec containing the file specification of the file

CreateEmbeddedFileSpec(PdfDocument, byte[], string, PdfDictionary, PdfName)

Create an embedded file specification.

public static PdfFileSpec CreateEmbeddedFileSpec(PdfDocument doc, byte[] fileStore, string fileDisplay, PdfDictionary fileParameter, PdfName afRelationshipValue)

Parameters

doc PdfDocument

PdfDocument instance to make this file specification indirect

fileStore byte[]

byte[] containing the file

fileDisplay string

actual file name stored in the pdf

fileParameter PdfDictionary

PdfDictionary containing fil parameters

afRelationshipValue PdfName

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, Unspecified will be added.

Returns

PdfFileSpec

PdfFileSpec containing the file specification of the file

CreateEmbeddedFileSpec(PdfDocument, byte[], string, PdfName)

Create an embedded file specification.

public static PdfFileSpec CreateEmbeddedFileSpec(PdfDocument doc, byte[] fileStore, string fileDisplay, PdfName afRelationshipValue)

Parameters

doc PdfDocument

PdfDocument instance to make this file specification indirect

fileStore byte[]

byte[] containing the file

fileDisplay string

actual file name stored in the pdf

afRelationshipValue PdfName

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, Unspecified will be added.

Returns

PdfFileSpec

PdfFileSpec containing the file specification of the file

CreateEmbeddedFileSpec(PdfDocument, Stream, string, string, PdfName, PdfDictionary, PdfName)

Create an embedded file specification.

public static PdfFileSpec CreateEmbeddedFileSpec(PdfDocument doc, Stream @is, string description, string fileDisplay, PdfName mimeType, PdfDictionary fileParameter, PdfName afRelationshipValue)

Parameters

doc PdfDocument

PdfDocument instance to make this file specification indirect

is Stream

stream containing the file to embed

description string

file description

fileDisplay string

actual file name stored in the pdf

mimeType PdfName

subtype of the embedded file. The value of this entry shall conform to the MIME media type names

fileParameter PdfDictionary

dictionary with file parameters

afRelationshipValue PdfName

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, Unspecified will be added.

Returns

PdfFileSpec

PdfFileSpec containing the file specification of the file

CreateEmbeddedFileSpec(PdfDocument, Stream, string, string, PdfName, PdfName)

Create an embedded file specification.

public static PdfFileSpec CreateEmbeddedFileSpec(PdfDocument doc, Stream @is, string description, string fileDisplay, PdfName mimeType, PdfName afRelationshipValue)

Parameters

doc PdfDocument

PdfDocument instance to make this file specification indirect

is Stream

stream containing the file to embed

description string

file description

fileDisplay string

actual file name stored in the pdf

mimeType PdfName

subtype of the embedded file. The value of this entry shall conform to the MIME media type names

afRelationshipValue PdfName

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, Unspecified will be added.

Returns

PdfFileSpec

PdfFileSpec containing the file specification of the file

CreateEmbeddedFileSpec(PdfDocument, string, string, string, PdfName)

Create an embedded file specification.

public static PdfFileSpec CreateEmbeddedFileSpec(PdfDocument doc, string filePath, string description, string fileDisplay, PdfName afRelationshipValue)

Parameters

doc PdfDocument

PdfDocument instance to make this file specification indirect

filePath string

file specification string, describing the path to the file to embed

description string

file description

fileDisplay string

actual file name stored in the pdf

afRelationshipValue PdfName

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, Unspecified will be added.

Returns

PdfFileSpec

PdfFileSpec containing the file specification of the file

CreateEmbeddedFileSpec(PdfDocument, string, string, string, PdfName, PdfDictionary, PdfName)

Create an embedded file specification.

public static PdfFileSpec CreateEmbeddedFileSpec(PdfDocument doc, string filePath, string description, string fileDisplay, PdfName mimeType, PdfDictionary fileParameter, PdfName afRelationshipValue)

Parameters

doc PdfDocument

PdfDocument instance to make this file specification indirect

filePath string

file specification string, describing the path to the file to embed

description string

file description

fileDisplay string

actual file name stored in the pdf

mimeType PdfName

subtype of the embedded file. The value of this entry shall conform to the MIME media type names

fileParameter PdfDictionary

dictionary with file parameters

afRelationshipValue PdfName

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, Unspecified will be added.

Returns

PdfFileSpec

PdfFileSpec containing the file specification of the file

CreateEmbeddedFileSpec(PdfDocument, string, string, string, PdfName, PdfName)

Create an embedded file specification.

public static PdfFileSpec CreateEmbeddedFileSpec(PdfDocument doc, string filePath, string description, string fileDisplay, PdfName mimeType, PdfName afRelationshipValue)

Parameters

doc PdfDocument

PdfDocument instance to make this file specification indirect

filePath string

file specification string, describing the path to the file to embed

description string

file description

fileDisplay string

actual file name stored in the pdf

mimeType PdfName

subtype of the embedded file. The value of this entry shall conform to the MIME media type names

afRelationshipValue PdfName

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, Unspecified will be added.

Returns

PdfFileSpec

PdfFileSpec containing the file specification of the file

CreateEmbeddedFileSpec(PdfDocument, string, string, PdfName)

Create an embedded file specification.

public static PdfFileSpec CreateEmbeddedFileSpec(PdfDocument doc, string filePath, string fileDisplay, PdfName afRelationshipValue)

Parameters

doc PdfDocument

PdfDocument instance to make this file specification indirect

filePath string

path to the file to embed

fileDisplay string

actual file name stored in the pdf

afRelationshipValue PdfName

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, Unspecified will be added.

Returns

PdfFileSpec

PdfFileSpec containing the file specification of the file

CreateExternalFileSpec(PdfDocument, string)

Create an external file specification.

public static PdfFileSpec CreateExternalFileSpec(PdfDocument doc, string filePath)

Parameters

doc PdfDocument

PdfDocument instance to make this file specification indirect

filePath string

file specification string, describing the path to the external file

Returns

PdfFileSpec

PdfFileSpec containing the file specification of the file

CreateExternalFileSpec(PdfDocument, string, PdfName)

Create an external file specification.

public static PdfFileSpec CreateExternalFileSpec(PdfDocument doc, string filePath, PdfName afRelationshipValue)

Parameters

doc PdfDocument

PdfDocument instance to make this file specification indirect

filePath string

file specification string, describing the path to the external file

afRelationshipValue PdfName

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, Unspecified will be added.

Returns

PdfFileSpec

PdfFileSpec containing the file specification of the file

GetFileIdentifier()

public virtual PdfArray GetFileIdentifier()

Returns

PdfArray

GetThumbnailImage()

PDF 2.0.

public virtual PdfImageXObject GetThumbnailImage()

Returns

PdfImageXObject

image used as a thumbnail, or null if it is not set

Remarks

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

IsVolatile()

public virtual PdfBoolean IsVolatile()

Returns

PdfBoolean

IsWrappedObjectMustBeIndirect()

protected override bool IsWrappedObjectMustBeIndirect()

Returns

bool

Put(PdfName, PdfObject)

public virtual PdfFileSpec Put(PdfName key, PdfObject value)

Parameters

key PdfName

value PdfObject

Returns

PdfFileSpec

SetCollectionItem(PdfCollectionItem)

public virtual PdfFileSpec SetCollectionItem(PdfCollectionItem item)

Parameters

item PdfCollectionItem

Returns

PdfFileSpec

SetFileIdentifier(PdfArray)

public virtual PdfFileSpec SetFileIdentifier(PdfArray fileIdentifier)

Parameters

fileIdentifier PdfArray

Returns

PdfFileSpec

SetThumbnailImage(PdfImageXObject)

PDF 2.0.

public virtual PdfFileSpec SetThumbnailImage(PdfImageXObject thumbnailImage)

Parameters

thumbnailImage PdfImageXObject

image used as a thumbnail

Returns

PdfFileSpec

this PdfFileSpec instance

Remarks

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

SetVolatile(PdfBoolean)

public virtual PdfFileSpec SetVolatile(PdfBoolean isVolatile)

Parameters

isVolatile PdfBoolean

Returns

PdfFileSpec

WrapFileSpecObject(PdfObject)

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

public static PdfFileSpec WrapFileSpecObject(PdfObject fileSpecObject)

Parameters

fileSpecObject PdfObject

object to wrap

Returns

PdfFileSpec

wrapped PdfFileSpec instance