Mac OS X Reference Library Apple Developer Connection spyglass button

PDFAnnotationStamp Class Reference

Inherits from
Conforms to
Framework
Library/Frameworks/Quartz.framework/Frameworks/PDFKit.framework
Availability
Available in Mac OS X v10.5 and later.
Declared in
PDFAnnotationStamp.h
Related sample code

Overview

A PDFAnnotationStamp object allows you to display a word or phrase, such as “Confidential,“ in a PDF page.

A PDFAnnotationStamp object should have an appearance stream associated with it; otherwise, nothing useful is rendered.

Tasks

Accessing and Setting the Stamp Annotation

Instance Methods

name

Returns name associated with the stamp annotation.

- (NSString *)name

Discussion

Note that the name value of the stamp annotation is not necessarily identical to the user-visible appearance of the stamp annotation. For example, a stamp annotation that displays “Confidential” on a PDF page may not have a name value of “Confidential”.

Availability
  • Available in Mac OS X v10.5 and later.
See Also
Declared In
PDFAnnotationStamp.h

setName:

Sets the name associated with the stamp annotation.

- (NSString *)setName:(NSString *)name

Discussion

The name must be representable in ASCII. You can set a stamp annotation’s name to help you identify it, but that name is not displayed on the PDF page. You must provide the string you want displayed on the page, such as “Draft” or “Top Secret”, in the appearance stream for the annotation.

Availability
  • Available in Mac OS X v10.5 and later.
See Also
Declared In
PDFAnnotationStamp.h


Last updated: 2007-12-11

Did this document help you? Yes It's good, but... Not helpful...