Package | com.adobe.indesign |
Class | public class IndexCapitalizationOptions |
Inheritance | IndexCapitalizationOptions ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
allEntries : IndexCapitalizationOptions [static] [read-only] Alias for ALL_ENTRIES. | IndexCapitalizationOptions | ||
ALL_ENTRIES : IndexCapitalizationOptions [static] [read-only]
Capitalizes all index entries. | IndexCapitalizationOptions | ||
allLevel1Entries : IndexCapitalizationOptions [static] [read-only] Alias for ALL_LEVEL_1_ENTRIES. | IndexCapitalizationOptions | ||
ALL_LEVEL_1_ENTRIES : IndexCapitalizationOptions [static] [read-only]
Capitalizes all level 1 entries. | IndexCapitalizationOptions | ||
enumCache : CSEnumSharedCache [static] [read-only] | IndexCapitalizationOptions | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
includeSubentries : IndexCapitalizationOptions [static] [read-only] Alias for INCLUDE_SUBENTRIES. | IndexCapitalizationOptions | ||
INCLUDE_SUBENTRIES : IndexCapitalizationOptions [static] [read-only]
Capitalizes the specified topic and its nested topics. | IndexCapitalizationOptions | ||
selectedEntry : IndexCapitalizationOptions [static] [read-only] Alias for SELECTED_ENTRY. | IndexCapitalizationOptions | ||
SELECTED_ENTRY : IndexCapitalizationOptions [static] [read-only]
Capitalizes the specified topic but does not capitalize its nested topics. | IndexCapitalizationOptions | ||
![]() | value : Object [read-only]
Returns the numerical value
| CSEnumBase |
Method | Defined By | ||
---|---|---|---|
IndexCapitalizationOptions(ho:HostObject = null, enum:Number)
Constructor
| IndexCapitalizationOptions | ||
![]() | 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 |
ALL_ENTRIES | property |
ALL_ENTRIES:IndexCapitalizationOptions
[read-only] Since : | CS5 |
Capitalizes all index entries. Note: Capitalizes only topics created before the capitalization statement appears in the script.
public static function get ALL_ENTRIES():IndexCapitalizationOptions
ALL_LEVEL_1_ENTRIES | property |
ALL_LEVEL_1_ENTRIES:IndexCapitalizationOptions
[read-only] Since : | CS5 |
Capitalizes all level 1 entries. Note: Capitalizes only topics created before the capitalization statement appears in the script.
public static function get ALL_LEVEL_1_ENTRIES():IndexCapitalizationOptions
allEntries | property |
allEntries:IndexCapitalizationOptions
[read-only] Since : | CS5 |
Alias for ALL_ENTRIES. Capitalizes all index entries. Note: Capitalizes only topics created before the capitalization statement appears in the script.
public static function get allEntries():IndexCapitalizationOptions
allLevel1Entries | property |
allLevel1Entries:IndexCapitalizationOptions
[read-only] Since : | CS5 |
Alias for ALL_LEVEL_1_ENTRIES. Capitalizes all level 1 entries. Note: Capitalizes only topics created before the capitalization statement appears in the script.
public static function get allLevel1Entries():IndexCapitalizationOptions
enumCache | property |
enumCache:CSEnumSharedCache
[read-only] Since : | CS5 |
public static function get enumCache():CSEnumSharedCache
INCLUDE_SUBENTRIES | property |
INCLUDE_SUBENTRIES:IndexCapitalizationOptions
[read-only] Since : | CS5 |
Capitalizes the specified topic and its nested topics. Valid only as parameter of the topic capitalize method; cannot be used as a parameter of the index capitalize method. Note: Must occur after the selected topic and its nested subtopics are created.
public static function get INCLUDE_SUBENTRIES():IndexCapitalizationOptions
includeSubentries | property |
includeSubentries:IndexCapitalizationOptions
[read-only] Since : | CS5 |
Alias for INCLUDE_SUBENTRIES. Capitalizes the specified topic and its nested topics. Valid only as parameter of the topic capitalize method; cannot be used as a parameter of the index capitalize method. Note: Must occur after the selected topic and its nested subtopics are created.
public static function get includeSubentries():IndexCapitalizationOptions
SELECTED_ENTRY | property |
SELECTED_ENTRY:IndexCapitalizationOptions
[read-only] Since : | CS5 |
Capitalizes the specified topic but does not capitalize its nested topics. Valid only as parameter of the topic capitalize method; cannot be used as a parameter of the index capitalize method. Note: Must occur after the specified topic and its nested topics are created.
public static function get SELECTED_ENTRY():IndexCapitalizationOptions
selectedEntry | property |
selectedEntry:IndexCapitalizationOptions
[read-only] Since : | CS5 |
Alias for SELECTED_ENTRY. Capitalizes the specified topic but does not capitalize its nested topics. Valid only as parameter of the topic capitalize method; cannot be used as a parameter of the index capitalize method. Note: Must occur after the specified topic and its nested topics are created.
public static function get selectedEntry():IndexCapitalizationOptions
IndexCapitalizationOptions | () | Constructor |
public function IndexCapitalizationOptions(ho:HostObject = null, enum:Number)
Since : | CS5 |
Constructor
Parametersho:HostObject (default = null ) — Enumerations value
| |
enum:Number (default = NaN )
|