Packagecom.adobe.portfolio.api
Interfacepublic interface IField

Language Version : ActionScript 3.0
Product Version : Portfolio 9.0
Runtime Versions : Flash Player 10.1, AIR 2.0

This interface provides support for fields displayed in the user interface.

See also

FieldType
ICollection.fields


Public Properties
 PropertyDefined By
  displayName : String
A string suitable for display in the user interface.
IField
  editable : Boolean
[read-only] Returns a value of true if the user should be allowed to edit an IAttachment instance's field corresponding to this IField.
IField
  name : String
[read-only] The name of this IField.
IField
  type : String
[read-only] Identifies the data type of this IField.
IField
  visible : Boolean
Returns a value of true if this field should be visible in the user interface; it returns false otherwise.
IField
Property Detail
displayNameproperty
displayName:String

Language Version : ActionScript 3.0
Product Version : Portfolio 9.0
Runtime Versions : Flash Player 10.1, AIR 2.0

A string suitable for display in the user interface.

While the string is localizable in the sense that it is Unicode and therefore not restricted to English or other European languages, the value returned does not change with the collection's locale or Acrobat's runtime locale.

For properties virtually added to the schema by setting the decorateSchema property to true, the name returned by this function will be provided by the Acrobat application and will be localized for Acrobat's current runtime locale.

Setting this property only changes the value in a copy of the schema and has no effect on the schema itself. The schema will only be changed if the modified IField is in the array used when setting ICollection.fields.


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

See also

editableproperty 
editable:Boolean  [read-only]

Language Version : ActionScript 3.0
Product Version : Portfolio 9.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Returns a value of true if the user should be allowed to edit an IAttachment instance's field corresponding to this IField. It returns false otherwise.

Setting this property only changes the value in a copy of the schema and has no effect on the schema itself. The schema will only be changed if the modified IField is in the array used when setting ICollection.fields.


Implementation
    public function get editable():Boolean

See also

nameproperty 
name:String  [read-only]

Language Version : ActionScript 3.0
Product Version : Portfolio 9.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The name of this IField.

This name serves as a unique identifier, and never changes.


Implementation
    public function get name():String
typeproperty 
type:String  [read-only]

Language Version : ActionScript 3.0
Product Version : Portfolio 9.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Identifies the data type of this IField.

It must be one of the field types defined in FieldType.


Implementation
    public function get type():String

See also

visibleproperty 
visible:Boolean

Language Version : ActionScript 3.0
Product Version : Portfolio 9.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Returns a value of true if this field should be visible in the user interface; it returns false otherwise.

Setting this property only changes the value in a copy of the schema and has no effect on the schema itself. The schema will only be changed if the modified IField is in the array used when setting ICollection.fields.


Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void

See also