Struct pdf_writer::writers::Annotation [−][src]
pub struct Annotation<'a> { /* fields omitted */ }
Expand description
Writer for an annotation dictionary.
This struct is created by Annotations::push
.
Implementations
Write the /Subtype
attribute to tell the viewer the type of this
particular annotation.
Write the /Rect
attribute. This is the location and dimensions of the
annotation on the page.
Write the /Contents
attribute. This is the content or alt-text,
depending on the AnnotationType
.
Write the /NM
attribute. This uniquely identifies the anotation on the
page. PDF 1.3+.
Write the /M
attribute, specifying the date the annotation was last
modified. PDF 1.1+.
Write the /F
attribute.
Write the /Border
attribute. This describes the look of the border
around the annotation, including width and horizontal and vertical
border radii. The function may also receive a dash pattern which
specifies the lengths and gaps of the border segments on a dashed
border. Although all PDF versions accept /Border
, this feature
specifically is only available in PDF 1.1 or later.
Start writing the /BS
attribute. These are some more elaborate border
settings taking precedence over /B
for some annotation types. PDF 1.2+.
Write the /C
attribute forcing a transparent color. This sets the
annotations background color and its popup title bar color. PDF 1.1+.
Write the /C
attribute using a grayscale color. This sets the
annotations background color and its popup title bar color. PDF 1.1+.
Write the /C
attribute using an RGB color. This sets the annotations
background color and its popup title bar color. PDF 1.1+.
Write the /C
attribute using a CMYK color. This sets the annotations
background color and its popup title bar color. PDF 1.1+.
Start writing the /A
dictionary. Only permissible for the subtype
Link
.
Write the /H
attribute to set what effect is used to convey that the
user is pressing a link annotation. Only permissible for the subtype
Link
. PDF 1.2+.
Write the /T
attribute. This is in the title bar of markup annotations
and should be the name of the annotation author. PDF 1.1+.
Write the /Subj
attribute. This is the subject of the annotation.
PDF 1.5+.
Write the /QuadPoints
attribute, specifying the region in which the
link should be activated. PDF 1.6+.
Write the /L
attribute. This defines the start and end point of a
line annotation
Start writing the /FS
attribute, setting which file to reference.
Write the /Name
attribute. Refer to the specification to see which
names are allowed for which annotation types.
Methods from Deref<Target = Dict<'a>>
Start writing a pair with an arbitrary value.
Write a pair with a primitive value.
This is a shorthand for dict.insert(key).primitive(value)
.