Adobe InCopy CS5 (7.0) Object Model JS: MetadataPreference

InCopy CS5

previous page next page

Class

MetadataPreference

Metadata preferences. Base Class: Preference

QuickLinks

addEventListener, append, countContainer, createContainerItem, getElements, getProperty, removeEventListener, replace, save, setProperty, toSource, toSpecifier

Hierarchy

Document

Preference

MetadataPreference

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
author	string	r/w	The author of the document.
copyrightInfoURL	string	r/w	The URL of the file that contains the linked copyright statement.
copyrightNotice	string	r/w	The text to use as a copyright notice.
copyrightStatus	CopyrightStatus: CopyrightStatus.UNKNOWN CopyrightStatus.YES CopyrightStatus.NO	r/w	The copyright status of the document.
creationDate	Date	readonly	The creation date of the document.
creator	string	readonly	The name of the application used to create the document.
description	string	r/w	The description of the MetadataPreference.
documentTitle	string	r/w	The title of the document.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
format	string	readonly	The format of the document.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
jobName	string	r/w	The job name.
keywords	Array of string	r/w	The list of keywords associated with the document.
modificationDate	Date	readonly	The most recent modification date of the document.
parent	Document	readonly	The parent of the MetadataPreference (a Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
serverURL	string	readonly	The location of the document on the asset management server.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

void append (from: File[, affectAll: bool=false])
Uses metadata from the specified external file to define any undefined metadata properties in the document.

Parameter	Type	Description
from	File	The path to the external file that contains the metadata.
affectAll	bool	If true, also replaces existing metadata with data from the external file. If false, does not replace existing metadata. Note: Defaults to false. (Optional) (default: false)

number countContainer (namespace: string, path: string)
Counts the number of items in the container.

Parameter	Type	Description
namespace	string	The namespace of the container.
path	string	The path to the container.

void createContainerItem (namespace: string, path: string[, index: number=0][, container: ContainerType=ContainerType.BAG])
Creates an empty container.

Parameter	Type	Description
namespace	string	The namespace of the container.
path	string	The path to the container.
index	number	The index of the item within the container. Specified values must be 1 or greater. To append the item to the end of the index and allow the next available value to be assigned, use 0. (Optional) (default: 0)
container	ContainerType: ContainerType.BAG ContainerType.SEQ ContainerType.ALT	The container type. Note: Required when the new item is the first item added to the container. (Optional) (default: ContainerType.BAG)

Array of MetadataPreference getElements ()
Resolves the object specifier, creating an array of object references.

string getProperty (namespace: string, path: string)
Gets the XMP property value associated with the specified path.

Parameter	Type	Description
namespace	string	The namespace of the property.
path	string	The specified path.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

void replace (using: File[, affectAll: bool=false])
Replaces the current metadata in the document with metadata from the specified file.

Parameter	Type	Description
using	File	The full path to the file that contains the replacement metadata.
affectAll	bool	If true, treats all properties as external. Note: Defaults to false. (Optional) (default: false)

void save (to: File)
Saves the metadata in the document to an external file.

Parameter	Type	Description
to	File	The path to the external file.

void setProperty (namespace: string, path: string, value: string)
Sets the XMP property associated with the specified path.

Parameter	Type	Description
namespace	string	The namespace of the property.
path	string	The specified path(s).
value	string	The value to assign to the property. Note: To remove the property, pass an empty string.

string toSource ()
Generates a string which, if executed, will return the MetadataPreference.

string toSpecifier ()
Retrieves the object specifier.

Element of

Document.metadataPreferences

Return

Array of MetadataPreference MetadataPreference.getElements ()

Jongware, 23-Mar-2011 v3.0.3d

Contents :: Index

previous page start next page