acrobat.collection.IAttachment (ActionScript 3.0)

	Property	Defined By
		children : IList [read-only] Children of this IAttachment.	IAttachment
		compressedSize : uint [read-only] The compressed size (in bytes) of the file.	IAttachment
		creationDate : Date [read-only] The creation date of the file.	IAttachment
		description : String Sets or gets the file description.	IAttachment
		fileName : String The last segment of the path property.	IAttachment
		icon : Bitmap [read-only] Gets the icon representation of the file according to the file type.	IAttachment
		isFolder : Boolean [read-only] true if this IAttachment represents a folder; false otherwise.	IAttachment
		isOpen : Boolean [read-only] true if the attachment is open; false otherwise.	IAttachment
		modDate : Date [read-only] Gets the modification date of the file.	IAttachment
		parent : IAttachment The parent of this IAttachment.	IAttachment
		path : String [read-only] The attachment's path within the package.	IAttachment
		size : uint [read-only] Gets the uncompressed size (in bytes) of the file.	IAttachment
		thumbnail : Bitmap [read-only] A thumbnail representing the attachment.	IAttachment

	Method	Defined By
		getFieldPrefix(fieldName:String):String Retrieves the prefix for a particular field.	IAttachment
		getFieldValue(fieldName:String):* For some field in the collection schema, this function retrieves the IAttachment instance's value for that field.	IAttachment
		requestThumbnail(maxWidth:int, maxHeight:int):void Requests a thumbnail image at a specified size.	IAttachment
		setFieldPrefix(fieldName:String, value:String):void Sets the prefix for a particular field.	IAttachment
		setFieldValue(fieldName:String, value:*):void Sets the value of a specified field in an IAttachment.	IAttachment

	Event	Summary	Defined By
		fieldValueChanged	An event that is dispatched for a change to either a schema field value or a schema prefix value.	IAttachment

Property Detail

children

property

children:IList [read-only]

Player Version :

Acrobat ActionScript API 9.0

Children of this IAttachment.

It will be null if this IAttachment is not a folder (for example, if isFolder is false).

Otherwise this is an ordered list (possibly empty) of non-null IAttachment instances. In this case the IList is read-only; attempts to modify it will generate exceptions.

Implementation
public function get children():IList

See also

mx.collections.IList

compressedSize

property

compressedSize:uint [read-only]

Player Version :

Acrobat ActionScript API 9.0

The compressed size (in bytes) of the file.

This property can be used as the source for data binding.

Implementation
public function get compressedSize():uint

creationDate

property

creationDate:Date [read-only]

Player Version :

Acrobat ActionScript API 9.0

The creation date of the file. The creation date will never change, so there is no change event associated with this property.

Implementation
public function get creationDate():Date

description

property

description:String [read-write]

Player Version :

Acrobat ActionScript API 9.0

Sets or gets the file description.

This property can be used as the source for data binding.

Implementation
public function get description():String
public function set description(value:String):void

Throws

Error — An Error is thrown if the file description is set when the permission "EmbeddedFile"/"Modify" has not been granted.

See also

ICollection.permissions

fileName

property

fileName:String [read-write]

Player Version :

Acrobat ActionScript API 9.0

The last segment of the path property.

This property can be used as the source for data binding.

Implementation
public function get fileName():String
public function set fileName(value:String):void

Throws

Error — An Error is thrown if it is set when the permission "EmbeddedFile"/"Modify" has not been granted.

See also

ICollection.permissions

icon

property

icon:Bitmap [read-only]

Player Version :

Acrobat ActionScript API 9.0

Gets the icon representation of the file according to the file type.

The value may be initially null.

This property can be used as the source for data binding.

Implementation
public function get icon():Bitmap

isFolder

property

isFolder:Boolean [read-only]

Player Version :

Acrobat ActionScript API 9.0

true if this IAttachment represents a folder; false otherwise.

Implementation
public function get isFolder():Boolean

isOpen

property

isOpen:Boolean [read-only]

Player Version :

Acrobat ActionScript API 9.0

true if the attachment is open; false otherwise.

This property can be used as the source for data binding.

Implementation
public function get isOpen():Boolean

modDate

property

modDate:Date [read-only]

Player Version :

Acrobat ActionScript API 9.0

Gets the modification date of the file.

This property can be used as the source for data binding.

Implementation
public function get modDate():Date

parent

property

parent:IAttachment [read-write]

Player Version :

Acrobat ActionScript API 9.0

The parent of this IAttachment. The value must be either null or an IAttachment that represents a folder. A value of null indicates that this IAttachment is located at the root level of the collection's folder hierarchy.

This property can be used as the source for data binding.

Implementation
public function get parent():IAttachment
public function set parent(value:IAttachment):void

Throws

Error — An Error is thrown if the value is set to an IAttachment that is not a folder, or if the value is set when the permission "EmbeddedFile"/"Modify" has not been granted.

See also

ICollection.permissions

path

property

path:String [read-only]

Player Version :

Acrobat ActionScript API 9.0

The attachment's path within the package.

This property can be used as the source for data binding.

Implementation
public function get path():String

size

property

size:uint [read-only]

Player Version :

Acrobat ActionScript API 9.0

Gets the uncompressed size (in bytes) of the file.

This property can be used as the source for data binding.

Implementation
public function get size():uint

thumbnail

property

thumbnail:Bitmap [read-only]

Player Version :

Acrobat ActionScript API 9.0

A thumbnail representing the attachment.

By default, the value is a cached image from the collection. The requestThumbnail() function can be called to request a thumbnail with particular dimensions.

The value, even for the default, may be initially null.

This property can be used as the source for data binding.

Implementation
public function get thumbnail():Bitmap

See also

requestThumbnail()

Method Detail

getFieldPrefix

()

method

public function getFieldPrefix(fieldName:String):String

Player Version :

Acrobat ActionScript API 9.0

Retrieves the prefix for a particular field.

A field can have a prefix that is not part of the value, but should be presented to the user as if it were. For example, consider an email archive containing subjects with the prefixes "FWD: " or "RE: ". In one case (display) the prefix and the value should be concatenated. In another case (sort comparison) the prefix should be ignored.

Parameters

fieldName:String — The name of the field for which to return the prefix.

Returns

String — The value of the field prefix; "" (an empty String) if there is no prefix. It returns undefined. if the field is not part of the collection schema.

getFieldValue

()

method

public function getFieldValue(fieldName:String):*

Player Version :

Acrobat ActionScript API 9.0

For some field in the collection schema, this function retrieves the IAttachment instance's value for that field.

A change to the value of a schema property will dispatch a FieldValueChangeEvent. The name of the schema property that changed will be stored in FieldValueChangeEvent.fieldName.

Parameters

fieldName:String — The name of the field.

Returns

* — The field value. Depending on the field type, this will be a String, Number or Date. It returns undefined if the field is not part of the collection schema.

See also

ICollection.fields
String
Number
Date

requestThumbnail

()

method

public function requestThumbnail(maxWidth:int, maxHeight:int):void

Player Version :

Acrobat ActionScript API 9.0

Requests a thumbnail image at a specified size. This will result in a thumbnail being dynamically generated for the file rather than a cached thumbnail being used. It will typically take much longer to execute than the default thumbnail property.

The new thumbnail will be delivered asynchronously. Arrival of the new thumbnail will be signified by an update to thumbnail (that is, a thumbnailChanged event).

If this method is called twice in succession with the same dimensions, only one thumbnail update will follow. If this method is called twice in succession with different dimensions, and if the second call is made before the first request has been completed, then the first thumbnail may not be delivered.

Parameters

	`maxWidth:int` — The width of the thumbnail, in pixels. It must be > 0 and <= 2048.

	`maxHeight:int` — The height of the thumbnail, in pixels. It must be > 0 and <= 2048.

See also

thumbnail

setFieldPrefix

()

method

public function setFieldPrefix(fieldName:String, value:String):void

Player Version :

Acrobat ActionScript API 9.0

Sets the prefix for a particular field.

Parameters

	`fieldName:String` — The name of the field for which to return the prefix.

	`value:String` — The value of the field prefix; "" (an empty `String`) if there is no prefix.

Throws

Error — An Error is thrown if the fieldName argument refers to a non-existent field (that is, a field not in the schema, as reported by ICollection.fields). In addition, an Error is thrown if the field maps to a read-only IAttachment property (that is, the IField has a type of CREATION_DATE, MOD_DATE, COMPRESSED_SIZE, or SIZE). No error is thrown if the field maps to a writable IAttachment property (the IField has an type of DESCRIPTION or FILE_NAME). In addition, an Error is thrown if this method is called when the permission "EmbeddedFile"/"Modify" has not been granted.

See also

ICollection.permissions
setFieldValue()

setFieldValue

()

method

public function setFieldValue(fieldName:String, value:*):void

Player Version :

Acrobat ActionScript API 9.0

Sets the value of a specified field in an IAttachment.

Parameters

	`fieldName:String` — The name of the field.

	`value:*` — The field's new value. Depending on the field type, this will be a `String`, `Number` or `Date`.

Throws

Error — An Error is thrown if the fieldName argument refers to a non-existent field (that is, a field not in the schema, as reported by ICollection.fields). In addition, an Error is thrown if the field maps to a read-only IAttachment property (that is, the IField has an type of CREATION_DATE, MOD_DATE, COMPRESSED_SIZE, or SIZE). No error is thrown if the field maps to a writable IAttachment property (the IField has an type of DESCRIPTION or FILE_NAME). Also, an Error is thrown if this method is called when the permission "EmbeddedFile"/"Modify" has not been granted.

Event Detail

fieldValueChanged

Event

Event Object Type: acrobat.collection.FieldValueChangedEvent
FieldValueChangedEvent.type property = mx.events.FlexEvent.APPLICATION_COMPLETE

Player Version :

Acrobat ActionScript API 9.0

An event that is dispatched for a change to either a schema field value or a schema prefix value.

The FlexEvent.APPLICATION_COMPLETE constant defines the value of the type property of the event object for a applicationComplete event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

See also

setFieldValue()
setFieldPrefix()

Submit Feedback on LiveDocs

Current page: http://livedocs.adobe.com/navigator/9/Navigator_SDK9_HTMLHelp/API_References/Acrobat_Navigator_API_Reference/acrobat/collection/IAttachment.html

Acrobat ActionScript API Reference	All Packages \| All Classes \| Index \| Conventions \| Frames No Frames
IAttachment	Properties \| Methods \| Events \| Styles \| Effects \| Constants \| Examples

Package	acrobat.collection
Interface	public interface IAttachment extends IEventDispatcher