Sound
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| associatedXMLElement | XMLElement | readonly | Returns the associated XML element |
| description | string | r/w | The description of the Sound. |
| doNotPrintPoster | bool | r/w | If true, the sound poster does not print with the document. |
| embedInPDF | bool | r/w | If true, the file is embedded in the PDF. If false, the file is linked to the PDF. Note: To embed movie files, acrobat compatibility must be acrobat 6 or higher. |
| filePath | File | r/w | The full path to the file. |
| geometricBounds | Array of Measurement Unit (Number or String) | r/w | The bounds of the Sound 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. |
| horizontalScale | number | r/w | The horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000) |
| id | number | readonly | The unique ID of the Sound. |
| images | Images | readonly | A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF). |
| index | number | readonly | The index of the Sound within its containing object. |
| itemLayer | Layer | r/w | The layer that the Sound is on. |
| itemLink | Link | readonly | The source file of the link. |
| label | string | r/w | A property that can be set to any string. |
| locked | bool | r/w | If true, the Sound is locked. |
| name | string | r/w | The name of the Sound. |
| parent | OvalPageItem Polygon Rectangle |
readonly | The parent of the Sound (a PageItem, Oval, Rectangle or Polygon). |
| playOnPageTurn | bool | r/w | If true, the movie plays automatically when a user views the page that contains the movie poster in the PDF document. |
| posterFile | string | r/w | The poster file. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| soundPosterType | SoundPosterTypes: SoundPosterTypes.NONE SoundPosterTypes.STANDARD SoundPosterTypes.PROXY_IMAGE |
r/w | The type of sound poster. |
| verticalScale | number | r/w | The vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000) |
| visibleBounds | Array of Measurement Unit (Number or String) | r/w | The bounds of the Sound 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. |
Methods
Instances
void bringForward ()
Brings the Sound forward one level in its layer.
void bringToFront ()
Brings the Sound to the front.
Sound duplicate ()
Duplicates the Sound.
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
void fit (given:
FitOptions)
Applies the specified fit option to content in a frame.
| Parameter | Type | Description |
|---|---|---|
| given | FitOptions: FitOptions.CONTENT_TO_FRAME FitOptions.CENTER_CONTENT FitOptions.PROPORTIONALLY FitOptions.FRAME_TO_CONTENT | The fit option to use. |
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
void markup (using:
XMLElement)
Associates the page item with the specified XML element while preserving existing content.
| Parameter | Type | Description |
|---|---|---|
| using | XMLElement | The XML element. |
void move ([to:
any][, by:
Array
of Measurement Unit (Number or String)])
Move Page Item to a new location. One of the To or By parameters is required.
| Parameter | Type | Description |
|---|---|---|
| to |
Array
of 2 Units Layer Page Spread | The new location of the object. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) |
| by | Array of Measurement Unit (Number or String) | Amount by which to move the object relative to its current position (Optional) |
void remove ()
Deletes the Sound.
void resetScaling ()
Resets the Sound's scaling to 100%. Note: This does not change the size of the Sound. Instead, it makes the current size of the Sound the basis for future scaling.
void resize ([horizontalScale:
number][, verticalScale:
number][, around:
any][, consideringCurrentScale:
bool=false][, transformingContent:
bool=true][, consideringParentsScale:
bool=false])
Resize the page item. You must specify either horizontal scale or vertical scale or both.
| Parameter | Type | Description |
|---|---|---|
| horizontalScale | number | The percentage of horizontal scale (Optional) |
| verticalScale | number | The percentage of vertical scale (Optional) |
| around | AnchorPoint Array of 2 Units | The point to scale around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) |
| consideringCurrentScale | bool | If true then the object's current scale and new scale will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false) |
| transformingContent | bool | If true then both the object and items within it are scaled (Optional) (default: true) |
| consideringParentsScale | bool | If true then the object is scaled relative to its parent page item. If false it is scaled relative to the spread. (Optional) (default: false) |
void select ([existingSelection:
SelectionOptions=SelectionOptions.REPLACE])
Select this object.
| Parameter | Type | Description |
|---|---|---|
| existingSelection | SelectionOptions: SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE | How to handle the existing selection (Optional) (default: SelectionOptions.REPLACE) |
void sendBackward ()
Sends the Sound back one level in its layer.
void sendToBack ()
Sends the Sound to the back.
Asset store (using:
Library)
Store a page item in a library
| Parameter | Type | Description |
|---|---|---|
| using | Library | The library in which to store |
void unlink (from:
UnlinkFrom)
Detaches an overridden master page item from the page or from the master
| Parameter | Type | Description |
|---|---|---|
| from | UnlinkFrom: UnlinkFrom.PAGE UnlinkFrom.MASTER_SPREAD | What to unlink from |
Element of
Link.parent
SoundBehavior.soundItem
Return
Sound Sound.duplicate ()
Sound Sounds.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |