-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
EN-96202 [Scripting] Document ManagedImage.checkOut() and ManagedImag…
…e.checkIn() scripting calls EN-96202 [Scripting] Document ManagedImage.checkOut() and ManagedImage.checkIn() scripting calls Added articles for checkIn and checkOut scripting calls, including a small sample. Updated search indexes and TOC using generate.php Did not test it locally.
- Loading branch information
1 parent
eb13cb4
commit 5dd62f6
Showing
10 changed files
with
527 additions
and
383 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
636 changes: 325 additions & 311 deletions
636
assets/smart-connection-scripting-guide/search_data.json
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
59 changes: 59 additions & 0 deletions
59
smart-connection-scripting-guide/ManagedImage/Methods/checkIn.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| layout: chapter | ||
| title: checkIn | ||
| sortid: 63 | ||
| permalink: 1154-checkIn | ||
| --- | ||
|
|
||
| ## Syntax | ||
|
|
||
|   | ||
|
|
||
| ```javascript | ||
| ManagedImage.checkIn(); | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| **Return value** | ||
|
|
||
| The `checkIn()` method does not return anything. | ||
|
|
||
| ## Description | ||
|
|
||
| The `checkIn()` method checks-in the placed Image in the Studio Server system. | ||
|
|
||
| ## Examples | ||
|
|
||
| **Example title** | ||
|
|
||
| ```javascript | ||
| var doc = app.activeDocument; | ||
| var managedImages = doc.managedImages; | ||
|
|
||
| var im; | ||
| var md; | ||
| var core_name; | ||
| var id; | ||
|
|
||
| for(i=0; i<managedImages.length; i++) { | ||
| im = managedImages[i]; | ||
| md = im.entMetaData; | ||
| core_name = md.get( "Core_Name"); | ||
| id = doc.entMetaData.get("Core_ID"); | ||
| alert( "image name = [" + core_name + "] ; document id = [" + id + "]"); | ||
| im.checkOut(); | ||
| alert( "Now update the image in the woodwing.noindex folder"); | ||
| im.checkIn(); | ||
| } | ||
|
|
||
| ``` | ||
|
|
||
| ## Supported versions | ||
|
|
||
| | Adobe Version | Supported | | ||
| | ------------- | --------- | | ||
| | 2021 | | | ||
| | 2022 | | | ||
| | 2023 | | | ||
| | 2024 | 19.0.1+ ✔ | |
62 changes: 62 additions & 0 deletions
62
smart-connection-scripting-guide/ManagedImage/Methods/checkOut.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| --- | ||
| layout: chapter | ||
| title: checkOut | ||
| sortid: 64 | ||
| permalink: 1153-checkOut | ||
| --- | ||
|
|
||
| ## Syntax | ||
|
|
||
|   | ||
|
|
||
| ```javascript | ||
| ManagedImage.checkOut(); | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| **Return value** | ||
|
|
||
| The `checkOut()` method does not return anything. | ||
|
|
||
| ## Description | ||
|
|
||
| The `checkOut()` method checks-out the placed Image. | ||
|
|
||
| Note 1: The InDesign user interface is not capable of handling/showing checked out images. It is e.g. not possible to check out and check in images by using the interface, besides during an Edit Original operation. We advise to not use this function. | ||
|
|
||
| Note 2: After using this call you are also responsible to call checkIn to check the image back in. | ||
|
|
||
| ## Examples | ||
|
|
||
| **Example title** | ||
|
|
||
| ```javascript | ||
| var doc = app.activeDocument; | ||
| var managedImages = doc.managedImages; | ||
|
|
||
| var im; | ||
| var md; | ||
| var core_name; | ||
| var id; | ||
|
|
||
| for(i=0; i<managedImages.length; i++) { | ||
| im = managedImages[i]; | ||
| md = im.entMetaData; | ||
| core_name = md.get( "Core_Name"); | ||
| id = doc.entMetaData.get("Core_ID"); | ||
| alert( "image name = [" + core_name + "] ; document id = [" + id + "]"); | ||
| im.checkOut(); | ||
| alert( "Now update the image in the woodwing.noindex folder"); | ||
| im.checkIn(); | ||
| } | ||
| ``` | ||
|
|
||
| ## Supported versions | ||
|
|
||
| | Adobe Version | Supported | | ||
| | ------------- | --------- | | ||
| | 2021 | | | ||
| | 2022 | | | ||
| | 2023 | | | ||
| | 2024 | 19.0.1+ ✔ | |
2 changes: 1 addition & 1 deletion
2
smart-connection-scripting-guide/ManagedImage/Methods/create.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| --- | ||
| layout: chapter | ||
| title: create | ||
| sortid: 63 | ||
| sortid: 65 | ||
| permalink: 1152-create | ||
| --- | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
smart-connection-scripting-guide/ManagedImage/Properties/entMetaData.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| --- | ||
| layout: chapter | ||
| title: entMetaData | ||
| sortid: 64 | ||
| sortid: 66 | ||
| permalink: 1154-entMetaData | ||
| --- | ||
|
|
||
|
|
||
2 changes: 1 addition & 1 deletion
2
smart-connection-scripting-guide/ManagedImage/Properties/pageItem.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| --- | ||
| layout: chapter | ||
| title: pageItem | ||
| sortid: 65 | ||
| sortid: 67 | ||
| permalink: 1156-pageItem | ||
| --- | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters