Changes between Version 18 and Version 19 of SCRIPTING_ACTIONS_API_R0

Timestamp:

08/03/09 21:34:03 (16 years ago)

Author:

mitex

Comment:

--

SCRIPTING_ACTIONS_API_R0

@@ -164 +164 @@
    * Property | Type | Description | Examples
    * title | string | Book's title | {{{book.title = 'Demonstration Book'}}}
+   * pages | array of Page | All pages in the book | Getting the number of pages: {{{book.pages.length}}}
    * pageSize | ImmSize | Page's dimensions | Getting the page height: {{{var height = book.pageSize.height}}}; Setting new dimensions: {{{book.pageSize = new ImmSize(600, 900);}}}
+  * Methods in Book:
+   * Method | Description | Examples
+   * function newPage() | Creates a new page in the book and returns it | Add new page after existing pages: book.newPage()}}}
+   * function removePage(index) | Removes the page with the given index. The first page has an index 0 (not 1) | Delete last page: {{{b.removePage(b.pages.length - 1)}}}
+   * function movePage(oldIndex, newIndex) | Moves the page with index {{{oldIndex}}} to index {{{newIndex}}} | Move the first page after the second: {{{book.movePage(0, 1)}}}
+   * setCurrentPage(page) | Sets the given page as current |
+
+ * Page:
+  * Properties:
+   * pageNumber | integer | Gets the number of the page. First page has a number 1. Page number 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:
+   * newFrame() | Creates a new frame in the page and returns it. |
+   * removeFrame(index) | Removes the frame with the given index (starting from zero) |
+
+ * Frame
+  * Properties:
+   * 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 |
+   * 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. |