PdfFileAttachmentAnnotation Class

Namespace:
GemBox.Pdf.Annotations
Assembly:
GemBox.Pdf.dll

A file attachment annotation (PDF 1.3) contains a reference to a file, which typically shall be embedded in the PDF file (see 7.11.4, "Embedded File Streams").

public sealed class PdfFileAttachmentAnnotation : PdfMarkupAnnotation
Public NotInheritable Class PdfFileAttachmentAnnotation
    Inherits PdfMarkupAnnotation
Inheritance:
System.Object
PdfFileAttachmentAnnotation

Properties

AnnotationType

Gets the FileAttachment value.

public override PdfAnnotationType AnnotationType { get; }
Public Overrides ReadOnly Property AnnotationType As PdfAnnotationType
Property Value
PdfAnnotationType

The FileAttachment value.

Overrides

Appearance

Gets the appearance settings for this PdfFileAttachmentAnnotation.

public PdfFileAttachmentAppearance Appearance { get; }
Public ReadOnly Property Appearance As PdfFileAttachmentAppearance
Property Value
PdfFileAttachmentAppearance

The appearance settings for this PdfFileAttachmentAnnotation.

Description

Gets or sets the description.

public string Description { get; set; }
Public Property Description As String
Property Value
System.String

The description.

File

(Required) The file associated with this annotation.

If this property returns null, then use the FilePath property because the associated file is specified as a file specification string.

public PdfFileSpecification File { get; }
Public ReadOnly Property File As PdfFileSpecification
Property Value
PdfFileSpecification

The file associated with this annotation.

See Also

FilePath

(Required) The path of the file associated with this annotation.

public string FilePath { get; set; }
Public Property FilePath As String
Property Value
System.String

The path of the file associated with this annotation.

Exceptions
System.ArgumentNullException

Value is null or System.String.Empty.

See Also

Methods

SetFile(String)

Sets the file associated with this annotation.

public PdfFileSpecification SetFile(string fileSpecificationName)
Public Function SetFile(fileSpecificationName As String) As PdfFileSpecification
Parameters
fileSpecificationName
System.String

The name of the file associated with this annotation.

Returns
PdfFileSpecification

A newly created PdfFileSpecification with the specified name associated with this annotation.

Exceptions
System.ArgumentNullException

fileSpecificationName is null or System.String.Empty.

See Also

Inherited Properties

AssociatedFiles

(Optional; PDF 2.0) An array of one or more PdfFileSpecifications which denote the associated files for this PdfAnnotation.

(Inherited from PdfAnnotation)

Author

(Optional; PDF 1.1) The text label that shall be displayed in the title bar of the annotation's pop-up window when open and active. This entry shall identify the user who added the annotation.

(Inherited from PdfMarkupAnnotation)

Bounds

(Required) The annotation bounds, defining the location and the size of the annotation on the page in default user space units.

(Inherited from PdfAnnotation)

InReplyTo

(Required if a ReplyType entry is present, otherwise optional; PDF 1.5) A reference to the PdfMarkupAnnotation that this PdfMarkupAnnotation is "in reply to". Both PdfMarkupAnnotations shall be on the same page of the document. The relationship between the two PdfMarkupAnnotations shall be specified by the ReplyType entry.

(Inherited from PdfMarkupAnnotation)

Intent

(Optional; PDF 1.6) A name describing the intent of the markup annotation. Intents allow conforming readers to distinguish between different uses and behaviors of a single markup annotation type.

PdfFreeTextAnnotations (Table 174), line annotations (Table 175), polygon annotations (Table 178), and (PDF 1.7) polyline annotations (Table 178) have defined intents.

(Inherited from PdfMarkupAnnotation)

Locked

(PDF 1.4) If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation's contents, such as the value of a form field.

(Inherited from PdfAnnotation)

Metadata

(Optional; PDF 1.4) A metadata stream containing metadata for the component.

(Inherited from PdfObject)

Page

Gets the page with which this annotation is associated.

(Inherited from PdfAnnotation)

ReplyType

(Optional; meaningful only if InReplyTo is present; PDF 1.6) A name specifying the relationship (the "reply type") between this PdfMarkupAnnotation and the one specified by the InReplyTo property.

Default value: Reply.

(Inherited from PdfMarkupAnnotation)

Subject

(Optional; PDF 1.5) Text representing a short description of the subject being addressed by the annotation.

(Inherited from PdfMarkupAnnotation)

Inherited Methods

SetBounds(System.Double, System.Double)

Sets the size of the Bounds.

(Inherited from PdfAnnotation)

SetBounds(System.Double, System.Double, System.Double, System.Double)

Sets the Bounds.

(Inherited from PdfAnnotation)

Extension Methods

Examples

See Also