PDFAnnotationMarkup Class Reference

Inherits from
PDFAnnotation : NSObject
Conforms to
NSCopying
NSCopying (PDFAnnotation)
NSObject (NSObject)
Framework
Library/Frameworks/Quartz.framework/Frameworks/PDFKit.framework
Availability
Available in OS X v10.4 and later.
Declared in
PDFAnnotationMarkup.h
Related sample code

Overview

A PDFAnnotationMarkup object appears as highlighting, underlining, or a strikethrough style applied to the text of a document.

The setLineWidth: and setStyle: methods of the annotation’s associated PDFBorder object determines the stroke thickness and style. The setColor: method of the PDFAnnotation class determines the stroke color.

Tasks

Working with Markup Boundaries

Working with Markup Style

Instance Methods

markupType

Gets the markup style.

- (PDFMarkupType)markupType
Discussion

Refer to “Constants” for the available markup styles.

Availability
  • Available in OS X v10.4 and later.
See Also
Declared In
PDFAnnotationMarkup.h

quadrilateralPoints

Gets the array of quadrilateral points defining the bounds of the markup.

- (NSArray *)quadrilateralPoints
Discussion

Each quadrilateral encompasses a word or a contiguous group of words. The quadrilateral points are ordered counterclockwise, with the first point closest to the origin in page space.

Page space is a 72 dpi coordinate system with the origin at the lower-left corner of the current page.

Availability
  • Available in OS X v10.4 and later.
See Also
Declared In
PDFAnnotationMarkup.h

setMarkupType:

Sets the markup style.

- (void)setMarkupType:(PDFMarkupType)type
Discussion

Refer to “Constants” for the available markup styles.

Availability
  • Available in OS X v10.4 and later.
See Also
Declared In
PDFAnnotationMarkup.h

setQuadrilateralPoints:

Sets the array of quadrilateral points defining the bounds of the markup.

- (void)setQuadrilateralPoints:(NSArray *)points
Discussion

The points defined by each quadrilateral array should encompass a word or a contiguous group of words. The quadrilateral points are ordered counterclockwise, with the first point closest to the origin in page space.

Page space is a 72 dpi coordinate system with the origin at the lower-left corner of the current page.

Availability
  • Available in OS X v10.4 and later.
See Also
Declared In
PDFAnnotationMarkup.h

Constants

The styles available for markup annotations in PDF Kit:

Constant

Description

kPDFMarkupTypeHighlight

Highlight style for the markup.

Available in OS X v10.5 and later.

Declared in PDFAnnotationMarkup.h.

kPDFMarkupTypeStrikeOut

Strikethrough style for the markup.

Available in OS X v10.5 and later.

Declared in PDFAnnotationMarkup.h.

kPDFMarkupTypeUnderline

Underline style for the markup.

Available in OS X v10.5 and later.

Declared in PDFAnnotationMarkup.h.



© 2006 Apple Computer, Inc. All Rights Reserved. (Last updated: 2006-05-23)

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