### Guides.anyItem() Source: http://indesign.cs5.xyz/dom/Guide.html Returns any Guide object from the collection. ```APIDOC ## Guides.anyItem() ### Description Returns any Guide object from the collection. ### Method - **anyItem()** - Returns a Guide object. ### Returns - **Guide** - An arbitrary Guide object from the collection. ### Example ```javascript var anyGuide = app.activeDocument.guides.anyItem(); ``` ``` -------------------------------- ### Guides.everyItem() Source: http://indesign.cs5.xyz/dom/Guide.html Returns an array of all Guide objects in the collection. ```APIDOC ## Guides.everyItem() ### Description Returns an array of all Guide objects in the collection. ### Method - **everyItem()** - Returns an array of Guide objects. ### Returns - **Guide (Array)** - An array containing all Guide objects. ### Example ```javascript var allGuides = app.activeDocument.guides.everyItem(); ``` ``` -------------------------------- ### Guides.firstItem() Source: http://indesign.cs5.xyz/dom/Guide.html Returns the first Guide object in the collection. ```APIDOC ## Guides.firstItem() ### Description Returns the first Guide object in the collection. ### Method - **firstItem()** - Returns a Guide object. ### Returns - **Guide** - The first Guide object. ### Example ```javascript var firstGuide = app.activeDocument.guides.firstItem(); ``` ``` -------------------------------- ### Guides.add([layer], [withProperties]) Source: http://indesign.cs5.xyz/dom/Guide.html Creates a new Guide object and returns it. Optionally specifies the layer and initial properties. ```APIDOC ## Guides.add([layer], [withProperties]) ### Description Creates a new Guide object and returns it. Optionally specifies the layer and initial properties. ### Method - **add([layer], [withProperties])** - Returns a Guide object. ### Parameters - **layer** (Layer) - Optional - The layer on which to create the guide. - **withProperties** (Object) - Optional - Property values to set on the new guide. ### Returns - **Guide** - The newly created Guide object. ### Example ```javascript var newGuide = app.activeDocument.guides.add(); ``` ``` -------------------------------- ### Guides.nextItem(obj) Source: http://indesign.cs5.xyz/dom/Guide.html Returns the Guide object immediately after the specified object. ```APIDOC ## Guides.nextItem(obj) ### Description Returns the Guide object immediately after the specified object. ### Method - **nextItem(obj)** - Returns a Guide object. ### Parameters - **obj** (Guide) - Required - The reference Guide object. ### Returns - **Guide** - The Guide object that follows the specified object. ### Example ```javascript var nextGuide = app.activeDocument.guides.nextItem(someGuide); ``` ``` -------------------------------- ### createGuides([numberOfRows], [numberOfColumns], [rowGutter], [columnGutter], [guideColor], [fitMargins], [removeExisting], [layer]) Source: http://indesign.cs5.xyz/dom/Spread.html Creates guides on the spread with configurable rows, columns, gutters, color, margin fitting, and layer. ```APIDOC ## createGuides([numberOfRows], [numberOfColumns], [rowGutter], [columnGutter], [guideColor], [fitMargins], [removeExisting], [layer]) ### Description Creates guides on the spread. ### Method createGuides ### Parameters - **[numberOfRows]** (number) - Optional - Number of rows (0-40, default 0). - **[numberOfColumns]** (number) - Optional - Number of columns (0-40, default 0). - **[rowGutter]** (length) - Optional - Row gutter (0-1440 pt, default 0). - **[columnGutter]** (length) - Optional - Column gutter (0-1440 pt, default 0). - **[guideColor]** (Array of [r,g,b] or UIColors) - Optional - Guide color (RGB values 0-255). - **[fitMargins]** (boolean) - Optional - Whether to snap to page margins. Default: false. - **[removeExisting]** (boolean) - Optional - Whether to remove existing guides. Default: false. - **[layer]** (Layer) - Optional - The layer to create guides on. ### Returns - None ``` -------------------------------- ### Guides.itemByName(name) Source: http://indesign.cs5.xyz/dom/Guide.html Returns the Guide object with the specified name. ```APIDOC ## Guides.itemByName(name) ### Description Returns the Guide object with the specified name. ### Method - **itemByName(name)** - Returns a Guide object. ### Parameters - **name** (String) - Required - The name of the Guide object. ### Returns - **Guide** - The Guide object with the given name. ### Example ```javascript var guide = app.activeDocument.guides.itemByName("MyGuide"); ``` ``` -------------------------------- ### Guides.previousItem(obj) Source: http://indesign.cs5.xyz/dom/Guide.html Returns the Guide object immediately before the specified object. ```APIDOC ## Guides.previousItem(obj) ### Description Returns the Guide object immediately before the specified object. ### Method - **previousItem(obj)** - Returns a Guide object. ### Parameters - **obj** (Guide) - Required - The reference Guide object. ### Returns - **Guide** - The Guide object that precedes the specified object. ### Example ```javascript var prevGuide = app.activeDocument.guides.previousItem(someGuide); ``` ``` -------------------------------- ### Guides.item(index) Source: http://indesign.cs5.xyz/dom/Guide.html Returns the Guide object specified by index or name. ```APIDOC ## Guides.item(index) ### Description Returns the Guide object specified by index or name. ### Method - **item(index)** - Returns a Guide object. ### Parameters - **index** (Number, String) - Required - The index or name of the Guide object. ### Returns - **Guide** - The Guide object at the specified index or with the specified name. ### Example ```javascript var guide = app.activeDocument.guides.item(0); ``` ``` -------------------------------- ### Guides.itemByID(id) Source: http://indesign.cs5.xyz/dom/Guide.html Returns the Guide object with the specified ID. ```APIDOC ## Guides.itemByID(id) ### Description Returns the Guide object with the specified ID. ### Method - **itemByID(id)** - Returns a Guide object. ### Parameters - **id** (Number) - Required - The unique ID of the Guide object. ### Returns - **Guide** - The Guide object with the given ID. ### Example ```javascript var guide = app.activeDocument.guides.itemByID(123); ``` ``` -------------------------------- ### Guides.itemByRange(from, to) Source: http://indesign.cs5.xyz/dom/Guide.html Returns an array of Guide objects within the specified range. ```APIDOC ## Guides.itemByRange(from, to) ### Description Returns an array of Guide objects within the specified range. ### Method - **itemByRange(from, to)** - Returns an array of Guide objects. ### Parameters - **from** (Guide, Number, String) - Required - The start of the range (index, name, or Guide object). - **to** (Guide, Number, String) - Required - The end of the range (index, name, or Guide object). ### Returns - **Guide (Array)** - An array of Guide objects in the specified range. ### Example ```javascript var rangeGuides = app.activeDocument.guides.itemByRange(0, 5); ``` ``` -------------------------------- ### Guide Object Methods Source: http://indesign.cs5.xyz/dom/Guide.html Methods available on the Guide object for manipulating guides in InDesign. ```APIDOC ## addEventListener(eventType, handler, [captures]) ### Description Creates an EventListener for the Guide object. ### Method addEventListener ### Parameters - **eventType** (string) - Required - The event type to listen for. - **handler** (File, JavaScript function) - Required - The handler function or file. - **captures** (boolean) - Optional - Deprecated. ### Returns - **EventListener** - The created EventListener. ## detach() ### Description Detaches an overridden master page item from the master. ### Method detach ### Parameters None ### Returns None ## duplicate() ### Description Duplicates the Guide object and returns the duplicate. ### Method duplicate ### Parameters None ### Returns - **Guide** - The duplicated Guide object. ## extractLabel(key) ### Description Retrieves the value associated with the given key. ### Method extractLabel ### Parameters - **key** (string) - Required - The key to look up. ### Returns - **string** - The value associated with the key. ## getElements() ### Description Returns an array of Guide objects that match the object reference. ### Method getElements ### Parameters None ### Returns - **Array of Guide** - The array of Guide objects. ## insertLabel(key, value) ### Description Sets a value for the given key. ### Method insertLabel ### Parameters - **key** (string) - Required - The key. - **value** (string) - Required - The value to set. ### Returns None ## move([to], [by]) ### Description Moves the guide. Either 'to' or 'by' is required. ### Method move ### Parameters - **to** (Array of 2 numbers or length values) - Optional - The destination coordinates. - **by** (Array of 2 numbers or length values) - Optional - The relative offset. ### Returns None ## override(destinationPage) ### Description Overrides a master page item on the specified page. ### Method override ### Parameters - **destinationPage** (Page) - Required - The page where the override is placed. ### Returns - **Object** - The created object. ## remove() ### Description Deletes the Guide object. ### Method remove ### Parameters None ### Returns None ## removeEventListener(eventType, handler, [captures]) ### Description Removes an EventListener from the Guide object. ### Method removeEventListener ### Parameters - **eventType** (string) - Required - The event type. - **handler** (File, JavaScript function) - Required - The handler function or file. - **captures** (boolean) - Optional - Deprecated. ### Returns - **boolean** - True if the listener was removed successfully. ## removeOverride() ### Description Removes the override from the guide. ### Method removeOverride ### Parameters None ### Returns None ## resolve(location, in, [consideringRulerUnits]) ### Description Gets the coordinates of the given location in the specified coordinate system. ### Method resolve ### Parameters - **location** (varies) - Required - The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. - **in** (CoordinateSpaces) - Required - The coordinate space to use. - **consideringRulerUnits** (boolean) - Optional - Whether to use ruler units (default false). ### Returns - **varies** - The coordinates in the specified coordinate system. ## select([existingSelection]) ### Description Selects the guide. ### Method select ### Parameters - **existingSelection** (SelectionOptions) - Optional - How to handle existing selection (default SelectionOptions.REPLACE_WITH). ### Returns None ## toSource() ### Description Returns a string representing the source code of the object. ### Method toSource ### Parameters None ### Returns - **string** - The source code string. ## toSpecifier() ### Description Retrieves the object specifier. ### Method toSpecifier ### Parameters None ### Returns - **string** - The object specifier. ## transformValuesOf(in) ### Description Gets the transformation values in the specified coordinate space. ### Method transformValuesOf ### Parameters - **in** (CoordinateSpaces) - Required - The coordinate space to use. ### Returns - **Array of TransformationMatrix** - The transformation values. ``` -------------------------------- ### get(name) Source: http://indesign.cs5.xyz/dom/ScriptArg.html 指定されたキーの値を取得します。 ```APIDOC ## get(name) ### Description 値を取得します。 ### Method get ### Parameters - **name** (文字列値) - 必須 - キーの名前 ### Returns 文字列値 ``` -------------------------------- ### place(fileName, [showingOptions], [withProperties]) Source: http://indesign.cs5.xyz/dom/Sound.html Places a file into the sound object and returns the placed object(s). ```APIDOC ## place(fileName, [showingOptions], [withProperties]) ### Description Places a file into the sound object and returns the placed object(s). ### Method place ### Parameters - **fileName** (File) - Required - The file to place. - **[showingOptions]** (Boolean) - Optional - Whether to show options dialog (default false). - **[withProperties]** (Object) - Optional - Properties to set. ### Returns Array of varies (any) ``` -------------------------------- ### memoryStatistics() Source: http://indesign.cs5.xyz/dom/Application.html Gets memory statistics. ```APIDOC ## memoryStatistics() ### Description Gets memory statistics. ### Parameters None ### Returns Array of any ``` -------------------------------- ### place(fileName, [showingOptions], [withProperties]) Source: http://indesign.cs5.xyz/dom/Text.html Places a file into the text. Returns an array of placed objects. ```APIDOC ## place(fileName, [showingOptions], [withProperties]) ### Description Places a file into the text. ### Method place ### Parameters - **fileName** (ファイル) - Required - ファイル名 - **[showingOptions]** (真偽値) - Optional - オプションのダイアログを表示させるか (既定値=false) - **[withProperties]** (Object) - Optional - プロパティを設定 ### Returns Array( varies=any ) ``` -------------------------------- ### Guides.middleItem() Source: http://indesign.cs5.xyz/dom/Guide.html Returns the middle Guide object in the collection. ```APIDOC ## Guides.middleItem() ### Description Returns the middle Guide object in the collection. ### Method - **middleItem()** - Returns a Guide object. ### Returns - **Guide** - The middle Guide object. ### Example ```javascript var middleGuide = app.activeDocument.guides.middleItem(); ``` ``` -------------------------------- ### place(fileName, [showingOptions], [withProperties]) Source: http://indesign.cs5.xyz/dom/WMF.html Places a file into the WMF object and returns the placed objects. ```APIDOC ## place(fileName, [showingOptions], [withProperties]) ### Description Places a file into the WMF object and returns the placed objects. ### Method place ### Parameters - **fileName** (ファイル) - Required - The file to place. - **[showingOptions]** (真偽値) - Optional - Whether to show the options dialog (default false). - **[withProperties]** (Object) - Optional - Properties to set. ### Response Returns Array( varies=any ). ``` -------------------------------- ### Guides.lastItem() Source: http://indesign.cs5.xyz/dom/Guide.html Returns the last Guide object in the collection. ```APIDOC ## Guides.lastItem() ### Description Returns the last Guide object in the collection. ### Method - **lastItem()** - Returns a Guide object. ### Returns - **Guide** - The last Guide object. ### Example ```javascript var lastGuide = app.activeDocument.guides.lastItem(); ``` ``` -------------------------------- ### place(fileName, [placePoint], [destinationLayer], [showingOptions], [autoflowing], [withProperties]) Source: http://indesign.cs5.xyz/dom/MasterSpread.html Places a file into the MasterSpread and returns the placed objects. ```APIDOC ## place(fileName, [placePoint], [destinationLayer], [showingOptions], [autoflowing], [withProperties]) ### Description Places a file into the MasterSpread and returns the placed objects. ### Parameters - **fileName** (File) - Required - The file to place. - **placePoint** (Array of 2 numbers) - Optional - The coordinates (x, y) for the placement. - **destinationLayer** (Layer) - Optional - The layer to place onto. - **showingOptions** (boolean) - Optional - Whether to show the options dialog. Default is false. - **autoflowing** (boolean) - Optional - Whether to autoflow. Default is false. - **withProperties** (Object) - Optional - Properties to set on the placed object. ### Returns - Array of varies (any) - The placed objects. ``` -------------------------------- ### place(fileName, [showingOptions], [withProperties]) Source: http://indesign.cs5.xyz/dom/Image.html Places a file into the image, returning the placed objects. ```APIDOC ## place(fileName, [showingOptions], [withProperties]) ### Description Places a file into the image. Returns an array of placed objects. ### Method place ### Parameters - **fileName** (File) - Required - The file to place. - **[showingOptions]** (Boolean) - Optional - Whether to show the options dialog (default false). - **[withProperties]** (Object) - Optional - Properties to set. ### Returns Array(any) - The placed objects. ``` -------------------------------- ### Guides.length Source: http://indesign.cs5.xyz/dom/Guide.html Returns the number of Guide objects in the collection. ```APIDOC ## Guides.length ### Description Returns the number of Guide objects in the collection. ### Property - **length** (Number) - Read-only - The number of objects in the collection. ### Example ```javascript var count = app.activeDocument.guides.length; ``` ``` -------------------------------- ### getAllOverlays(portraitDocumentForCheckingOverlays, landscapeDocumentForCheckingOverlays, [miniFolioParams]) Source: http://indesign.cs5.xyz/dom/Application.html Gets all overlays. ```APIDOC ## getAllOverlays(portraitDocumentForCheckingOverlays, landscapeDocumentForCheckingOverlays, [miniFolioParams]) ### Description Gets all overlays. ### Method Function call ### Parameters - **portraitDocumentForCheckingOverlays** (Document) - Required - The portrait document. - **landscapeDocumentForCheckingOverlays** (Document) - Required - The landscape document. - **miniFolioParams** (Array) - Optional - Options for exporting a mini folio. dataField: String, dataValue: Any Type. ### Return Value Array of any - The overlays. ``` -------------------------------- ### place(fileName, [showingOptions], [withProperties]) Source: http://indesign.cs5.xyz/dom/EPS.html Places a file into the EPS object and returns the placed objects. ```APIDOC ## place(fileName, [showingOptions], [withProperties]) ### Description Places a file into the EPS object and returns the placed objects. ### Method place ### Parameters - **fileName** (ファイル) - Required - The file to place. - **[showingOptions]** (真偽値) - Optional - Whether to show the options dialog. Default is false. - **[withProperties]** (Object) - Optional - Properties to set on the placed object. ### Return Value Array( varies=any ) - The placed objects. ``` -------------------------------- ### place(fileName, [showingOptions], [withProperties]) Source: http://indesign.cs5.xyz/dom/Word.html Places a file into the Word object and returns the placed object. ```APIDOC ## place(fileName, [showingOptions], [withProperties]) ### Description Places a file into the Word object. ### Method place ### Parameters - **fileName** (File) - Required - File name. - **showingOptions** (boolean) - Optional - Show options dialog (default false). - **withProperties** (Object) - Optional - Properties to set. ### Returns Array of varies (any) ``` -------------------------------- ### ParagraphDestination.extractLabel(key) Source: http://indesign.cs5.xyz/dom/ParagraphDestination.html Gets the value associated with the specified key. ```APIDOC ## ParagraphDestination.extractLabel(key) ### Description Gets the value associated with the specified key. ### Method extractLabel ### Parameters - **key** (String) - Required - The key. ### Returns String - The value associated with the key. ``` -------------------------------- ### HyperlinkPageItemSource.extractLabel(key) Source: http://indesign.cs5.xyz/dom/HyperlinkPageItemSource.html Gets the value associated with the specified key. ```APIDOC ## HyperlinkPageItemSource.extractLabel(key) ### Description Gets the value associated with the specified key. ### Method extractLabel ### Parameters - **key** (String) - Required - The key. ### Returns String ``` -------------------------------- ### place(fileName, [showingOptions], [withProperties]) Source: http://indesign.cs5.xyz/dom/Polygon.html Places a file into the polygon, returning the placed objects. ```APIDOC ## place(fileName, [showingOptions], [withProperties]) ### Description Places a file into the polygon, returning the placed objects. ### Method Method call ### Parameters - **fileName** (File) - Required - The file to place. - **showingOptions** (boolean) - Optional - Whether to show the options dialog (default=false). - **withProperties** (Object) - Optional - Properties to set. ### Returns Array(any) - The placed objects. ``` -------------------------------- ### getApplicationAtIndex(indexOfApp, [withProperties]) Source: http://indesign.cs5.xyz/dom/EPubExportPreviewAppPreference.html Gets the application at the specified index. ```APIDOC ## getApplicationAtIndex(indexOfApp, [withProperties]) ### Description Get the application at index. ### Method getApplicationAtIndex ### Parameters - **indexOfApp** (Boolean) - Required - The index of the application to get information for. - **[withProperties]** (Object) - Optional - Properties to set. ### Returns any (varies) ``` -------------------------------- ### open(from, [showingWindow], [openOption]) Source: http://indesign.cs5.xyz/dom/Application.html Opens a document, book, or library. The from parameter can be a file or an array of files. The showingWindow parameter controls whether the window is shown, and openOption specifies the open mode. ```APIDOC ## open(from, [showingWindow], [openOption]) ### Description Opens a document, book, or library. The from parameter can be a file or an array of files. The showingWindow parameter controls whether the window is shown, and openOption specifies the open mode. ### Parameters - **from** (File or Array of File) - Required - The file name(s). - **showingWindow** (Boolean) - Optional - Whether to show the window. Default is true. - **openOption** (OpenOptions) - Optional - The open option. Possible values: DEFAULT_VALUE, OPEN_COPY, OPEN_ORIGINAL. Default is DEFAULT_VALUE. ### Returns Document, Book, or Library ``` -------------------------------- ### transformValuesOf Source: http://indesign.cs5.xyz/dom/ComboBox.html Gets the transformation values in the specified coordinate space. ```APIDOC ## transformValuesOf ### Description Gets the transformation values in the specified coordinate space. ### Method transformValuesOf ### Parameters #### Required Parameters - **in** (CoordinateSpaces) - The coordinate space to use. Possible values: INNER_COORDINATES, PAGE_COORDINATES, PARENT_COORDINATES, PASTEBOARD_COORDINATES, SPREAD_COORDINATES. ### Returns Array of TransformationMatrix ``` -------------------------------- ### place(fileName, [showingOptions], [withProperties]) Source: http://indesign.cs5.xyz/dom/HtmlItem.html Places a file into the HtmlItem and returns the placed objects. ```APIDOC ## place(fileName, [showingOptions], [withProperties]) ### Description Places a file into the HtmlItem and returns the placed objects. ### Method place ### Parameters - **fileName** (ファイル) - Required - ファイル名 - **[showingOptions]** (真偽値) - Optional - オプションのダイアログを表示させるか (既定値=false) - **[withProperties]** (Object) - Optional - プロパティを設定 ### Response Array( varies=any ) - 配置されたオブジェクトを返す ``` -------------------------------- ### performanceMetricShortName(for) Source: http://indesign.cs5.xyz/dom/Application.html Gets the short name of the specified performance metric. ```APIDOC ## performanceMetricShortName(for) ### Description Gets the short name of the specified performance metric. ### Method performanceMetricShortName ### Parameters - **for** (数値, PerformanceMetricOptions) - Required - 取得するInDesignのステータス ### Returns 文字列値 ``` -------------------------------- ### BuildingBlocks.everyItem() Source: http://indesign.cs5.xyz/dom/BuildingBlock.html コレクション内の全てのオブジェクトを配列として返します。 ```APIDOC ## BuildingBlocks.everyItem() ### Description 全てのオブジェクトを返します。 ### Method everyItem ### Returns BuildingBlock (Array) - 全てのオブジェクトの配列。 ``` -------------------------------- ### performanceMetricLongName(for) Source: http://indesign.cs5.xyz/dom/Application.html Gets the long name of the specified performance metric. ```APIDOC ## performanceMetricLongName(for) ### Description Gets the long name of the specified performance metric. ### Method performanceMetricLongName ### Parameters - **for** (数値, PerformanceMetricOptions) - Required - 取得するInDesignのステータス ### Returns 文字列値 ``` -------------------------------- ### place(fileName, [showingOptions], [withProperties]) Source: http://indesign.cs5.xyz/dom/ImportedPage.html Places a file into the imported page and returns the placed objects. ```APIDOC ## place(fileName, [showingOptions], [withProperties]) ### Description Places a file into the imported page and returns the placed objects. ### Method place ### Parameters - **fileName** (File) - Required - The file to place. - **[showingOptions]** (Boolean) - Optional - Whether to show the options dialog (default false). - **[withProperties]** (Object) - Optional - Properties to set. ### Response Returns Array(varies=any). ``` -------------------------------- ### performanceMetric(for) Source: http://indesign.cs5.xyz/dom/Application.html Gets the current value of the specified performance metric. ```APIDOC ## performanceMetric(for) ### Description Gets the current value of the specified performance metric. ### Parameters - **for** (Number or PerformanceMetricOptions) - Required - The InDesign status to retrieve. ### Returns Any ``` -------------------------------- ### activate() Source: http://indesign.cs5.xyz/dom/Application.html Brings the application to the front. ```APIDOC ## activate() ### Description Brings the application to the front. ### Method activate ### Parameters None ### Returns None ``` -------------------------------- ### print(from, [printDialog], [using], [withGrids]) Source: http://indesign.cs5.xyz/dom/Application.html Prints the specified file(s) with optional dialog and preset. ```APIDOC ## print(from, [printDialog], [using], [withGrids]) ### Description プリント - Prints the specified file(s). ### Method print ### Parameters - **from** (ファイル, Array( ファイル )) - Required - ファイル名 - **[printDialog]** (真偽値) - Optional - ダイアログを表示するか - **[using]** (PrinterPresetTypes, PrinterPreset) - Optional - 使用するプリセット - **[withGrids]** (真偽値) - Optional - グリッドを含むか (既定値=false) ### Returns なし ### Enumerations #### PrinterPresetTypes - **CUSTOM** (1131639917 / Cstm) - [カスタム] - **DEFAULT_VALUE** (1147563124 / Dflt) - [デフォルト] ``` -------------------------------- ### getCCXUserJSONData([jsondata]) Source: http://indesign.cs5.xyz/dom/Application.html Gets the user information for the home screen. ```APIDOC ## getCCXUserJSONData([jsondata]) ### Description Gets the user information for the home screen. ### Method Function call ### Parameters - **jsondata** (String) - Optional - Mode description. ### Return Value String - The user data in JSON format. ``` -------------------------------- ### BuildingBlocks.firstItem() Source: http://indesign.cs5.xyz/dom/BuildingBlock.html コレクション内の最初のオブジェクトを返します。 ```APIDOC ## BuildingBlocks.firstItem() ### Description 最初のオブジェクトを返します。 ### Method firstItem ### Returns BuildingBlock - 最初のオブジェクト。 ``` -------------------------------- ### addPageItemAtStart(addPageItem) Source: http://indesign.cs5.xyz/dom/FlexObject.html Adds an object at the start (visually at the end). ```APIDOC ## addPageItemAtStart(addPageItem) ### Description Adds an object at the start (visually at the end). ### Method - **addPageItemAtStart** ### Parameters - **addPageItem** (PageItem) - Required - The object to add. ### Returns - None ``` -------------------------------- ### loadPlaceGun(fileName, [showingOptions], [withProperties]) Source: http://indesign.cs5.xyz/dom/PlaceGun.html Loads content into the placement cursor. ```APIDOC ## loadPlaceGun(fileName, [showingOptions], [withProperties]) ### Description Loads content into the placement cursor. ### Method loadPlaceGun(fileName, [showingOptions], [withProperties]) ### Parameters - **fileName** (File, Array( File )) - Required - The file(s) to place. - **[showingOptions]** (boolean) - Optional - Whether to show the options dialog (default = false). - **[withProperties]** (Object) - Optional - Properties to set. ### Return Value None ``` -------------------------------- ### place(fileName, [placePoint], [destinationLayer], [showingOptions], [autoflowing], [withProperties]) Source: http://indesign.cs5.xyz/dom/Page.html Places a file onto the page and returns the placed objects. The fileName is required. Optional parameters control placement point, destination layer, showing options, autoflowing, and properties. ```APIDOC ## place(fileName, [placePoint], [destinationLayer], [showingOptions], [autoflowing], [withProperties]) ### Description Places a file onto the page and returns the placed objects. ### Method place ### Parameters - **fileName** (File) - Required - The file to place. - **placePoint** ([x, y]) - Optional - The coordinate where to place. x, y are numbers or length values. - **destinationLayer** (Layer) - Optional - The layer to place on. - **showingOptions** (boolean) - Optional - Whether to show options dialog. Default: false. - **autoflowing** (boolean) - Optional - Whether to autoflow. Default: false. - **withProperties** (Object) - Optional - Properties to set. ### Returns - **Array** (varies=any) - The placed objects. ``` -------------------------------- ### place(fileName, [showingOptions], [withProperties]) Source: http://indesign.cs5.xyz/dom/Movie.html Places a file into the movie item and returns the placed objects. ```APIDOC ## place(fileName, [showingOptions], [withProperties]) ### Description Places a file into the movie item. Optionally shows a dialog and sets properties. ### Method place ### Parameters - **fileName** (File) - Required - The file to place. - **[showingOptions]** (Boolean) - Optional - Whether to show the options dialog (default false). - **[withProperties]** (Object) - Optional - Properties to set. ### Returns Array( varies=any ) ``` -------------------------------- ### showAll() Source: http://indesign.cs5.xyz/dom/LibraryPanel.html Displays all assets in the LibraryPanel. ```APIDOC ## showAll() ### Description Displays all assets in the LibraryPanel. ### Method showAll ### Parameters None ### Returns - **None** ``` -------------------------------- ### transformValuesOf(in) Source: http://indesign.cs5.xyz/dom/ListBox.html Gets the transformation values of the ListBox in the specified coordinate space. ```APIDOC ## transformValuesOf(in) ### Description Gets the transformation values of the ListBox in the specified coordinate space. ### Method transformValuesOf ### Parameters - **in** (CoordinateSpaces) - Required - The coordinate space to use. Possible values: INNER_COORDINATES, PAGE_COORDINATES, PARENT_COORDINATES, PASTEBOARD_COORDINATES, SPREAD_COORDINATES. ### Response Returns an array of TransformationMatrix objects. ``` -------------------------------- ### HyperlinkTextDestination.extractLabel(key) Source: http://indesign.cs5.xyz/dom/HyperlinkTextDestination.html Gets the value associated with the specified label key. ```APIDOC ## HyperlinkTextDestination.extractLabel(key) ### Description Gets the value associated with the specified label key. ### Method extractLabel ### Parameters - **key** (String) - Required - The label key. ### Returns String ``` -------------------------------- ### add([layer], [at], [reference], [withProperties]) Source: http://indesign.cs5.xyz/dom/TextBox.html 新しい TextBox オブジェクトを作成し、それを返します。オプションでレイヤー、位置、基準オブジェクト、プロパティを指定できます。 ```APIDOC ## add([layer], [at], [reference], [withProperties]) ### Description 新しい TextBox オブジェクトを作成し、それを返します。 ### Method add ### Parameters #### Optional Parameters - **layer** (Layer) - 作成するレイヤー - **at** (LocationOptions) - 位置 (既定値=LocationOptions.UNKNOWN) - 値: AFTER, AT_BEGINNING, AT_END, BEFORE, UNKNOWN - **reference** (Document, Spread, MasterSpread, Page, Layer, PageItem) - 位置の基準になるオブジェクト - **withProperties** (Object) - プロパティを設定 ### Returns TextBox ``` -------------------------------- ### addApplication(applicationPath, selectedForReflowableEpub, selectedForFixedLayoutEpub, [withProperties]) Source: http://indesign.cs5.xyz/dom/EPubExportPreviewAppPreference.html Adds a new preview application preference. Requires the application path and flags for reflowable and fixed layout EPUBs, with optional properties. ```APIDOC ## addApplication(applicationPath, selectedForReflowableEpub, selectedForFixedLayoutEpub, [withProperties]) ### Description Add a new preview application preference. ### Method addApplication ### Parameters - **applicationPath** (String) - Required - The application path. - **selectedForReflowableEpub** (Boolean) - Required - Whether selected for reflowable layout. - **selectedForFixedLayoutEpub** (Boolean) - Required - Whether selected for fixed layout. - **[withProperties]** (Object) - Optional - Properties to set. ### Returns None ``` -------------------------------- ### transformValuesOf(in) Source: http://indesign.cs5.xyz/dom/GraphicLine.html Gets the transformation values of the GraphicLine in the specified coordinate space. ```APIDOC ## transformValuesOf(in) ### Description Gets the transformation values of the GraphicLine in the specified coordinate space. ### Method - (not specified) ### Parameters - **in** (CoordinateSpaces) - Required - The coordinate space in which to get the transformation values. ### Response - Returns an Array of TransformationMatrix. ``` -------------------------------- ### transformValuesOf Source: http://indesign.cs5.xyz/dom/CheckBox.html Gets the transformation values of the CheckBox in the specified coordinate space. ```APIDOC ## transformValuesOf ### Description Gets the transformation values of the CheckBox in the specified coordinate space. ### Method transformValuesOf ### Parameters - **in** (CoordinateSpaces) - Required - The coordinate space to use. Possible values: INNER_COORDINATES, PAGE_COORDINATES, PARENT_COORDINATES, PASTEBOARD_COORDINATES, SPREAD_COORDINATES. ### Response Returns an array of TransformationMatrix objects. ``` -------------------------------- ### place(fileName, [showingOptions], [withProperties]) Source: http://indesign.cs5.xyz/dom/EPSText.html Places a file into the EPSText object and returns the placed object(s). ```APIDOC ## place(fileName, [showingOptions], [withProperties]) ### Description Places a file into the EPSText object and returns the placed object(s). ### Method place ### Parameters - **fileName** (ファイル) - Required - ファイル名 - **[showingOptions]** (真偽値) - Optional - オプションのダイアログを表示させるか (既定値=false) - **[withProperties]** (Object) - Optional - プロパティを設定 ### Response Array( varies=any ) - 配置されたオブジェクトを返す ``` -------------------------------- ### transformValuesOf Source: http://indesign.cs5.xyz/dom/Button.html Gets the transformation values of the button in the specified coordinate space. ```APIDOC ## transformValuesOf ### Description Gets the transformation values of the button in the specified coordinate space. ### Method transformValuesOf ### Parameters - **in** (CoordinateSpaces) - Required - The coordinate space to use. Possible values: INNER_COORDINATES (xyin), PAGE_COORDINATES (xypg), PARENT_COORDINATES (xypa), PASTEBOARD_COORDINATES (xypb), SPREAD_COORDINATES (xysp). ### Response Array( TransformationMatrix ) ``` -------------------------------- ### resolve Source: http://indesign.cs5.xyz/dom/Button.html Gets the coordinates of a given location in the specified coordinate system. ```APIDOC ## resolve ### Description Gets the coordinates of a given location in the specified coordinate system. ### Method resolve ### Parameters - **location** (varies=any) - Required - The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. - **in** (CoordinateSpaces) - Required - The coordinate space to use. Possible values: INNER_COORDINATES (xyin), PAGE_COORDINATES (xypg), PARENT_COORDINATES (xypa), PASTEBOARD_COORDINATES (xypb), SPREAD_COORDINATES (xysp). - **[consideringRulerUnits]** (真偽値) - Optional - ルーラの単位を使うかどうか (既定値=false) ### Response varies=any ``` -------------------------------- ### add([layer], [at], [reference], [withProperties]) Source: http://indesign.cs5.xyz/dom/ComboBox.html 新しいComboBoxオブジェクトを作成し、それを返します。オプションでレイヤー、位置、基準オブジェクト、プロパティを指定できます。 ```APIDOC ## add([layer], [at], [reference], [withProperties]) ### Description 新しいComboBoxオブジェクトを作成し、それを返します。 ### Method add ### Parameters #### Optional Parameters - **layer** (Layer) - 作成するレイヤー - **at** (LocationOptions) - 位置 (既定値=LocationOptions.UNKNOWN) - **reference** (Document, Spread, MasterSpread, Page, Layer, PageItem) - 位置の基準になるオブジェクト - **withProperties** (Object) - プロパティを設定 ### Returns ComboBox ``` -------------------------------- ### getUntitledCount() Source: http://indesign.cs5.xyz/dom/Application.html Gets the count which will be used in the name of the next untitled document. ```APIDOC ## getUntitledCount() ### Description Gets the count which will be used in the name of the next untitled document. ### Method Function call ### Parameters None ### Return Value Number - The count. ``` -------------------------------- ### place(fileName, [showingOptions], [withProperties]) Source: http://indesign.cs5.xyz/dom/Application.html Places a file or files into the document. ```APIDOC ## place(fileName, [showingOptions], [withProperties]) ### Description 配置 - Places the specified file(s). ### Method place ### Parameters - **fileName** (ファイル, Array( ファイル )) - Required - 配置するファイル名 - **[showingOptions]** (真偽値) - Optional - オプションのダイアログを表示させるか (既定値=false) - **[withProperties]** (Object) - Optional - プロパティを設定 ### Returns なし ``` -------------------------------- ### transformValuesOf Source: http://indesign.cs5.xyz/dom/Sound.html Gets the transformation values of the Sound object in the specified coordinate space. ```APIDOC ## transformValuesOf ### Description Gets the transformation values of the Sound object in the specified coordinate space. ### Method transformValuesOf ### Parameters - **in** (CoordinateSpaces) - Required - The coordinate space to use. Possible values: INNER_COORDINATES, PAGE_COORDINATES, PARENT_COORDINATES, PASTEBOARD_COORDINATES, SPREAD_COORDINATES. ### Returns Array of TransformationMatrix - The transformation values. ``` -------------------------------- ### store(using, [withProperties]) Source: http://indesign.cs5.xyz/dom/TextBox.html Adds the TextBox to a library. ```APIDOC ## store(using, [withProperties]) ### Description Adds the TextBox to a library. ### Method store ### Parameters - **using** (Library) - Required - The library to add to. - **withProperties** (Object) - Optional - Properties to set. ### Return Value Asset ``` -------------------------------- ### getSupportedViewerVersions() Source: http://indesign.cs5.xyz/dom/Application.html Gets the list of viewer versions the digital publishing plugin supports. ```APIDOC ## getSupportedViewerVersions() ### Description Gets the list of viewer versions the digital publishing plugin supports. ### Method Function call ### Parameters None ### Return Value Array of String - The supported versions. ``` -------------------------------- ### getElements() Source: http://indesign.cs5.xyz/dom/SmartGuidePreference.html オブジェクト参照を返します。SmartGuidePreference オブジェクトの配列を取得します。 ```APIDOC ## getElements() ### Description オブジェクト参照を返します。SmartGuidePreference オブジェクトの配列を取得します。 ### Method getElements ### Parameters なし ### Return Value - **Array(SmartGuidePreference)** - SmartGuidePreference オブジェクトの配列。 ``` -------------------------------- ### getSupportedArticleViewerVersions() Source: http://indesign.cs5.xyz/dom/Application.html Gets the list of article viewer versions the digital publishing plugin supports. ```APIDOC ## getSupportedArticleViewerVersions() ### Description Gets the list of article viewer versions the digital publishing plugin supports. ### Method Function call ### Parameters None ### Return Value Array of String - The supported versions. ``` -------------------------------- ### getStyleConflictResolutionStrategy([charOrParaStyle]) Source: http://indesign.cs5.xyz/dom/Application.html Gets the resolution strategy for style conflict, false if the user cancels. ```APIDOC ## getStyleConflictResolutionStrategy([charOrParaStyle]) ### Description Gets the resolution strategy for style conflict, false if the user cancels. ### Method Function call ### Parameters - **charOrParaStyle** (StyleType) - Optional - The style type. ### Return Value any - The resolution strategy. ### StyleType Enum - **CHARACTER_STYLE_TYPE** (1665684340) - Character style. - **PARAGRAPH_STYLE_TYPE** (1883730548) - Paragraph style. ``` -------------------------------- ### place(fileName, [showingOptions], [withProperties]) Source: http://indesign.cs5.xyz/dom/PDF.html Places a file into the PDF object and returns the placed object. ```APIDOC ## place(fileName, [showingOptions], [withProperties]) ### Description Places a file into the PDF object and returns the placed object. ### Method place ### Parameters - **fileName** (ファイル) - Required - The file name. - **[showingOptions]** (真偽値) - Optional - Whether to show the options dialog (default=false). - **[withProperties]** (Object) - Optional - Properties to set. ### Returns Array( varies=any ) ``` -------------------------------- ### getDigpubVersion(digpubVersion) Source: http://indesign.cs5.xyz/dom/Application.html Gets the current digital publishing version number for the given parameter. ```APIDOC ## getDigpubVersion(digpubVersion) ### Description Gets the current digital publishing version number for the given parameter. ### Method Function call ### Parameters - **digpubVersion** (DigpubVersion) - Required - The version type to retrieve. ### Return Value Array of String - The version strings. ### DigpubVersion Enum - **ALL** (1634495520) - Plugin, folio, and plist versions in that order. - **FOLIO** (1685087862) - Folio version. - **PLIST** (1685090422) - Plist version. - **PLUGIN** (1685090412) - Plugin version. ``` -------------------------------- ### Libraries.add(fullName, [withProperties]) Source: http://indesign.cs5.xyz/dom/Library.html Creates a new Library object and returns it. The fullName parameter specifies the file path of the library, and optional withProperties can set initial properties. ```APIDOC ## Libraries.add(fullName, [withProperties]) ### Description Creates a new Library object and returns it. ### Method add ### Parameters - **fullName** (File) - Required - The full path name of the file. - **withProperties** (Object) - Optional - Properties to set. ### Returns Library ``` -------------------------------- ### BuildingBlocks.anyItem() Source: http://indesign.cs5.xyz/dom/BuildingBlock.html コレクション内の任意のオブジェクトを返します。 ```APIDOC ## BuildingBlocks.anyItem() ### Description どれかのオブジェクトを返します。 ### Method anyItem ### Returns BuildingBlock - 任意のオブジェクト。 ``` -------------------------------- ### tileWindows() Source: http://indesign.cs5.xyz/dom/Application.html Tiles all open windows. ```APIDOC ## tileWindows() ### Description 並べて表示 - Tiles windows. ### Method tileWindows ### Parameters None ### Returns なし ```