Package | com.adobe.indesign |
Class | public class PageReferenceType |
Inheritance | PageReferenceType ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 | ||
![]() | value : Object [read-only]
Returns the numerical value
| CSEnumBase |
Method | Defined By | ||
---|---|---|---|
PageReferenceType(ho:HostObject = null, enum:Number)
Constructor
| PageReferenceType | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | 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 | |
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | 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 | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
CURRENT_PAGE | property |
CURRENT_PAGE:PageReferenceType
[read-only] Since : | CS5 |
The page on which the index entry is located.
public static function get CURRENT_PAGE():PageReferenceType
currentPage | property |
currentPage:PageReferenceType
[read-only] Since : | CS5 |
Alias for CURRENT_PAGE. The page on which the index entry is located.
public static function get currentPage():PageReferenceType
enumCache | property |
enumCache:CSEnumSharedCache
[read-only] Since : | CS5 |
public static function get enumCache():CSEnumSharedCache
FOR_NEXT_N_PAGES | property |
FOR_NEXT_N_PAGES:PageReferenceType
[read-only] Since : | CS5 |
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).
public static function get FOR_NEXT_N_PAGES():PageReferenceType
FOR_NEXT_N_PARAGRAPHS | property |
FOR_NEXT_N_PARAGRAPHS:PageReferenceType
[read-only] Since : | CS5 |
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).
public static function get FOR_NEXT_N_PARAGRAPHS():PageReferenceType
forNextNPages | property |
forNextNPages:PageReferenceType
[read-only] Since : | CS5 |
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).
public static function get forNextNPages():PageReferenceType
forNextNParagraphs | property |
forNextNParagraphs:PageReferenceType
[read-only] Since : | CS5 |
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).
public static function get forNextNParagraphs():PageReferenceType
SUPPRESS_PAGE_NUMBERS | property |
SUPPRESS_PAGE_NUMBERS:PageReferenceType
[read-only] Since : | CS5 |
Turns off page numbers for the index topic.
public static function get SUPPRESS_PAGE_NUMBERS():PageReferenceType
suppressPageNumbers | property |
suppressPageNumbers:PageReferenceType
[read-only] Since : | CS5 |
Alias for SUPPRESS_PAGE_NUMBERS. Turns off page numbers for the index topic.
public static function get suppressPageNumbers():PageReferenceType
TO_END_OF_DOCUMENT | property |
TO_END_OF_DOCUMENT:PageReferenceType
[read-only] Since : | CS5 |
The last page in the document.
public static function get TO_END_OF_DOCUMENT():PageReferenceType
TO_END_OF_SECTION | property |
TO_END_OF_SECTION:PageReferenceType
[read-only] Since : | CS5 |
The last page in the numbered section containing the index entry.
public static function get TO_END_OF_SECTION():PageReferenceType
TO_END_OF_STORY | property |
TO_END_OF_STORY:PageReferenceType
[read-only] Since : | CS5 |
The last page in the story containing the index entry.
public static function get TO_END_OF_STORY():PageReferenceType
TO_NEXT_STYLE_CHANGE | property |
TO_NEXT_STYLE_CHANGE:PageReferenceType
[read-only] Since : | CS5 |
The range of pages from the page containing the index entry to the page containing the next paragraph style change.
public static function get TO_NEXT_STYLE_CHANGE():PageReferenceType
TO_NEXT_USE_OF_STYLE | property |
TO_NEXT_USE_OF_STYLE:PageReferenceType
[read-only] Since : | CS5 |
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.
public static function get TO_NEXT_USE_OF_STYLE():PageReferenceType
toEndOfDocument | property |
toEndOfDocument:PageReferenceType
[read-only] Since : | CS5 |
Alias for TO_END_OF_DOCUMENT. The last page in the document.
public static function get toEndOfDocument():PageReferenceType
toEndOfSection | property |
toEndOfSection:PageReferenceType
[read-only] Since : | CS5 |
Alias for TO_END_OF_SECTION. The last page in the numbered section containing the index entry.
public static function get toEndOfSection():PageReferenceType
toEndOfStory | property |
toEndOfStory:PageReferenceType
[read-only] Since : | CS5 |
Alias for TO_END_OF_STORY. The last page in the story containing the index entry.
public static function get toEndOfStory():PageReferenceType
toNextStyleChange | property |
toNextStyleChange:PageReferenceType
[read-only] Since : | CS5 |
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.
public static function get toNextStyleChange():PageReferenceType
toNextUseOfStyle | property |
toNextUseOfStyle:PageReferenceType
[read-only] Since : | CS5 |
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.
public static function get toNextUseOfStyle():PageReferenceType
PageReferenceType | () | Constructor |
public function PageReferenceType(ho:HostObject = null, enum:Number)
Since : | CS5 |
Constructor
Parametersho:HostObject (default = null ) — Enumerations value
| |
enum:Number (default = NaN )
|