These information types are specific to particular types of
object. See the Core Objects section
for more detail.
Catalog Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "cata".
|
Pages |
|
|
The Object ID of the Pages Object.
The Pages object holds references to every page in the
document.
|
Outlines |
|
|
The Object ID of the Outline Object.
The Outline object holds the structure of the document.
|
Field Count |
|
|
The number of fields in the document.
|
Field N |
|
|
The Object ID of the field specified.
For example, if you want the Object ID of field number three,
you would reference GetInfo(thePagesID, "Field
3") .
Only leaf fields - those with a visible appearance on the page -
are returned. Typically, these are Annotation objects.
|
Field Name |
|
|
The Object ID of the named field.
For example, if you want the Object ID of the field with the
full name 'address.town', you would reference
GetInfo(thePagesID, "Field address.town") .
The name may be enclosed in single or double quotes in cases
where it is ambiguous whether you are referring to a field name or
a number.
Note that the PDF specification does not require that full names
be unique. The ID of the first matching field will be returned.
Only leaf fields - those with a visible appearance on the page -
are returned. Typically, these are Annotation objects.
|
Field IDs |
|
|
A comma delimited list of the Object IDs of all the fields in
the document.
Scanning the field tree can be an expensive process. It can be
quicker to get a list of all field IDs and use these as
required.
Only leaf fields - those with a visible appearance on the page -
are returned. Typically, these are Annotation objects.
|
Field Names |
|
|
A comma delimited list of the full names of all the fields in
the document.
Scanning the field tree can be an expensive process. It can be
quicker to get a list of all field names and use these as
required.
Only leaf fields - those with a visible appearance on the page -
are returned. Typically, these are Annotation objects.
|
Pages Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "pags".
|
Page Count |
|
|
The number of pages in the document.
|
Page N |
|
|
The Object ID of the page specified.
For example, if you want the Object ID of page number three, you
would reference GetInfo(thePagesID, "Page 3") .
|
Page Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "page".
|
Content Count |
|
|
The number of objects displayed on the page.
|
Content N |
|
|
The Object ID of the content object specified.
For example, if you want the Object ID of the second object on
the page, you would reference GetInfo(thePageID, "Content
2") .
|
Annot Count |
|
|
The number of annotations displayed on the page
|
Annot N |
|
|
The Object ID of the annotation object specified.
For example, if you want the Object ID of the second annotation
on the page, you would reference GetInfo(thePageID, "Annot
2") .
|
Rotate |
|
|
The amount the page should be rotated when displayed.
Page rotations are typically used to ensure that landscape pages
appear the right way up when displayed. Page rotations are measured
in degrees and may take the values 0, 90, 180 or 270.
|
Empty Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "empt".
|
Count |
|
|
The number of objects in the document.
|
Outline Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "outl".
|
Font Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "font".
|
FontBBox |
|
|
The rect defining the font bounding box. The values are measured
in 1000ths. It is the smallest rectangle enclosing all glyphs
positioned at the origin.
|
Widths abc |
|
|
The widths of the supplied characters.
For example, if you want the characters 'a' through to 'c', you
would reference GetInfo(theFontID, "widths abc") .
The widths are returned as a comma delimited list.
Width values are measured in 1000ths. So a character with a
width of 600 drawn in 24 point text will appear 14.4 points
wide.
|
LineSpacing |
|
|
The preferred distance between text lines for the font. For
OpenType fonts, the line spacing is calculated honoring the
fsSelection bit 7 of the OS2 table. Only recent windows application
do this; examples are WPF based applications or MS Word 2007
(equation editor only). For compatibility with older applications,
you may need to calculate the line spacing differently:
Ascent - Descent - 1000
where ascent and descent are defined below. The -1000 is to
exclude the font height.
The value is measured in 1000ths.
|
Ascent |
|
|
The ascent of the font. For OpenType fonts, this is the
usWinAscent value of the OS2 table.
The value is measured in 1000ths.
|
Descent |
|
|
The descent of the font. For OpenType fonts, this is the
usWinDescent value of the OS2 table with the sign changed.
The value is measured in 1000ths and is generally
non-positive.
|
Ascender |
|
|
The ascender of the font. For OpenType fonts, this is the
sTypoAscender value of the OS2 table.
The value is measured in 1000ths.
|
Descender |
|
|
The descender of the font. For OpenType fonts, this is the
sTypoDescender value of the OS2 table.
The value is measured in 1000ths and is generally
non-positive.
|
LineGap |
|
|
The line gap of the font. For OpenType fonts, this is the
sTypoLineGap value of the OS2 table.
The value is measured in 1000ths and is generally
non-positive.
|
Bookmark Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "book".
|
Stream Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "strm".
|
Stream |
|
|
The raw data from the stream. This data may be compressed or
otherwise encoded.
|
Compress |
|
|
Compresses the stream if it is not already compressed.
|
Decompress |
|
|
Decompresses the stream.
|
ClearDecompress |
|
|
Clears the cached, decompressed data so that a re-read of the
document is not required to release the memory.
The uncompressed data are retrieved from compressed streams
during most operations, but the streams are still compressed. The
uncompressed data are sometimes cached so that later operations
(including the actual decompression of the streams) need not invoke
the decompression algorithm.
|
PixMap Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "jpeg" for historical reasons. However, this does not
mean that the pixmap is necessarily in JPEG format.
|
Stream |
|
|
The raw data from the stream. This data may be compressed or
otherwise encoded.
|
Width |
|
|
The natural pixel width of the pixmap.
|
Height |
|
|
The natural pixel height of the pixmap.
|
Components |
|
|
The number of color components the pixmap contains.
Grayscale images contain one component. RGB images contain three
components. CMYK images contain four components.
|
ColorSpace |
|
|
The Object ID of the Color Space for the pixmap.
|
Alpha |
|
|
This allows you to assign a constant alpha value to the
image.
The alpha value should range between 0 (fully transparent) and
255 (fully opaque). Values outside this range will result in the
alpha constant being removed.
|
Chromakey |
|
|
This allows you to assign a transparent color or color range to
the image.
You need to specify two values for each component of the color.
If all the components of a color fall within the specified ranges,
then the color will not be displayed.
For example, to make pure white elements of an RGB transparent,
you might specify SetInfo(theID, "Chromakey", "255 255 255
255 255 255") . If you wanted to include colors which were
off-white, you might use SetInfo(theID, "Chromakey", "250 255
250 255 250 255") .
|
Grayscale |
|
|
This allows you to convert an RGB image to Grayscale. It can be
useful for preparing soft masks.
|
Image Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "imag".
|
Rect |
|
|
The rect defining the bounds of the visible content.
This rectangle is encoded in PDF coordinates rather than any
abstracted coordinate space.
|
Stream |
|
|
The raw data from the stream. This data may be compressed or
otherwise encoded.
|
XObject |
|
|
The Object ID of the XObject (PixMap) containing the image
data.
|
Text Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "text".
|
Rect |
|
|
The rect defining the bounds of the visible content.
This rectangle is encoded in PDF coordinates rather than any
abstracted coordinate space.
|
Stream |
|
|
The raw data from the stream. This data may be compressed or
otherwise encoded.
|
EndPos |
|
|
The insertion point for the next character after all the text in
this object has been drawn.
|
Characters |
|
|
The number of characters drawn.
|
Lines |
|
|
The number of lines of text drawn.
|
Truncated |
|
|
This property indicates if all the assigned text could be
displayed. It takes the value "1" if the text had to be truncated
and "0" if not.
Only text objects that have been truncated can be chained to
using AddHtml. If
you try to chain to a text object that is not truncated, you will
get a zero ID returned.
|
Prev |
|
|
The previous item in an HTML chain.
If the object is not part of a chain (or is at the head of the
chain), you will get a zero ID returned.
|
Graphic Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "line".
|
Stream |
|
|
The raw data from the stream. This data may be compressed or
otherwise encoded.
|
Rect |
|
|
The rect defining the bounds of the visible content.
This rectangle is encoded in PDF coordinates rather than any
abstracted coordinate space.
|
Grid Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "grid".
|
Stream |
|
|
The raw data from the stream. This data may be compressed or
otherwise encoded.
|
Rect |
|
|
The rect defining the bounds of the visible content.
This rectangle is encoded in PDF coordinates rather than any
abstracted coordinate space.
|
Annotation Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "anno".
|
Subtype |
|
|
The type of annotation.
This may be 'Text', 'Link', 'Widget', or any of the many
supported types listed in Section 8.4.5 of the Adobe PDF Specification.
|
Contents |
|
|
The visible text of the annotation.
If the annotation subtype does not display text, then this field
should contain an alternative description of the annotation
contents.
|
Name |
|
|
The full name of any form field associated with this
annotation.
Note that the PDF specification does not require that full names
be unique.
|
Page |
|
|
The Page ID of the document page on which this annotation is
located.
|
Rect |
|
|
The rectangle which defines the position and area of the
annotation on the page.
So to paint a rectangle over the top of an existing annotation,
you could write the following.
d.Page = d.GetInfo(theID, "Page")
d.Rect = d.GetInfo(theID, "Rect")
d.FillRect
|
FieldType |
|
|
The field type for any form field associated with this
annotation.
The following field types are available:
- "Pushbutton"
- "Checkbox"
- "Radio"
- "Text"
- "List"
- "Combo"
- "Signature"
- "Unknown"
More details of these field types can be found in the Section
8.6.3 of the Adobe PDF
Specification.
|
FieldValue |
|
|
The field value for any form field associated with this
annotation.
You may wish to assign or query the form field value using this
property.
Checkboxes and Radio Buttons have a value which is either "Off"
or the on-state of the control as specified in the
FieldOptions.
Text fields have a free-text value.
Combo Boxes and List Boxes have values restricted to a set of
selections as specified in the FieldOptions.
Pushbuttons and Signatures do not have a value.
|
FieldOptions |
|
|
The field options for any form field associated with this
annotation.
Typically, you assign a value using the FieldValue property.
Some fields such as Text fields accept any value. Others such as
Checkboxes and List Boxes accept only a limited range of options.
The field options tells you what options are available for a
particular field.
The unmarked state of a Checkbox or Radio Button is always
"Off". The marked state varies and is available via this
property.
The set of options for a Combo Box or List Box is available as a
comma delimited set of strings which can be obtained via this
property.
Pushbuttons, Signatures, and Text fields do not have
options.
|
FT |
|
|
The effective "/FT" value for any form field associated with
this annotation.
This value may be defined in a parent object so the value may
differ from the "/FT" value defined directly on this object.
|
Ff |
|
|
The effective "/Ff" value for any form field associated with
this annotation.
This value may be defined in a parent object so the value may
differ from the "/Ff" value defined directly on this object.
|
DA |
|
|
The effective "/DA" value for any form field associated with
this annotation.
This value may be defined in a parent object so the value may
differ from the "/DA" value defined directly on this object.
|
Q |
|
|
The effective "/Q" value for any form field associated with this
annotation.
This value may be defined in a parent object so the value may
differ from the "/Q" value defined directly on this object.
|
View Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "wemf".
|
Stream |
|
|
The raw data from the stream. This data may be compressed or
otherwise encoded.
|
Rect |
|
|
The rect defining the bounds of the visible content.
This rectangle is encoded in PDF coordinates rather than any
abstracted coordinate space.
|
Width |
|
|
The width of the image in points.
|
Height |
|
|
The height of the image in points.
|
ContentWidth |
|
|
The total width of the HTML image.
When adding HTML you only see one page at a time. This property
allows you to find the width of the HTML before it is paged onto
the PDF.
This value is measured in pixels and is usually very close to
ScrollWidth.
|
ContentHeight |
|
|
The total height of the HTML image.
When adding HTML you only see one page at a time. This property
allows you to find the height of the HTML before it is paged onto
the PDF.
This value is measured in pixels and is usually very close to
ScrollHeight.
|
ScrollWidth |
|
|
The scroll width of the HTML image.
It is the same scroll width value as retrieved using script
inside HTML.
This value is measured in pixels.
|
ScrollHeight |
|
|
The scroll height of the HTML image.
It is the same scroll height value as retrieved using script
inside HTML.
This value is measured in pixels.
|
PageOffset |
|
|
The vertical offset from the top of the HTML image to the top of
the current page.
This value is measured in pixels.
|
PageWidth |
|
|
The width of the portion of the HTML image which is being
displayed.
This value is measured in pixels.
|
PageHeight |
|
|
The height of the portion of the HTML image which is being
displayed.
This value is measured in pixels.
|
Truncated |
|
|
This property tells you if there are more pages of HTML to be
displayed.
It takes the value "1" if the HTML was truncated and "0" if
not.
|
ItemCount |
|
|
The number of visual content items present in this
object. |
ScriptReturn |
|
|
Any return value from the OnLoadScript. |
Text |
|
|
The text visible on the view.
Note that the text is in layout order not necessarily in reading
order.
|
URL |
|
|
The URL of the page which was rendered. |
Gecko View Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "cact".
|
Stream |
|
|
The raw data from the stream. This data may be compressed or
otherwise encoded.
|
Graphics State Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "grst".
|
ColorSpace Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "cols".
|
Space |
|
|
The type of color space.
|
Name |
|
|
Any name associated with the color space. For example, the name
of a spot color.
|
ICCProfile |
|
|
The Object ID of any associated ICC Color Profile.
|
ICCProfile Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "iccp".
|
Stream |
|
|
The raw data from the stream. This data may be compressed or
otherwise encoded.
|
Object Stream Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "obst".
|
Stream |
|
|
The raw data from the stream. This data may be compressed or
otherwise encoded.
|
XRef Object
Type Name
|
GetInfo
|
SetInfo
|
Description
|
Type |
|
|
Always "xref".
|
Stream |
|
|
The raw data from the stream. This data may be compressed or
otherwise encoded.
|
|
|
|