page item

The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.

Element

EPS
graphic
graphic line
group
image
imported page
movie
oval
page item
path
PDF
PICT
polygon
rectangle
sound
text frame
text path
WMF

page item Properties

Property Type Access Description
absolute flip none,
horizontal,
vertical,
horizontal and vertical,
both,
none,
horizontal,
vertical,
horizontal and vertical,
both,
none,
horizontal,
vertical,
horizontal and vertical,
both,
none,
horizontal,
vertical,
horizontal and vertical,
both,
r/w Indicates whether the page item has been flipped independently of its parent object and, if yes, the direction in which the page item was flipped.
absolute horizontal scale fixed r/w The horizontal scale of the page item relative to its containing object.
absolute rotation angle fixed r/w The rotation angle of the page item relative to its containing object. (Range: -360 to 360)
absolute shear angle fixed r/w The skewing angle of the page item relative to its containing object. (Range: -360 to 360)
absolute vertical scale fixed r/w The vertical scale of the page item relative to its containing object.
all graphics List of graphic read Lists all graphics contained by the page item.
all page items List of page item read Lists all page items contained by the page item.
allow overrides boolean r/w If true, the master page page item allows overrides.
anchored object settings anchored object setting read Anchored object settings.
applied object style object style r/w The object style applied to the page item.
associated XML element XML item read The XML element associated with the page item.
class type class read The class descriptor type.
content transparency settings content transparency setting read Transparency settings for the content of the page item.
corner option none,
rounded corner,
inverse rounded corner,
inset corner,
bevel corner,
fancy corner,
none,
rounded corner,
inverse rounded corner,
inset corner,
bevel corner,
fancy corner,
none,
rounded corner,
inverse rounded corner,
inset corner,
bevel corner,
fancy corner,
none,
rounded corner,
inverse rounded corner,
inset corner,
bevel corner,
fancy corner,
none,
rounded corner,
inverse rounded corner,
inset corner,
bevel corner,
fancy corner,
r/w The shape to apply to corner points in a path. Note: corner option differs from end join in that you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends upon the stroke weight.
corner radius number or string r/w The radius in measurement units of the corner effect.
end cap butt end cap,
round end cap,
projecting end cap,
butt end cap,
round end cap,
projecting end cap,
butt end cap,
round end cap,
projecting end cap,
butt end cap,
round end cap,
projecting end cap,
butt end cap,
round end cap,
projecting end cap,
butt end cap,
round end cap,
projecting end cap,
r/w The end shape of an open path.
end join miter end join,
round end join,
bevel end join,
miter end join,
round end join,
bevel end join,
miter end join,
round end join,
bevel end join,
miter end join,
round end join,
bevel end join,
miter end join,
round end join,
bevel end join,
miter end join,
round end join,
bevel end join,
r/w The corner join applied to the page item.
fill color swatch r/w The swatch (color, gradient, tint, or mixed ink) applied to the to fill the page item. . Can also accept: string.
fill tint fixed r/w The percent of tint to use in the page item’s fill color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
fill transparency settings fill transparency setting read Transparency settings for the fill applied to the page item.
flip none,
horizontal,
vertical,
horizontal and vertical,
both,
none,
horizontal,
vertical,
horizontal and vertical,
both,
none,
horizontal,
vertical,
horizontal and vertical,
both,
none,
horizontal,
vertical,
horizontal and vertical,
both,
r/w The direction in which to flip the printed image.
frame fitting options frame fitting option read The frame fitting option to apply to placed or pasted content. Can be applied to a frame, object style, or document or to the application.
gap color swatch r/w The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.
gap tint fixed r/w The tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
geometric bounds List of number or string r/w The bounds of the page item excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
gradient fill angle fixed r/w The angle of a linear gradient applied to the fill of the page item. (Range: -180 to 180)
gradient fill length number or string r/w The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the page item.
gradient fill start List of number or string r/w The starting point (in page coordinates) of a gradient applied to the fill of the page item, in the format [x, y].
gradient stroke angle fixed r/w The angle of a linear gradient applied to the stroke of the page item. (Range: -180 to 180)
gradient stroke length number or string r/w The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the page item.
gradient stroke start List of number or string r/w The starting point (in page coordinates) of a gradient applied to the stroke of the page item, in the format [x, y].
horizontal scale fixed r/w The horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
id integer read The unique ID of the page item.
index integer read The index of the page item within its containing object.
item layer layer r/w The layer that the page item is on.
label string r/w A property that can be set to any string.
left line end none,
simple arrow head,
simple wide arrow head,
triangle arrow head,
triangle wide arrow head,
barbed arrow head,
curved arrow head,
circle arrow head,
circle solid arrow head,
square arrow head,
square solid arrow head,
bar arrow head,
none,
simple arrow head,
simple wide arrow head,
triangle arrow head,
triangle wide arrow head,
barbed arrow head,
curved arrow head,
circle arrow head,
circle solid arrow head,
square arrow head,
square solid arrow head,
bar arrow head,
none,
simple arrow head,
simple wide arrow head,
triangle arrow head,
triangle wide arrow head,
barbed arrow head,
curved arrow head,
circle arrow head,
circle solid arrow head,
square arrow head,
square solid arrow head,
bar arrow head,
none,
simple arrow head,
simple wide arrow head,
triangle arrow head,
triangle wide arrow head,
barbed arrow head,
curved arrow head,
circle arrow head,
circle solid arrow head,
square arrow head,
square solid arrow head,
bar arrow head,
none,
simple arrow head,
simple wide arrow head,
triangle arrow head,
triangle wide arrow head,
barbed arrow head,
curved arrow head,
circle arrow head,
circle solid arrow head,
square arrow head,
square solid arrow head,
bar arrow head,
r/w The arrowhead applied to the start of the path.
local display setting high quality,
typical,
optimized,
default,
high quality,
typical,
optimized,
default,
high quality,
typical,
optimized,
default,
r/w Display performance options for the page item.
lock state none,
unmanaged story,
checked in story,
checked out story,
locked story,
embedded story,
missing lock state,
mixed lock state,
none,
unmanaged story,
checked in story,
checked out story,
locked story,
embedded story,
missing lock state,
mixed lock state,
none,
unmanaged story,
checked in story,
checked out story,
locked story,
embedded story,
missing lock state,
mixed lock state,
none,
unmanaged story,
checked in story,
checked out story,
locked story,
embedded story,
missing lock state,
mixed lock state,
read The lock state.
locked boolean r/w If true, the page item is locked.
miter limit fixed r/w The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (Range: 1 to 500)
nonprinting boolean r/w If true, the page item does not print.
object reference page item read An object reference for the page item.
overprint fill boolean r/w If true, the page item’s fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
overprint gap boolean r/w If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
overprint stroke boolean r/w If true, the page item’s stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
overridden boolean read If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.
overridden master page item reference read An object that originated on a master page and has been overridden. Can return: page item, guide, graphic, movie or sound.
parent reference read The parent of the page item (a XML element, xml story, spread, master spread, page item, oval, rectangle, polygon, graphic line, group, state, text frame, story, text, character, word, line, text column, paragraph, text style range, cell, table, docume…
properties record r/w A property that allows setting of several properties at the same time.
right line end none,
simple arrow head,
simple wide arrow head,
triangle arrow head,
triangle wide arrow head,
barbed arrow head,
curved arrow head,
circle arrow head,
circle solid arrow head,
square arrow head,
square solid arrow head,
bar arrow head,
none,
simple arrow head,
simple wide arrow head,
triangle arrow head,
triangle wide arrow head,
barbed arrow head,
curved arrow head,
circle arrow head,
circle solid arrow head,
square arrow head,
square solid arrow head,
bar arrow head,
none,
simple arrow head,
simple wide arrow head,
triangle arrow head,
triangle wide arrow head,
barbed arrow head,
curved arrow head,
circle arrow head,
circle solid arrow head,
square arrow head,
square solid arrow head,
bar arrow head,
none,
simple arrow head,
simple wide arrow head,
triangle arrow head,
triangle wide arrow head,
barbed arrow head,
curved arrow head,
circle arrow head,
circle solid arrow head,
square arrow head,
square solid arrow head,
bar arrow head,
none,
simple arrow head,
simple wide arrow head,
triangle arrow head,
triangle wide arrow head,
barbed arrow head,
curved arrow head,
circle arrow head,
circle solid arrow head,
square arrow head,
square solid arrow head,
bar arrow head,
r/w The arrowhead applied to the end of the path.
rotation angle fixed r/w The rotatation angle of the page item. (Range: -360 to 360)
shear angle fixed r/w The skewing angle applied to the page item. (Range: -360 to 360)
stroke alignment center alignment,
inside alignment,
outside alignment,
center alignment,
inside alignment,
outside alignment,
center alignment,
inside alignment,
outside alignment,
center alignment,
inside alignment,
outside alignment,
center alignment,
inside alignment,
outside alignment,
r/w The stroke alignment applied to the page item.
stroke color swatch r/w The swatch (color, gradient, tint, or mixed ink) applied to the to stroke of the page item. Can also accept: string.
stroke corner adjustment none,
dashes,
gaps,
dashes and gaps,
none,
dashes,
gaps,
dashes and gaps,
none,
dashes,
gaps,
dashes and gaps,
none,
dashes,
gaps,
dashes and gaps,
none,
dashes,
gaps,
dashes and gaps,
none,
dashes,
gaps,
dashes and gaps,
r/w The corner adjustment applied to the page item.
stroke dash and gap List of number or string r/w The dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3].
stroke tint fixed r/w The percent of tint to use in object’s stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
stroke transparency settings stroke transparency setting read Transparency settings for the stroke.
stroke type stroke style r/w The name of the stroke style to apply. Can also accept: string.
stroke weight number or string r/w The weight (in points) to apply to the page item’s stroke.
text wrap preferences text wrap preference read The text wrap preference properties that define the default formatting for wrapping text around objects.
transparency settings transparency setting read Transparency settings.
vertical scale fixed r/w The vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
visible bounds List of number or string r/w The bounds of the page item including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.

Leave a Comment

Previous post:

Next post: