AddSWFAnnotationFromFile

Vector graphics, Image handling, Annotations and hotspot links, Page layout

Description

Adds a Flash SWF file as a screen annotation to the current page and wires it to a rendition action.

PDF version behaviour: this API writes the legacy PDF 1.5 multimedia model: a /Subtype /Screen annotation, a /S /Rendition action, media clip dictionaries, and an embedded file specification. If the current document version is lower and the save version is not locked, AddSWFAnnotationFromFile automatically raises the document to PDF 1.5 and records Screen/Rendition multimedia in AutoBumpedFeatures. It does not declare Adobe RichMedia extensions because it does not emit a /Subtype /RichMedia annotation. PDF/A modes reject this content before writing.

Syntax

Delphi

function TPDFlib.AddSWFAnnotationFromFile(Left, Top, Width, Height: Double; Const FileName, Title: WideString; Options: Integer): Integer;

ActiveX

Function PDFlib::AddSWFAnnotationFromFile(Left As Double, Top As Double, Width As Double, Height As Double, FileName As String, Title As String, Options As Long) As Long

DLL

int DLAddSWFAnnotationFromFile(int InstanceID, double Left, double Top, double Width, double Height, wchar_t * FileName, wchar_t * Title, int Options);

Parameters

LeftThe horizontal co-ordinate of the left edge of the annotation rectangle
TopThe vertical co-ordinate of the top edge of the annotation rectangle
WidthThe width of the annotation rectangle
HeightThe height of the annotation rectangle.
FileNameThe path and name of the SWF file.
TitleThe annotation title
OptionsAnnotation event to activate SWF: 0 = Page visible 1 = Mouse enter 2 = Mouse button click

Return values

0The specified file could not be found
1The SWF was successfully added as an annotation