FileAttachment Class

A file attachment annotation (PDF 1.3) contains a reference to a file, which typically shall be embedded in the PDF file.

Inheritance Hierarchy

SystemObject
pdftron.PDF.AnnotsFileAttachment

Namespace: pdftron.PDF.Annots
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255

Syntax

C++

JavaScript

Copy

public sealed class FileAttachment : IClosable, 
	IAnnot, IMarkup

Public NotInheritable Class FileAttachment
	Implements IClosable, IAnnot, IMarkup

public ref class FileAttachment sealed : IClosable, 
	IAnnot, IMarkup

pdftron.PDF.Annots.FileAttachment = function();

Type.createClass(
	'pdftron.PDF.Annots.FileAttachment',
	null,
	Windows.Foundation.IClosable,
	pdftron.PDF.IAnnot,
	pdftron.PDF.Annots.IMarkup);

The FileAttachment type exposes the following members.

Constructors

	Name	Description
	FileAttachment	Creates an FileAttachment annotation and initialize it using given Cos/SDF object.

Top

Methods

	Name	Description
	Close
	Create(SDFDoc, Rect, String)	Creates a file attachment annotation. A file attachment annotation contains a reference to a file, which typically is embedded in the PDF file.
	Create(SDFDoc, Rect, String, String)	Creates a file attachment annotation. A file attachment annotation contains a reference to a file, which typically is embedded in the PDF file.
	DeleteCustomData	Deletes custom data associated with the given key.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Export	The function saves the data referenced by this File Attachment to an external file. If the file is embedded, the function saves the embedded file. If the file is not embedded, the function will copy the external file. If the file is not embedded and the external file can't be found, the function returns false.
	Export(String)	The function saves the data referenced by this File Attachment to an external file. If the file is embedded, the function saves the embedded file. If the file is not embedded, the function will copy the external file. If the file is not embedded and the external file can't be found, the function returns false.
	Flatten	Flatten/Merge the existing annotation appearances with the page content and delete this annotation from a given page. Annotation 'flattening' refers to the operation that changes active annotations (such as markup, widgets, 3D models, etc.) into a static area that is part of the PDF document, just like the other text and images in the document.
	GetAnnotType	Gets the type.
	GetAppearance	Gets the annotation’s appearance for the given combination of annotation and appearance states.
	GetAppearance(AnnotAnnotationState)	Gets the annotation’s appearance for the given combination of annotation and appearance states.
	GetAppearance(AnnotAnnotationState, String)	Gets the annotation’s appearance for the given combination of annotation and appearance states.
	GetBorderEffect	Gets the Border Effect of the Markup Annotation.
	GetBorderEffectIntensity	Sets the Border Effect of the Markup Annotation. (Optional; PDF 1.5 )
	GetBorderStyle	Gets the border style for the annotation. Typically used for Link annotations.
	GetColorAsCMYK	Gets an annotation's color.
	GetColorAsGray	Gets an annotation's color.
	GetColorAsRGB	Gets the annotation’s active appearance state.
	GetColorCompNum	Gets the color space the annotation's color is represented in.
	GetContentRect	Gets the inner bounding rectangle of the Square. (Optional; PDF 1.5)
	GetContents	Gets the contents.
	GetCreationDates	Gets the creation date of the Markup Annotation
	GetCustomData	Returns custom data associated with the given key.
	GetDate	Gets an annotation's last modified date.
	GetFileSpec	Gets the file specification.
	GetFlag	Gets the flag.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetIcon	Gets the icon type as an entry of the enum "Icon".
	GetIconName	Gets the icon type as a string.
	GetInteriorColor	Sets the interior color of the Square. (Optional; PDF 1.4 )
	GetInteriorColorCompNum	Gets the number indicating interior color space of the Square.
	GetOpacity	Gets the contant opacity value corresponding to the annotation.
	GetOptionalContent	Gets optional content of an annotation.
	GetPadding	Gets the rectangle difference of the Square. (Optional; PDF 1.5)
	GetPage	Gets the page the annotation is associated with.
	GetPopup	Gets the Popup object associated with this Markup annotation.
	GetRect	Gets the rect.
	GetRotation	Gets the rotation value of the annotation.The Rotation specifies the number of degrees by which the annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90.
	GetSDFObj	Gets the SDFObj.
	GetStructParent	Gets the struct parent of an annotation. (Required if the annotation is a structural content item; PDF 1.3)
	GetSubject	Gets subject of the Markup Annotation.
	GetTitle	Gets the title of the Markup Annotation.
	GetTriggerAction	Get the Action associated with the selected Annot Trigger event
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUniqueID	Gets the unique ID.
	IsMarkup	Checks if is markup.
	IsValid	Checks if is valid.
	RefreshAppearance	Regenerates the appearance stream for the annotation. This method can be used to auto-generate the annotation appearance after creating or modifying the annotation without providing an explicit appearance or setting the "NeedAppearances" flag in the AcroForm dictionary.
	RefreshAppearance(RefreshOptions)	A version of RefreshAppearance allowing custom options to make slight tweaks in behaviour.
	RemoveAppearance	Removes the annotation's appearance
	RemoveAppearance(AnnotAnnotationState)	Removes the annotation's appearance for the given combination of annotation and appearance states.
	RemoveAppearance(AnnotAnnotationState, String)	Removes the annotation's appearance for the given combination of annotation and appearance states.
	Resize	Resize.
	SetAppearance(Obj)	Sets the annotation’s appearance for the given combination of annotation and appearance states. (Optional; PDF 1.2)
	SetAppearance(Obj, AnnotAnnotationState)	Removes the annotation's appearance for the given combination of annotation and appearance states.
	SetAppearance(Obj, AnnotAnnotationState, String)	Sets the annotation’s appearance for the given combination of annotation and appearance states. (Optional; PDF 1.2)
	SetBorderEffectIntensity	Sets the Border Effect Intensity of the Markup Annotation. (Optional; valid only if Border effect is Cloudy)
	SetBorderStyle	Sets the border style for the annotation. Typically used for Link annotations.
	SetColor(ColorPt)	Sets an annotation's color. (Optional; PDF 1.1)
	SetColor(ColorPt, Int32)	Sets an annotation's color. (Optional; PDF 1.1)
	SetContentRect	Sets the inner bounding rectangle of the Square. (Optional; PDF 1.5)
	SetContents	Sets the contents.
	SetCreationDates	Sets the creation date of the Markup Annotation. (Optional; PDF 1.5 )
	SetCustomData	Sets the custom data associated with the specified key.
	SetDate	Sets an annotation's last modified date.
	SetDateToNow	Sets an annotation's modification date and time to the current time. This corresponds to the value of the "M" field of annotation dictionary(PDF 1.1)
	SetFileSpec	Sets the file specification.
	SetFlag	Sets the value of given Flag.
	SetIcon	Sets the icon type using an entry of the enum "Icon". (Optional)
	SetIcon(FileAttachmentIcon)	Sets the icon type using an entry of the enum "Icon". (Optional)
	SetIconName	Sets the icon type using a string. (Optional)
	SetInteriorColor	Gets the interior color of the Square.
	SetOpacity	Sets the contant opacity value corresponding to the annotation. (Optional; PDF 1.4 )
	SetOptionalContent	Sets optional content of an annotation. (Optional, PDF1.5).
	SetPadding	Sets the rectangle difference of the Square. (Optional; PDF 1.5)
	SetPage	Sets the reference to a page the annotation is associated with. (Optional PDF 1.3; not used in FDF files)
	SetPopup	Sets the Popup object associated with this Markup annotation. (Optional; PDF 1.3 )
	SetRect	Sets the size and location of an annotation on its page.
	SetRotation	Sets the rotation value of the annotation.The Rotation specifies the number of degrees by which the annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90. (Optional)
	SetStructParent	Sets the struct parent of an annotation. (Required if the annotation is a structural content item; PDF 1.3)
	SetSubject	Sets subject of the Markup Annotation. (Optional; PDF 1.5 )
	SetTitle	Sets the title of the Markup Annotation. (Optional; PDF 1.1)
	SetUniqueID	Sets the unique identifier for this annotation.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

pdftron.PDF.Annots Namespace