Annotations and Commenting

Annots (Annotations and Commenting)

Note: Preferences belonging to this feature reside in multiple hives.

Annotations include most of the items users can add to a document in the form of comments, editing markup, and so on. Many of these preferences are mapped to UI items in Acrobat. Pre 10.x versions of Reader have no Commenting preferences UI since the feature was only enabled in right's-extended documents. However, most of these preferences can be configured at the registry or plist level and used with Reader. For 10.x and later, Reader can also be configured from the UI as commenting is fully supported.

There are three broad categories of annotations:

Markups: Editorial marks on the page such as underscores, circles, polygons, etc.
Markup tools: Each tools has a number of properties that are stored in preferences.
Comments: Comments in popup notes and comment list items.

This preference category contains the following subfeature(s):

2D Measuring
Commenting-Misc Settings
Making Comments
Popup Open Behavior
Stamp Configuration
Viewing Comments

Popup Open Behavior

Controls how and when popups open when a PDF is opened.

Summary table

autoOpenOther	Automatically adds a popup note when another type of annotation is added.
HidePopupIfShowSummary	Hide comment popups when comment's list is open.
HoveringPopups	Automatically open popups on mouse rollover.
transparencyOK	Specifies whether to use the stroke color as the fill color for highlight annotations.

autoOpenOther

0 (bool)

8.0+

Annots

Not lockable

Automatically adds a popup note when another type of annotation is added.

Details

In other words, a popup note appears when you create a new comment using a drawing tool, the Stamp tool, or the Pencil tool. Possible values include:

0: Don't add a popup note for other annot types.
1: Do add a popup note for other annot types.

GUI mapping

Preferences > Commenting > Automatically open comment popups for comments other than notes.

HidePopupIfShowSummary

0 (bool)

8.0+

AVGeneral

Not lockable

Hide comment popups when comment's list is open.

Details

Possible values include:

0: Don't hide popups.
1: Do do hide popups.

GUI mapping

Preferences > Commenting > Hide comment popups when comment's list is open.

0 (bool)

8.0+

Originals

Not lockable

Automatically open popups on mouse rollover.

Details

Possible values include:

0: Don't open popups on mouse rollover.
1: Don't open popups on mouse rollover.

GUI mapping

Preferences > Commenting > Automatically open popups on mouse rollover.

0 (bool)

8.0-9.0

Annots

Not lockable

Specifies whether to use the stroke color as the fill color for highlight annotations.

Details

Possible values include:

0: Don't use the stroke color as the fill color.
1: Do use the stroke color as the fill color.

GUI mapping

N/A

Making Comments

The preferences in this section control the creation of new comments and associated features.

Summary table

alwaysUseIdent	Uses the login names as the comment author name.
author	The author name specified by balwaysUseIdent.
author	Creates new popups aligned to the edge of the document.
benableTextSelection	Specifies whether to enable text selection for annotations such as highlight, strikethrough or underline.
copyTextToDrawAnnot	Specifies whether to copy the encircled text into drawing comment popups.
copyTextToMarkupAnnot	Copies the selected text into highlight, cross-out, and underline comment popups.

0 (bool)

8.0+

Annots\Prefs

Not lockable

Uses the login names as the comment author name.

Details

The login name is the name specified in the identity preferences panel. If it is not present, the login-name is used. If it is not present for comments in collaborative documents (shared-review, browser-based review, email based review), the comment author identity is used that the user has set. For Acrobat, the default is true; for Reader, it is false. Possible values include:

0: Do use the login name as the comment author name.
1: Don't use the login name as the comment author name.

GUI mapping

Preferences > Commenting > Making Comments > Always use Log-in Name for Author name

0 (bool)

DC Continuous, August 2017

User Path

Annots\Prefs

Lock Path

Not lockable

Summary

Specifies whether to enable text selection for annotations such as highlight, strikethrough or underline.

Details

Possible values include:

0: Do enable text selection. When enabled, the cursor changes to ][ mode when the annotation (highlight, strikethrough or underline) is clicked and hovered over for more than 2 seconds. The cursor reverts to the previous mode after a time duration of 3 seconds upon hovering outside the bounding box of the annot.
1: Don't enable text selection. When disabled, the cursor changes to ][ mode only upon selecting Enable Text selection in the context menu. It will then remain in ][ mode for all annotations on the page.

GUI mapping

Preferences > Commenting > Making Comments > Enable text selection for Highlight, Strikethrough, and Underline.

0 (bool)

null

8.0+

Annots/Annot

Not lockable

The author name specified by balwaysUseIdent.

Details

Possible values include:

N/A: User specified.

N/A

0 (bool)

8.0+

Annots\Annot

Not lockable

Creates new popups aligned to the edge of the document.

Details

Controls popup positioning. Possible values include:

0: Don't align popups at the document edge.
1: Align popups at the document edge.

GUI mapping

Preferences > Commenting > Making Comments > Create new popups aligned to the edge of the document.

0 (bool)

8.0+

Annots\Prefs

Not lockable

Specifies whether to copy the encircled text into drawing comment popups.

Details

Adds a popup comment automatically to other markup types so that they can be annotated. Possible values include:

0: Don't copy the encircled text into comments.
1: Do copy the encircled text into comments.

GUI mapping

Preferences > Commenting > Making Comments > Copy encircled text into Drawing comment popups

copyTextToMarkupAnnot

0 (bool)

8.0+

Annots\Prefs

Not lockable

Copies the selected text into highlight, cross-out, and underline comment popups.

Details

Adds a popup comment automatically to specified markup types so that they can be annotated. Possible values include:

0: Copy selected text.
1: Don't copy selected text.

GUI mapping

Preferences > Commenting > Making Comments > Copy selected text into Highlight, Cross-Out, and Underline comment popups

Stamp Configuration

Stamps are an annotation feature that enables a quick method of using preconfigured and highly visual comments to indicate that a document has been approved, revised, etc. Choose stamps from the default library or create custom stamps.

Summary table

AP	The stamp name of a user favorited stamp.
cfavoriteStamps	A list of cabs that stores the stamp name and title of a user's favorite stamps in c0, c1, etc.
lastUsedStamp	Remembers the last used stamp.
lastViewedStampCategory	Remembers the last viewed stamp category in the stamps palette.
StampsPaletteInvisible	Specifies whether to show the stamps palette automatically when the commenting toolbar is displayed.
title	The stamp title of a user favorited stamp.

StampsPaletteInvisible

0 (bool)

8.0+

Annots

Not lockable

Specifies whether to show the stamps palette automatically when the commenting toolbar is displayed.

Details

Possible values include:

0: Show the palette.
1: Don't show the palette.

N/A

8 (cab)

null

8.0+

Annots\Prefs

Not lockable

A list of cabs that stores the stamp name and title of a user's favorite stamps in c0, c1, etc.

Details

A stamp can be made favorite by choosing Stamps > Favourites > Add current stamp to favorites. Each cab contains aAP and ttitle. Possible values include:

N/A: User specified

GUI mapping

From the commenting toolbar, select the stamp icon, and then choose Favorites > Add current stamp to favorities

2 (atom)

null

8.0+

Annots\Prefs\favoriteStamps

Lock Path

Not lockable

Summary

The stamp name of a user favorited stamp.

Details

Stored in c0, c1, etc. Possible values include:

N/A: User specified.

N/A

5 (text)

null

8.0+

Annots\Prefs\favoriteStamps

Lock Path

Not lockable

Summary

The stamp title of a user favorited stamp.

Details

Stored in c0, c1, etc. Possible values include:

N/A: User specified.

N/A

5 (text)

null

8.0+

Annots\Prefs

Not lockable

Remembers the last used stamp.

Details

Possible values include:

N/A: User specified.

GUI mapping

N/A

lastViewedStampCategory

null

8.0+

Annots\Prefs

Not lockable

Remembers the last viewed stamp category in the stamps palette.

Details

Possible values include:

N/A: User specified.

GUI mapping

N/A

Viewing Comments

Summary table

printCommentPopups	Enables printing of comments and other annotations.
showMarkupModifiers	Specifies whether to show markup tool-tips and text indicators.

0 (bool)

8.0+

Annots\cPrefs

Not lockable

Specifies whether to show markup tool-tips and text indicators.

Details

Possible values include:

0: Don't show markup tool-tips and text indicators.
1: Show markup tool-tips and text indicators.

GUI mapping

Preferences > Commenting > Viewing Comments > Enable text indicators and tooltips

0 (bool)

8.0+

Annots\Prefs\

Not lockable

Enables printing of comments and other annotations.

Details

Notes and popups that are open will be printed when the rest of the document is printed. Possible values include:

0: Don't print comments.
1: Do print comments.

GUI mapping

Preferences > Commenting > Viewing Comments > Print notes and popups

Commenting-Misc Settings

These preferences control commenting behavior related to printing, appearance, etc.

Summary table

astBBRURL	Specifies whether to remember the last browser based review (BBR) URL used.
commentPanelOnImport	Specifies whether to opens the comment list when comments are imported.
confirmEBRMerge	Displays an alert on document open asking the user to confirm importing comments into an active review.
emptyContentToolTip	Displays a tooltip stating the comment being hovered over is empty.
maxPDFCommentsSize	Sets the comment threshold size for determining whether comments are embedded or sent as FDF files.
noisyAnnots	Enables playing sound when adding and deleting annotations.
PopupsOpenIffSelected	Specifies whether to open a popup when it is selected.
printNotesOpaque	Makes popups opaque regardless of other settings.
sendFinalApprovalEmail	Specifies whether to send a notification email when the current approval is identified as the final one.

0 (bool)

8.0+

Annots\Prefs

Not lockable

Makes popups opaque regardless of other settings.

Details

Prints the popups as opaque without honoring the popup opacity specified by the user in commenting preferences (popup-opacity). Possible values include:

0: Don't make popups opaque.
1: Do make popups opaque.

N/A

0 (bool)

7.0-8.0

Annots

Not lockable

Enables playing sound when adding and deleting annotations.

Details

Possible values include:

0: Disable sounds on annotation actions.
1: Enable sounds on annotation actions.

N/A

0 (bool)

8.0+

Annots

Not lockable

Displays a tooltip stating the comment being hovered over is empty.

Details

Possible values include:

0: Don't indicate comment is empty.
1: Do indicate comment is empty.

N/A

0 (bool)

9.0+

Annots\cPrefs

Not lockable

Displays an alert on document open asking the user to confirm importing comments into an active review.

Details

Possible values include:

0: Disable confirmation alert on import.
1: Enable confirmation alert on import.

GUI mapping

Preferences > Reviews > Confirm Importing of Comments into Active Reviews from PDF Files

0 (bool)

9.0+

Annots\cPrefs

Not lockable

Specifies whether to opens the comment list when comments are imported.

Details

Possible values include:

0: Don't open the comment list when comments are imported.
1: Do open the comment list when comments are imported.

GUI mapping

Preferences > Reviews > Open the Comment List When Comments are imported

8.0-9.0

Annots

Not lockable

Specifies whether to remember the last browser based review (BBR) URL used.

Details

It is used to populate the wizard with the last used BBR url. Since BBR is deprecated, this preference may be omitted. Possible values include:

0: Don't remember the last browser based review URL.
1: Don't remember the last browser based review URL.

N/A

1 (int)

3 for Reader and 5 for Acrobat.

9.0+

Annots\cPrefs

Not lockable

Sets the comment threshold size for determining whether comments are embedded or sent as FDF files.

Details

When collaboration involves sending comments with a PDF, comments below the threshold size are embedded in the document. Comments above the threshold size are sent as FDF files. Possible values include:

3: Max size for Reader (Acrobat is 5)

GUI mapping

Preferences > Reviews > Email-based Review Options > Send comments as FDF for files greater than __ MB

sendFinalApprovalEmail

0 (bool)

8.0+

Annots

Not lockable

Specifies whether to send a notification email when the current approval is identified as the final one.

Details

Only valid for an approval workflow. Possible values include:

0: Don't send an email on final approval.
1: Do send an email on final approval.

GUI mapping

N/A

PopupsOpenIffSelected

0 (bool)

8.0+

Annots

Not lockable

Specifies whether to open a popup when it is selected.

GUI mapping

N/A

2D Measuring

Summary table

arrowBegin	Sets the default measuring start line shape.
arrowEnd	Sets the default measuring end line shape.

2 (atom)

Closed

Continuous track Aug, 2020

User Path

Annots

Lock Path

Not lockable

Summary

Sets the default measuring start line shape.

Details

While the aarrowBegin and aarrowEnd are legacy preferences, the Document Properties dialog and the Preferences > Measuring (2D) dialog used different preferences that conflicted with one another and resulted in the preference dialog settings always getting overridden by document properties. The preferences dialog has now been updated for the Continuous track, and both dialogs use the same preferences. Possible values include: