Packagecom.adobe.indesign
Classpublic class PageReferenceType
InheritancePageReferenceType Inheritance CSEnumBase Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  currentPage : PageReferenceType
[static] [read-only] Alias for CURRENT_PAGE.
PageReferenceType
  CURRENT_PAGE : PageReferenceType
[static] [read-only] The page on which the index entry is located.
PageReferenceType
  enumCache : CSEnumSharedCache
[static] [read-only]
PageReferenceType
  forNextNPages : PageReferenceType
[static] [read-only] Alias for FOR_NEXT_N_PAGES.
PageReferenceType
  FOR_NEXT_N_PAGES : PageReferenceType
[static] [read-only] The range of pages from the page containing the inedex entry to the nth page after that page (where n is the number of pages to include).
PageReferenceType
  forNextNParagraphs : PageReferenceType
[static] [read-only] Alias for FOR_NEXT_N_PARAGRAPHS.
PageReferenceType
  FOR_NEXT_N_PARAGRAPHS : PageReferenceType
[static] [read-only] The range of pages from the page containing the index entry to the page containing the nth full paragraph from the paragraph containing the index entry (where n is the number of paragraphs to include).
PageReferenceType
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  suppressPageNumbers : PageReferenceType
[static] [read-only] Alias for SUPPRESS_PAGE_NUMBERS.
PageReferenceType
  SUPPRESS_PAGE_NUMBERS : PageReferenceType
[static] [read-only] Turns off page numbers for the index topic.
PageReferenceType
  toEndOfDocument : PageReferenceType
[static] [read-only] Alias for TO_END_OF_DOCUMENT.
PageReferenceType
  TO_END_OF_DOCUMENT : PageReferenceType
[static] [read-only] The last page in the document.
PageReferenceType
  toEndOfSection : PageReferenceType
[static] [read-only] Alias for TO_END_OF_SECTION.
PageReferenceType
  TO_END_OF_SECTION : PageReferenceType
[static] [read-only] The last page in the numbered section containing the index entry.
PageReferenceType
  toEndOfStory : PageReferenceType
[static] [read-only] Alias for TO_END_OF_STORY.
PageReferenceType
  TO_END_OF_STORY : PageReferenceType
[static] [read-only] The last page in the story containing the index entry.
PageReferenceType
  toNextStyleChange : PageReferenceType
[static] [read-only] Alias for TO_NEXT_STYLE_CHANGE.
PageReferenceType
  TO_NEXT_STYLE_CHANGE : PageReferenceType
[static] [read-only] The range of pages from the page containing the index entry to the page containing the next paragraph style change.
PageReferenceType
  toNextUseOfStyle : PageReferenceType
[static] [read-only] Alias for TO_NEXT_USE_OF_STYLE.
PageReferenceType
  TO_NEXT_USE_OF_STYLE : PageReferenceType
[static] [read-only] The range of pages from the page containing the index entry to the page that contains the next occurrance of the specified paragraph style.
PageReferenceType
 Inheritedvalue : Object
[read-only] Returns the numerical value
CSEnumBase
Public Methods
 MethodDefined By
  
PageReferenceType(ho:HostObject = null, enum:Number)
Constructor
PageReferenceType
 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
 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
 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
Property Detail
CURRENT_PAGEproperty
CURRENT_PAGE:PageReferenceType  [read-only]

The page on which the index entry is located.


Implementation
    public static function get CURRENT_PAGE():PageReferenceType
currentPageproperty 
currentPage:PageReferenceType  [read-only]

Alias for CURRENT_PAGE. The page on which the index entry is located.


Implementation
    public static function get currentPage():PageReferenceType
enumCacheproperty 
enumCache:CSEnumSharedCache  [read-only]


Implementation
    public static function get enumCache():CSEnumSharedCache
FOR_NEXT_N_PAGESproperty 
FOR_NEXT_N_PAGES:PageReferenceType  [read-only]

The range of pages from the page containing the inedex entry to the nth page after that page (where n is the number of pages to include).


Implementation
    public static function get FOR_NEXT_N_PAGES():PageReferenceType
FOR_NEXT_N_PARAGRAPHSproperty 
FOR_NEXT_N_PARAGRAPHS:PageReferenceType  [read-only]

The range of pages from the page containing the index entry to the page containing the nth full paragraph from the paragraph containing the index entry (where n is the number of paragraphs to include).


Implementation
    public static function get FOR_NEXT_N_PARAGRAPHS():PageReferenceType
forNextNPagesproperty 
forNextNPages:PageReferenceType  [read-only]

Alias for FOR_NEXT_N_PAGES. The range of pages from the page containing the inedex entry to the nth page after that page (where n is the number of pages to include).


Implementation
    public static function get forNextNPages():PageReferenceType
forNextNParagraphsproperty 
forNextNParagraphs:PageReferenceType  [read-only]

Alias for FOR_NEXT_N_PARAGRAPHS. The range of pages from the page containing the index entry to the page containing the nth full paragraph from the paragraph containing the index entry (where n is the number of paragraphs to include).


Implementation
    public static function get forNextNParagraphs():PageReferenceType
SUPPRESS_PAGE_NUMBERSproperty 
SUPPRESS_PAGE_NUMBERS:PageReferenceType  [read-only]

Turns off page numbers for the index topic.


Implementation
    public static function get SUPPRESS_PAGE_NUMBERS():PageReferenceType
suppressPageNumbersproperty 
suppressPageNumbers:PageReferenceType  [read-only]

Alias for SUPPRESS_PAGE_NUMBERS. Turns off page numbers for the index topic.


Implementation
    public static function get suppressPageNumbers():PageReferenceType
TO_END_OF_DOCUMENTproperty 
TO_END_OF_DOCUMENT:PageReferenceType  [read-only]

The last page in the document.


Implementation
    public static function get TO_END_OF_DOCUMENT():PageReferenceType
TO_END_OF_SECTIONproperty 
TO_END_OF_SECTION:PageReferenceType  [read-only]

The last page in the numbered section containing the index entry.


Implementation
    public static function get TO_END_OF_SECTION():PageReferenceType
TO_END_OF_STORYproperty 
TO_END_OF_STORY:PageReferenceType  [read-only]

The last page in the story containing the index entry.


Implementation
    public static function get TO_END_OF_STORY():PageReferenceType
TO_NEXT_STYLE_CHANGEproperty 
TO_NEXT_STYLE_CHANGE:PageReferenceType  [read-only]

The range of pages from the page containing the index entry to the page containing the next paragraph style change.


Implementation
    public static function get TO_NEXT_STYLE_CHANGE():PageReferenceType
TO_NEXT_USE_OF_STYLEproperty 
TO_NEXT_USE_OF_STYLE:PageReferenceType  [read-only]

The range of pages from the page containing the index entry to the page that contains the next occurrance of the specified paragraph style. If no paragraph style is specified, the paragraph style of the index entry paragraph is used.


Implementation
    public static function get TO_NEXT_USE_OF_STYLE():PageReferenceType
toEndOfDocumentproperty 
toEndOfDocument:PageReferenceType  [read-only]

Alias for TO_END_OF_DOCUMENT. The last page in the document.


Implementation
    public static function get toEndOfDocument():PageReferenceType
toEndOfSectionproperty 
toEndOfSection:PageReferenceType  [read-only]

Alias for TO_END_OF_SECTION. The last page in the numbered section containing the index entry.


Implementation
    public static function get toEndOfSection():PageReferenceType
toEndOfStoryproperty 
toEndOfStory:PageReferenceType  [read-only]

Alias for TO_END_OF_STORY. The last page in the story containing the index entry.


Implementation
    public static function get toEndOfStory():PageReferenceType
toNextStyleChangeproperty 
toNextStyleChange:PageReferenceType  [read-only]

Alias for TO_NEXT_STYLE_CHANGE. The range of pages from the page containing the index entry to the page containing the next paragraph style change.


Implementation
    public static function get toNextStyleChange():PageReferenceType
toNextUseOfStyleproperty 
toNextUseOfStyle:PageReferenceType  [read-only]

Alias for TO_NEXT_USE_OF_STYLE. The range of pages from the page containing the index entry to the page that contains the next occurrance of the specified paragraph style. If no paragraph style is specified, the paragraph style of the index entry paragraph is used.


Implementation
    public static function get toNextUseOfStyle():PageReferenceType
Constructor Detail
PageReferenceType()Constructor
public function PageReferenceType(ho:HostObject = null, enum:Number)

Constructor

Parameters
ho:HostObject (default = null) — Enumerations value
 
enum:Number (default = NaN)