activePDF Toolkit 2011 API Reference
RenditionFlags

Glossary Item Box

Description: Sets the rendition flag for the Flash® movie.
Syntax: object.RenditionFlag = "setValue"
Arguments: Argument Value Type Description & Settings
object N/A Set to an instance of the object.
LLX Float The horizontal position of the lower-left corner of the comment icon. Uses the PDF Coordinate System.
LLY Float The vertical position of the lower-left corner of the comment icon. Uses the PDF Coordinate System.
Width Float The width of the comment's popup window.
Height Float The height of the comment's popup window.
Contents String The contents of the comment's popup window.
Name String The comment's name, which appears in the lower half of the comment window's top bar.
Note Type Long The type of note comment you want to add to your PDF. This parameter controls which icon appears in the PDF.
Values are:
0 = Comment. A comment appears as a speech or thought bubble.
1 = Key. A key tag appears as a key standing on point.
2 = Note. A note tag appears as a page with a folded lower right corner.
3 = Help. A help tag appears as a question mark "?" in a circle.
4 = New paragraph. A new paragraph tag appears as the letters NP under a solid up arrow "^".
5 = Paragraph. A paragraph tag appears as the standard symbol.
6 = Insert. An insert tag appears as a solid up arrow "^"
Flags Long Controls the behavior of the comment. Values are:
2 = Hidden (no view OR print)
4 = Print
8 = No zooming. Zooming does not affect appearance.
16 = No rotate. Do not rotate the appearance to match the page's rotation.
32 = No View. Hidden on screen, but printable.
64 = Readonly. Contents cannot be changed.
128 = Locked. The comment properties cannot be deleted, but contents can be changed.
256 = ToggleNoView. This is largely implementation dependent.
Values can be "or'ed" together: Flags = 4 or 64.
Color String The color of the comment you want to add to your PDF. PDF comment color (controls color of the comment icon and top bar of popup window.) Alternately, you can use hex codes.

NOTE: Hex codes must be pre-pended with the pound sign (#) e.g. #FF0000.<:NOTE.NORMAL.END> Refer to Supported Comment Colors for a list of values.

Opened Variant_Bool Sets the initial view setting of the comment to "open" or "closed".
True = Open - Icon and comment displayed.
False = Closed - Icon only.
PageNum Long The page on which the comment appears. If you specify 0, Toolkit adds the comment to the cover page.