Changes between Version 19 and Version 20 of SCRIPTING_ACTIONS_API_R0

Timestamp:

09/07/09 19:34:40 (16 years ago)

Author:

mitex

Comment:

--

SCRIPTING_ACTIONS_API_R0

@@ -176 +176 @@
   * Properties:
    * pageNumber | integer | Gets the number of the page. First page has a number 1. Page number cannot be changed. |
+   * pageIndex | integer | Gets the index of the page. First page has an index 0. Page index cannot be changed. |
    * name | string | Gets the name of the page, for example "Page A" |
-   * boundingRectangle | ImmRect | Gets the rectangle that contains all page elements (frames, etc.) | Get the width of the rectangle: {{{book.pages[0].boundingRectangle.size.width}}}
    * frames | array of Frame | All frames in the page | Getting the number of frames in 1st page: {{{book.pages[0].frames.length}}}
   * Methods:
@@ -187 +187 @@
    * name | string | Gets the name of the frame |
    * size | ImmSize | The outer size of the frame | Set the frame's size to be the same as the page's size (without moving it to the top-left corner): {{{book.pages[0].frames[0].size = book.pageSize}}}
-   * zOrder | integer | The z-order of the frame. The bottom-most frame has z-order 0, the front-most has the biggest z-order |
+   * zOrder | integer | The z-order of the frame. The bottom-most frame has z-order 0, the front-most has the biggest z-order | Swap a frame with the frame above it: {{{frame.zOrder++}}}
    * contentLocation | ImmPoint | The location (the coordinates) of the frame content |
-   * rotatingAngle | double | The angle at which the frame is rotated. Currently it is in radians, but in next revisions it will be in degrees. |
+   * rotatingAngle | double | The angle at which the frame is rotated. The value is in degrees. |
+  * Methods:
+   * function bringToFront() | moves the frame above all other page elements.
+   * function bringToBack() | moves the frame below all other page elements.