FileAttachment Class Documentation

classFileAttachment : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:
SystemIDisposable

Detailed Description

A file attachment. Any file can be attached to the PDF document.

The class allows to create attachment and manipulate by its content.

Referenced by

DocumentFileAttachment

Constructor & Destructor Documentation

FileAttachment

FileAttachment(FileAttachmentrhs, InternalConstructsignifier)

Parameters

rhs: FileAttachment
signifier: InternalConstruct

FileAttachment

FileAttachment(Documentdoc, stringfileName)

Parameters

doc: Document

The PDF document (reference).

fileName: string

The path to file which will be attached to the document.

Allows to add attachment into the PDF document.

FileAttachment

FileAttachment(Documentdoc, stringfileName, stringkeyName)

Parameters

doc: Document

The PDF document (reference).

fileName: string

The path to file which will be attached to the document.

keyName: string

The name of the key.

Allows to add attachment into the PDF document using the specified key name.

~FileAttachment

~FileAttachment()

Property Documentation

AFRelationship

AFRelationshipAFRelationship[get, set]

FileName

stringFileName[get]

FileSize

uintFileSize[get]

Member Function Documentation

ConstructorRetrieve

static FileAttachmentConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

FileAttachment

Dispose

voidDispose()

Returns:

void

DisposeChildren

voidDisposeChildren()

Returns:

void

GetCollectionItemNumber

floatGetCollectionItemNumber(CollectionSchemaFieldcollectionField)

Parameters

collectionField: CollectionSchemaField

the field for which item value should be retrieved.

Returns:

collection items value

GetCollectionItemNumber allows to obtain collection item according to the specified schema field.

GetCollectionItemString

stringGetCollectionItemString(CollectionSchemaFieldcollectionField)

Parameters

collectionField: CollectionSchemaField

the field for which item value should be retrieved.

Returns:

collection items value

GetCollectionItemString allows to obtain collection item value according to the specified schema field.

SaveAttachmentToStreamInternal

voidSaveAttachmentToStreamInternal(CDotNetStreamFiledest)

Parameters

dest: CDotNetStreamFile

Returns:

void

SaveToFile

voidSaveToFile(stringfileName)

Parameters

fileName: string

The path where attachment will be saved.

Returns:

void

Allows to save attachment to the specified file.

SaveToStream

voidSaveToStream(System.IO.Streamstream)

Parameters

stream: System.IO.Stream

The Stream to which the FileAttachment is saved.

Returns:

void

Saves a FileAttachment to a Stream.

SetCollectionItemNumber

voidSetCollectionItemNumber(CollectionSchemaFieldcollectionField, floatvalue)

Parameters

collectionField: CollectionSchemaField

schema field which contains information about data type. The parameter's subtype should be a Number.

value: float

the item's value.

Returns:

void

SetCollectionItemNumber allows to add key to the collection item dictionary.

SetCollectionItemString

voidSetCollectionItemString(CollectionSchemaFieldcollectionField, stringvalue)

Parameters

collectionField: CollectionSchemaField

schema field which contains information about data type. The parameter's subtype should be a Text.

value: string

the item's value.

Returns:

void

SetCollectionItemString allows to add key to the collection item dictionary.

UpdateFromFile

voidUpdateFromFile(stringfileName)

Parameters

fileName: string

The path to the file from which attachment will be updated.

Returns:

void

Allows to update attachment from another file.