Packagecom.adobe.indesign
Classpublic class XMLInstructions
InheritanceXMLInstructions Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  length : Number
[read-only] The number of objects in the collection.
XMLInstructions
Public Methods
 MethodDefined By
  
add(targetParam:String = null, dataParam:String, storyOffsetParam:Object = null, withPropertiesParam:Object = null):XMLInstruction
Creates a new XML processing instruction.
XMLInstructions
  
Returns any XMLInstruction in the collection.
XMLInstructions
  
count():Number
Displays the number of elements in the XMLInstruction.
XMLInstructions
  
everyItem():Object
Returns every XMLInstruction in the collection.
XMLInstructions
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
  
Returns the first XMLInstruction in the collection.
XMLInstructions
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
item(indexParam:Object = null):XMLInstruction
Returns the XMLInstruction with the specified index or name.
XMLInstructions
  
itemByID(idParam:Number):XMLInstruction
Returns the XMLInstruction with the specified ID.
XMLInstructions
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the XMLInstructions within the specified range.
XMLInstructions
  
Returns the last XMLInstruction in the collection.
XMLInstructions
  
Returns the middle XMLInstruction in the collection.
XMLInstructions
  
Returns the XMLInstruction whose index follows the specified XMLInstruction in the collection.
XMLInstructions
  
Returns the XMLInstruction with the index previous to the specified index.
XMLInstructions
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
  
nextNameIndex(idx:int):int
[override] Overriding this allows us to support for each...in
XMLInstructions
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
XMLInstructions
Property Detail
lengthproperty
length:Number  [read-only]

The number of objects in the collection.


Implementation
    public function get length():Number
Method Detail
add()method
public function add(targetParam:String = null, dataParam:String, storyOffsetParam:Object = null, withPropertiesParam:Object = null):XMLInstruction

Creates a new XML processing instruction.

Parameters

targetParam:String (default = null) — (String) A name that identifies the processing instruction to an application reading the exported XML file.
 
dataParam:String — (String) A value that tells the application what to do with the processing instruction identified in the target. (Optional)
 
storyOffsetParam:Object (default = null) — (Object) The location within the story, specified as an insertion point. Can accept: InsertionPoint or Long Integer. (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new XMLInstruction (Optional)

Returns
XMLInstruction
anyItem()method 
public function anyItem():XMLInstruction

Returns any XMLInstruction in the collection.

Returns
XMLInstruction
count()method 
public function count():Number

Displays the number of elements in the XMLInstruction.

Returns
Number
everyItem()method 
public function everyItem():Object

Returns every XMLInstruction in the collection.

Returns
Object
firstItem()method 
public function firstItem():XMLInstruction

Returns the first XMLInstruction in the collection.

Returns
XMLInstruction
item()method 
public function item(indexParam:Object = null):XMLInstruction

Returns the XMLInstruction with the specified index or name.

Parameters

indexParam:Object (default = null) — (Object) The index or name. Can accept: Long Integer or String.

Returns
XMLInstruction
itemByID()method 
public function itemByID(idParam:Number):XMLInstruction

Returns the XMLInstruction with the specified ID.

Parameters

idParam:Number (default = NaN) — (Number) The ID.

Returns
XMLInstruction
itemByRange()method 
public function itemByRange(fromParam:Object = null, toParam:Object = null):Object

Returns the XMLInstructions within the specified range.

Parameters

fromParam:Object (default = null) — (Object) The XMLInstruction, index, or name at the beginning of the range. Can accept: XMLInstruction, Long Integer or String.
 
toParam:Object (default = null) — (Object) The XMLInstruction, index, or name at the end of the range. Can accept: XMLInstruction, Long Integer or String.

Returns
Object
lastItem()method 
public function lastItem():XMLInstruction

Returns the last XMLInstruction in the collection.

Returns
XMLInstruction
middleItem()method 
public function middleItem():XMLInstruction

Returns the middle XMLInstruction in the collection.

Returns
XMLInstruction
nextItem()method 
public function nextItem(objParam:XMLInstruction = null):XMLInstruction

Returns the XMLInstruction whose index follows the specified XMLInstruction in the collection.

Parameters

objParam:XMLInstruction (default = null) — (XMLInstruction) The XMLInstruction whose index comes before the desired XMLInstruction.

Returns
XMLInstruction
nextNameIndex()method 
override flash_proxy function nextNameIndex(idx:int):int

Overriding this allows us to support for each...in

Parameters

idx:int

Returns
int
nextValue()method 
override flash_proxy function nextValue(index:int):*

Overriding this allows us to support for each...in

Parameters

index:int

Returns
*
previousItem()method 
public function previousItem(objParam:XMLInstruction = null):XMLInstruction

Returns the XMLInstruction with the index previous to the specified index.

Parameters

objParam:XMLInstruction (default = null) — (XMLInstruction) The index of the XMLInstruction that follows the desired XMLInstruction.

Returns
XMLInstruction