Packagecom.adobe.indesign
Classpublic class PageReference
InheritancePageReference Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  eventListeners : EventListeners
[read-only] A collection of event listeners.
PageReference
  events : Events
[read-only] A collection of events.
PageReference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[read-only] The unique ID of the PageReference.
PageReference
  index : Number
[read-only] The index of the PageReference within its containing object.
PageReference
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
PageReference
  label : String
A property that can be set to any string.
PageReference
  name : String
The name of the PageReference; this is an alias to the PageReference's label property.
PageReference
  pageNumberStyleOverride : CharacterStyle
The character style applied to page numbers.
PageReference
  pageReferenceLimit : Object
The paragraph style or number of paragraphs or pages that defines the last page in a page range.
PageReference
  pageReferenceType : PageReferenceType
Options for index page references.
PageReference
  parent : Topic
[read-only] The parent of the PageReference (a Topic).
PageReference
  properties : Object
A property that allows setting of several properties at the same time.
PageReference
  sourceText : Text
[read-only] The hyperlinked text or insertion point.
PageReference
Public Methods
 MethodDefined By
  
addEventListenerPageReference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
PageReference
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
PageReference
 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
 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
  
getElements():Object
Resolves the object specifier, creating an array of object references.
PageReference
 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
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
PageReference
 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
  
remove():void
Deletes the PageReference.
PageReference
  
removeEventListenerPageReference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
PageReference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
Retrieves the object specifier.
PageReference
 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
Property Detail
eventListenersproperty
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
idproperty 
id:Number  [read-only]

The unique ID of the PageReference.


Implementation
    public function get id():Number
indexproperty 
index:Number  [read-only]

The index of the PageReference within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
nameproperty 
name:String

The name of the PageReference; this is an alias to the PageReference's label property.


Implementation
    public function get name():String
    public function set name(value:String):void
pageNumberStyleOverrideproperty 
pageNumberStyleOverride:CharacterStyle

The character style applied to page numbers.


Implementation
    public function get pageNumberStyleOverride():CharacterStyle
    public function set pageNumberStyleOverride(value:CharacterStyle):void
pageReferenceLimitproperty 
pageReferenceLimit:Object

The paragraph style or number of paragraphs or pages that defines the last page in a page range. Note: Valid only when page reference type specifies the next use of a paragraph style or a number of paragraphs or pages. . Can return: ParagraphStyle or Long Integer.


Implementation
    public function get pageReferenceLimit():Object
    public function set pageReferenceLimit(value:Object):void
pageReferenceTypeproperty 
pageReferenceType:PageReferenceType

Options for index page references.


Implementation
    public function get pageReferenceType():PageReferenceType
    public function set pageReferenceType(value:PageReferenceType):void
parentproperty 
parent:Topic  [read-only]

The parent of the PageReference (a Topic).


Implementation
    public function get parent():Topic
propertiesproperty 
properties:Object

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
sourceTextproperty 
sourceText:Text  [read-only]

The hyperlinked text or insertion point.


Implementation
    public function get sourceText():Text
Method Detail
addEventListenerPageReference()method
public function addEventListenerPageReference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
getElements()method 
public function getElements():Object

Resolves the object specifier, creating an array of object references.

Returns
Object
insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

Sets the label to the value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

remove()method 
public function remove():void

Deletes the PageReference.

removeEventListenerPageReference()method 
public function removeEventListenerPageReference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String