### Basics Suite Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest?q=%2FextendscriptAPI%2Findesign-latest%2Fabout.html Core objects and functionalities provided by the Basics Suite for InDesign scripting. ```APIDOC ## Basics Suite API ### Description The Basics Suite encompasses fundamental objects and event handling mechanisms essential for InDesign scripting. ### Objects - **Application** - **BackgroundTask** - **BackgroundTasks** - **ContentPlacerObject** - **Document** - **DocumentEvent** - **Documents** - **Event** - **EventListener** - **EventListeners** - **Events** - **IdleEvent** - **IdleTask** - **IdleTasks** - **ImportExportEvent** - **LayoutWindow** - **LayoutWindows** - **MutationEvent** - **PlaceGun** - **PrintEvent** - **ScriptArg** - **StoryWindow** - **StoryWindows** - **Window** - **Windows** ``` -------------------------------- ### Preferences API Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest This section details various preference settings available in the InDesign ExtendScript API. ```APIDOC ## InDesign ExtendScript API Preferences This API provides access to a wide range of InDesign preferences that can be manipulated via ExtendScript. ### Available Preference Objects: - DisplayPerformancePreference - DisplaySetting - DisplaySettings - DocumentPreference - DocumentPreset - DocumentPresets - DropShadowSetting - EPSExportPreference - EPSImportPreference - EPubExportPreference - EPubExportPreviewAppPreference - EPubFixedLayoutExportPreference - EndnoteOption - ExcelImportPreference - ExportForWebPreference - FeatherSetting - FileNameVariablePreference - FillTransparencySetting - FindChangeBevelAndEmbossSetting - FindChangeBlendingSetting - FindChangeColorOption - FindChangeContentTransparencySetting - FindChangeDirectionalFeatherSetting - FindChangeDropShadowSetting - FindChangeFeatherSetting - FindChangeFillTransparencySetting - FindChangeGlyphOption - FindChangeGradientFeatherSetting - FindChangeGrepOption - FindChangeInnerGlowSetting - FindChangeInnerShadowSetting - FindChangeObjectOption - FindChangeOuterGlowSetting - FindChangeSatinSetting - FindChangeStrokeTransparencySetting - FindChangeTextOption - FindChangeTransliterateOption - FindChangeTransparencySetting - FindColorPreference - FindGlyphPreference - FindGrepPreference - FindObjectPreference - FindTextPreference - FindTransliteratePreference - FlattenerPreference - FlattenerPreset - FlattenerPresets - FontLockingPreference - FontSyncPreference - FootnoteOption - GalleyPreference - GeneralPreference - GpuPerformancePreference - GrabberPreference - GradientFeatherSetting - GraphicLayer - GraphicLayerOption - GraphicLayers - GridDataInformation - GridPreference - GridPrintingPreference - GuidePreference - HTMLExportPreference - HTMLFXLExportPreference - IMEPreference - ImageIOPreference - ImagePreference - ImportedPageItemOption - InCopyExportOption - InnerGlowSetting - InnerShadowSetting - InteractivePDFExportPreference - JPEGExportPreference - LayoutGridDataInformation - LinkedPageItemOption - LinkedStoryOption - LinkingPreference - MarginPreference - MatchCharacterStylePreference - MatchParagraphStylePreference - MetadataPreference - MojikumiUiPreference - NotePreference - ObjectExportOption - ObjectStyleContentEffectsCategorySettings - ObjectStyleFillEffectsCategorySettings - ObjectStyleObjectEffectsCategorySettings - ObjectStyleStrokeEffectsCategorySettings - OuterGlowSetting - PDFExportPreference - PDFExportPreset - PDFExportPresets - PDFPlacePreference - PNGExportPreference - PageItemDefault - PageNumberVariablePreference - ParaStyleMapping - ParaStyleMappings - PasteboardPreference - PolygonPreference - Preference - Preferences - PreflightBookOption - PreflightOption - PrintBookletOption - PrintBookletPrintPreference - PrintPreference - PrinterPreset - PrinterPresets - PublishExportPreference - SatinSetting - ScriptPreference - SmartGuidePreference - SpellPreference - StoryGridDataInformation - StoryPreference - StrokeFillProxySetting - StrokeTransparencySetting - TableStyleMapping - TableStyleMappings - TaggedPDFPreference - TaggedTextExportPreference - TaggedTextImportPreference - TextDefault - TextEditingPreference - TextExportPreference - TextFramePreference - TextImportPreference - TextPreference - ToolBox - TrackChangesPreference - TransformPreference - TransparencyPreference - TransparencySetting - TypeContextualUiPreference - ViewPreference - WatermarkPreference - WordRTFImportPreference - XMLExportPreference - XMLImportPreference - XMLPreference - XMLViewPreference Each of these objects represents a specific area of InDesign's settings that can be accessed and modified programmatically. ``` -------------------------------- ### Color Suite Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest?q=%2FextendscriptAPI%2Findesign-latest%2Fabout.html Objects and functionalities for handling colors, gradients, and swatches in InDesign. ```APIDOC ## Color Suite API ### Description The Color Suite offers comprehensive tools for managing colors, gradients, inks, and swatches within InDesign documents. ### Objects - **Color** - **ColorGroup** - **ColorGroupSwatch** - **ColorGroupSwatches** - **ColorGroups** - **Colors** - **Gradient** - **GradientStop** - **GradientStops** - **Gradients** - **Ink** - **Inks** - **MixedInk** - **MixedInkGroup** - **MixedInkGroups** - **MixedInks** - **OpacityGradientStop** - **OpacityGradientStops** - **Swatch** - **Swatches** - **Tint** - **Tints** - **TrapPreset** - **TrapPresets** ``` -------------------------------- ### Indexing Suite Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest/#about.html APIs for creating and managing indexes in InDesign documents, including cross-references and index entries. ```APIDOC ## Indexing Suite This suite offers tools for generating and manipulating indexes within InDesign documents. ### Available Indexing Components: * CrossReference * CrossReferences * Index * IndexOptions * IndexSection * IndexSections * Indexes * PageReference * PageReferences ``` -------------------------------- ### Enumerations and Options Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest/#about.html A comprehensive list of enumerations and options available in the InDesign ExtendScript API for various features and settings. ```APIDOC ## Enumerations and Options This section lists various enumerations and options available in the InDesign ExtendScript API. ### Available Options and Enums: * ParagraphDirectionOptions * ParagraphJustificationOptions * ParagraphShadingBottomOriginEnum * ParagraphShadingTopOriginEnum * ParagraphShadingWidthEnum * PathType * PathTypeAlignments * PdfDisplayTitleOptions * PdfMagnificationOptions * PerformanceMetricOptions * PlacedVectorProfilePolicy * PlayOperations * PointType * Position * PositionAttributes * PositionalForms * PostScriptLevels * PreflightLayerOptions * PreflightProfileOptions * PreflightRuleFlag * PreflightScopeOptions * PreserveAppearanceFromLayoutEnum * PreviewPagesOptions * PreviewSizeOptions * PreviewTypes * PrintLayerOptions * PrintPageOrientation * Printer * PrinterPresetTypes * Profile * ProofingType * PublishCoverEnum * PublishFormatEnum * RangeSortOrder * RasterResolutionOptions * RecordSelection * RecordsPerPage * RenderingIntent * RepaginateOption * ResizeConstraints * ResizeMethods * ResolveStyleClash * RestartPolicy * RotationDirection * RowTypes * RubyAlignments * RubyKentenPosition * RubyOverhang * RubyParentSpacing * RubyTypes * RuleDataType * RuleWidth * RulerOrigin * Sampling * SaveOptions * ScaleModes * Screeening * ScreenModeOptions * ScriptLanguage * SearchModes * SearchStrategies * SelectAll * SelectionOptions * Sequences * ShadowMode * SignatureSizeOptions * SingleWordJustification * SizeTypeEnum * SmartMatchOptions * SmoothScrollingOptions * SnapshotBlendingModes * SortAssets * SoundPosterTypes * SourceFieldType * SourceSpaces * SourceType * Spacing * SpanColumnCountOptions * SpanColumnTypeOptions * SpecialCharacters * SpreadFlattenerLevel * StartParagraph * StateTypes * StaticAlignmentOptions * StoryDirectionOptions * StoryHorizontalOrVertical * StoryTypes * StrokeAlignment * StrokeCornerAdjustment * StrokeFillProxyOptions * StrokeFillTargetOptions * StrokeOrderTypes * StyleConflict * StyleType * SyncConflictResolution * TabStopAlignment * TableDirectionOptions * TableFormattingOptions * TagRaster * TagTextExportCharacterSet * TagTextForm * TagTransparency * TagType * TagVector * TaggedPDFStructureOrderOptions * TaskAlertType * TaskState * TextDirection * TextExportCharacterSet * TextFrameContents * TextImportCharacterSet * TextPathEffects * TextStrokeAlign * TextTypeAlignments * TextWrapModes * TextWrapSideOptions * ThreadedTextFrameTextOptions * ThumbsPerPage * TilingTypes * ToolTipOptions * ToolsPanelOptions * TransformPositionReference * TrapEndTypes * TrapImagePlacementTypes * Trapping * UIColors * UITools * UndoModes * UpdateLinkOptions * UseSVGAsEnum * UserInteractionLevels * VariableNumberingStyles * VariableScopes * VariableTypes * VersionCueSyncStatus * VersionState * VerticalAlignment * VerticalJustification * VerticallyRelativeTo * ViewDisplaySettings * ViewZoomStyle * WarichuAlignment * WatermarkHorizontalPositionEnum * WatermarkVerticalPositionEnum * WhenScalingOptions * XMLElementLocation * XMLElementPosition * XMLExportUntaggedTablesFormat * XMLFileEncoding * XMLImportStyles * XMLTransformFile * ZoomOptions ``` -------------------------------- ### Preflight Suite API Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest This section details the Preflight Suite API for managing preflight profiles and rules. ```APIDOC ## Preflight Suite API This API allows for the management and execution of preflight checks within InDesign. ### Available Preflight Objects: - PreflightProcess - PreflightProcesses - PreflightProfile - PreflightProfileRule - PreflightProfileRules - PreflightProfiles - PreflightRule - PreflightRuleInstance - PreflightRuleInstances - PreflightRules - RuleDataObject - RuleDataObjects These objects facilitate the creation, modification, and application of preflight profiles and rules to ensure document compliance. ``` -------------------------------- ### Preflight Suite API Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest?q=%2FextendscriptAPI%2Findesign-latest%2Fabout.html API for managing preflight profiles, rules, and processes to ensure document compliance. ```APIDOC ## Preflight Suite API ### Description This suite provides tools for defining, managing, and executing preflight checks on InDesign documents to ensure they meet specific publishing standards. ### Objects - **PreflightProcess**: Represents a single preflight check or a series of checks. - **PreflightProcesses**: A collection of `PreflightProcess` objects. - **PreflightProfile**: Defines a set of rules and conditions for preflighting. - **PreflightProfileRule**: A specific rule within a preflight profile. - **PreflightProfileRules**: A collection of `PreflightProfileRule` objects. - **PreflightProfiles**: A collection of `PreflightProfile` objects. - **PreflightRule**: Represents a single, reusable preflight rule. - **PreflightRuleInstance**: An instance of a `PreflightRule` applied within a profile. - **PreflightRuleInstances**: A collection of `PreflightRuleInstance` objects. - **PreflightRules**: A collection of `PreflightRule` objects. - **RuleDataObject**: Represents data associated with a preflight rule. - **RuleDataObjects**: A collection of `RuleDataObject` objects. ### Usage These objects allow for the creation and management of preflight profiles and the execution of preflight checks programmatically. ```javascript // Example: Accessing preflight profiles var profiles = app.preflight.preflightProfiles; // Example: Creating a new preflight profile (conceptual) // var newProfile = profiles.add({ name: "My Custom Profile" }); ``` ``` -------------------------------- ### Book Suite Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest?q=%2FextendscriptAPI%2Findesign-latest%2Fabout.html Objects related to managing books and their contents in InDesign. ```APIDOC ## Book Suite API ### Description The Book Suite provides objects for managing InDesign books, including their structure and content. ### Objects - **Book** - **BookContent** - **BookContents** - **Books** ``` -------------------------------- ### InDesign Object Model Hierarchy Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest?q=%2FextendscriptAPI%2Findesign-latest%2Fabout.html Overview of the InDesign object model, showing the relationships between core objects like Application, Document, Page, and their properties. ```APIDOC ## InDesign Object Model ### Description This section outlines the hierarchical structure of the InDesign object model, detailing key objects and their relationships. ### Object Hierarchy - **Application** - **Document** - MasterSpread - Spread - Page - PageItem - Graphic - Image - Group - TextFrame - Story - Paragraph - ParagraphStyle - Character - CharacterStyle - Table - TableStyle - Row - Cell - CellStyle - Link - Story - Paragraph - Text - Table - Row - Column - Cell - Swatch - Tint - Color - **Book** - **FindGrepPreference** - **ChangeGrepPreference** - **ScriptPreference** - **Font** ``` -------------------------------- ### Preferences API Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest?q=%2FextendscriptAPI%2Findesign-latest%2Fabout.html This section details various preference objects available in the InDesign ExtendScript API for customizing application behavior. ```APIDOC ## Preferences API ### Description Provides access to a wide range of InDesign application preferences. ### Endpoints This API does not expose specific endpoints but rather a collection of preference objects that can be accessed and modified. ### Preference Objects - **DisplayPerformancePreference**: Controls display performance settings. - **DisplaySetting**: Represents a single display setting. - **DisplaySettings**: A collection of display settings. - **DocumentPreference**: Settings related to document creation and behavior. - **DocumentPreset**: Defines a preset for document settings. - **DocumentPresets**: A collection of document presets. - **DropShadowSetting**: Configuration for drop shadow effects. - **EPSExportPreference**: Preferences for EPS file export. - **EPSImportPreference**: Preferences for EPS file import. - **EPubExportPreference**: Preferences for EPUB file export. - **EPubExportPreviewAppPreference**: Preferences for EPUB export preview application. - **EPubFixedLayoutExportPreference**: Preferences for fixed-layout EPUB export. - **EndnoteOption**: Options for endnotes. - **ExcelImportPreference**: Preferences for importing Excel files. - **ExportForWebPreference**: Preferences for exporting assets for the web. - **FeatherSetting**: Configuration for feathering effects. - **FileNameVariablePreference**: Preferences for filename variables. - **FillTransparencySetting**: Settings for fill transparency. - **FindChangeBevelAndEmbossSetting**: Settings for find/change bevel and emboss. - **FindChangeBlendingSetting**: Settings for find/change blending modes. - **FindChangeColorOption**: Options for finding and changing colors. - **FindChangeContentTransparencySetting**: Settings for find/change content transparency. - **FindChangeDirectionalFeatherSetting**: Settings for find/change directional feather. - **FindChangeDropShadowSetting**: Settings for find/change drop shadows. - **FindChangeFeatherSetting**: Settings for find/change feather effects. - **FindChangeFillTransparencySetting**: Settings for find/change fill transparency. - **FindChangeGlyphOption**: Options for finding and changing glyphs. - **FindChangeGradientFeatherSetting**: Settings for find/change gradient feather. - **FindChangeGrepOption**: Options for finding and changing using GREP. - **FindChangeInnerGlowSetting**: Settings for find/change inner glows. - **FindChangeInnerShadowSetting**: Settings for find/change inner shadows. - **FindChangeObjectOption**: Options for finding and changing objects. - **FindChangeOuterGlowSetting**: Settings for find/change outer glows. - **FindChangeSatinSetting**: Settings for find/change satin effects. - **FindChangeStrokeTransparencySetting**: Settings for find/change stroke transparency. - **FindChangeTextOption**: Options for finding and changing text. - **FindChangeTransliterateOption**: Options for finding and changing transliterations. - **FindChangeTransparencySetting**: General settings for find/change transparency. - **FindColorPreference**: Preferences for color searching. - **FindGlyphPreference**: Preferences for glyph searching. - **FindGrepPreference**: Preferences for GREP searching. - **FindObjectPreference**: Preferences for object searching. - **FindTextPreference**: Preferences for text searching. - **FindTransliteratePreference**: Preferences for transliteration searching. - **FlattenerPreference**: Settings for the flattener. - **FlattenerPreset**: Defines a preset for the flattener. - **FlattenerPresets**: A collection of flattener presets. - **FontLockingPreference**: Preferences for font locking. - **FontSyncPreference**: Preferences for font synchronization. - **FootnoteOption**: Options for footnotes. - **GalleyPreference**: Preferences for galley view. - **GeneralPreference**: General application preferences. - **GpuPerformancePreference**: Preferences for GPU performance. - **GrabberPreference**: Preferences for the grabber tool. - **GradientFeatherSetting**: Configuration for gradient feather effects. - **GraphicLayer**: Represents a graphic layer. - **GraphicLayerOption**: Options for graphic layers. - **GraphicLayers**: A collection of graphic layers. - **GridDataInformation**: Information about grid data. - **GridPreference**: Preferences for grids. - **GridPrintingPreference**: Preferences for grid printing. - **GuidePreference**: Preferences for guides. - **HTMLExportPreference**: Preferences for HTML export. - **HTMLFXLExportPreference**: Preferences for HTMLFXL export. - **IMEPreference**: Preferences for Input Method Editor. - **ImageIOPreference**: Preferences for Image I/O. - **ImagePreference**: General image preferences. - **ImportedPageAttribute**: Attributes of imported pages. - **InCopyExportOption**: Options for exporting to InCopy. - **InnerGlowSetting**: Configuration for inner glow effects. - **InnerShadowSetting**: Configuration for inner shadow effects. - **InteractivePDFExportPreference**: Preferences for interactive PDF export. - **JPEGExportPreference**: Preferences for JPEG export. - **LayoutGridDataInformation**: Information about layout grid data. - **LinkedPageItemOption**: Options for linked page items. - **LinkedStoryOption**: Options for linked stories. - **LinkingPreference**: Preferences for linking assets. - **MarginPreference**: Preferences for page margins. - **MatchCharacterStylePreference**: Preferences for matching character styles. - **MatchParagraphStylePreference**: Preferences for matching paragraph styles. - **MetadataPreference**: Preferences for metadata. - **MojikumiUiPreference**: Preferences for Mojikumi UI. - **NotePreference**: Preferences for notes. - **ObjectExportOption**: Options for exporting objects. - **ObjectStyleContentEffectsCategorySettings**: Settings for object style content effects. - **ObjectStyleFillEffectsCategorySettings**: Settings for object style fill effects. - **ObjectStyleObjectEffectsCategorySettings**: Settings for object style object effects. - **ObjectStyleStrokeEffectsCategorySettings**: Settings for object style stroke effects. - **OuterGlowSetting**: Configuration for outer glow effects. - **PDFExportPreference**: Preferences for PDF export. - **PDFExportPreset**: Defines a preset for PDF export. - **PDFExportPresets**: A collection of PDF export presets. - **PDFPlacePreference**: Preferences for placing PDF files. - **PNGExportPreference**: Preferences for PNG export. - **PageItemDefault**: Default settings for page items. - **PageNumberVariablePreference**: Preferences for page number variables. - **ParaStyleMapping**: Mapping for paragraph styles. - **ParaStyleMappings**: A collection of paragraph style mappings. - **PasteboardPreference**: Preferences for the pasteboard. - **PolygonPreference**: Preferences for polygons. - **Preference**: Base preference object. - **Preferences**: Collection of all preferences. - **PreflightBookOption**: Options for preflighting books. - **PreflightOption**: General preflight options. - **PrintBookletOption**: Options for printing booklets. - **PrintBookletPrintPreference**: Print preferences for booklets. - **PrintPreference**: General print preferences. - **PrinterPreset**: Defines a preset for printers. - **PrinterPresets**: A collection of printer presets. - **PublishExportPreference**: Preferences for publishing and exporting. - **SatinSetting**: Configuration for satin effects. - **ScriptPreference**: Preferences for scripting. - **SmartGuidePreference**: Preferences for smart guides. - **SpellPreference**: Preferences for spell checking. - **StoryGridDataInformation**: Information about story grid data. - **StoryPreference**: Preferences for stories. - **StrokeFillProxySetting**: Settings for stroke/fill proxy. - **StrokeTransparencySetting**: Settings for stroke transparency. - **TableStyleMapping**: Mapping for table styles. - **TableStyleMappings**: A collection of table style mappings. - **TaggedPDFPreference**: Preferences for tagged PDF export. - **TaggedTextExportPreference**: Preferences for tagged text export. - **TaggedTextImportPreference**: Preferences for tagged text import. - **TextDefault**: Default settings for text. - **TextEditingPreference**: Preferences for text editing. - **TextExportPreference**: Preferences for text export. - **TextFramePreference**: Preferences for text frames. - **TextImportPreference**: Preferences for text import. - **TextPreference**: General text preferences. - **ToolBox**: Settings related to the toolbox. - **TrackChangesPreference**: Preferences for tracking changes. - **TransformPreference**: Preferences for transformations. - **TransparencyPreference**: General transparency preferences. - **TransparencySetting**: Configuration for transparency effects. - **TypeContextualUiPreference**: Preferences for contextual UI for type. - **ViewPreference**: Preferences for viewing. - **WatermarkPreference**: Preferences for watermarks. - **WordRTFImportPreference**: Preferences for importing Word RTF. - **XMLExportPreference**: Preferences for XML export. - **XMLImportPreference**: Preferences for XML import. - **XMLPreference**: General XML preferences. - **XMLViewPreference**: Preferences for XML view. ### Usage These objects are typically accessed via the `app.preferences` object in ExtendScript. For example: ```javascript // Get the current pasteboard preference var pasteboardPrefs = app.preferences.pasteboardPreference; // Set a new pasteboard width pasteboardPrefs.pasteboardWidth = 72; // in points ``` ``` -------------------------------- ### InDesign Enum Suite Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest This section lists and describes the various enumerations available in the InDesign ExtendScript API, which are used to define specific states, options, or types for object properties and methods. ```APIDOC ## InDesign Enum Suite ### Description This section lists and describes the various enumerations available in the InDesign ExtendScript API, which are used to define specific states, options, or types for object properties and methods. ### Enumerations - **AcrobatCompatibility** - **AddPageOptions** - **AdornmentOverprint** - **AlignDistributeBounds** - **AlignOptions** - **AlignmentStyleOptions** - **AlternateGlyphForms** - **AlternatingFillsTypes** - **AnchorPoint** - **AnchorPosition** - **AnchoredRelativeTo** - **AnimationEaseOptions** - **AnimationPlayOperations** - **AntiAliasType** - **ArrangeBy** - **ArrowHead** - **ArrowHeadAlignmentEnum** - **AssetType** - **AssignmentExportOptions** - **AssignmentStatus** - **AttachedDevices** - **AutoEnum** - **AutoSizingReferenceEnum** - **AutoSizingTypeEnum** - **BalanceLinesStyle** - **BaselineFrameGridRelativeOption** - **BaselineGridRelativeOption** - **BehaviorEvents** - **BevelAndEmbossDirection** - **BevelAndEmbossStyle** - **BevelAndEmbossTechnique** - **BindingOptions** - **BitmapCompression** - **BlendMode** - **BlendingSpace** - **BookContentStatus** - **BookletTypeOptions** - **BoundingBoxLimits** - **BuildingBlockTypes** - **BulletCharacterType** - **BulletListExportOption** - **Capitalization** - **CellTypeEnum** - **ChangeBackgroundColorChoices** - **ChangeCaseOptions** - **ChangeConditionsModes** - **ChangeMarkings** - **ChangeTextColorChoices** - **ChangeTypes** - **ChangebarLocations** - **ChangecaseMode** - **ChapterNumberSources** - **CharacterAlignment** - **CharacterCountLocation** - **CharacterDirectionOptions** - **ClippingPathType** - **ColorModel** - **ColorOutputModes** - **ColorRenderingDictionary** - **ColorSettingsPolicy** - **ColorSpace** - **CommentStatusEnum** - **CommentTypeEnum** - **ComposeUsing** - **CompressionQuality** - **ConditionIndicatorMethod** - **ConditionIndicatorMode** - **ConditionUnderlineIndicatorAppearance** - **ContainerType** - **ContentType** - **ContourOptionsTypes** - **ConvertPageBreaks** - **ConvertShapeOptions** - **ConvertTablesOptions** - **CoordinateSpaces** - **CopyrightStatus** - **CornerOptions** - **CreateProxy** - **CrossReferenceType** - **CursorTypes** - **CustomLayoutTypeEnum** - **DataFormat** - **DefaultRenderingIntent** - **DesignOptions** - **DiacriticPositionOptions** - **DigitsTypeOptions** - **DigpubArticleVersion** - **DigpubVersion** - **DimensionAttributes** ``` -------------------------------- ### Enum Suite Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest?q=%2FextendscriptAPI%2Findesign-latest%2Fabout.html Enumerations used within the InDesign ExtendScript API for various settings and options. ```APIDOC ## Enum Suite API ### Description The Enum Suite lists various enumerations that define options and values for different properties and methods within the InDesign ExtendScript API. ### Enumerations - **AcrobatCompatibility** - **AddPageOptions** - **AdornmentOverprint** - **AlignDistributeBounds** - **AlignOptions** - **AlignmentStyleOptions** - **AlternateGlyphForms** - **AlternatingFillsTypes** - **AnchorPoint** - **AnchorPosition** - **AnchoredRelativeTo** - **AnimationEaseOptions** - **AnimationPlayOperations** - **AntiAliasType** - **ArrangeBy** - **ArrowHead** - **ArrowHeadAlignmentEnum** - **AssetType** - **AssignmentExportOptions** - **AssignmentStatus** - **AttachedDevices** - **AutoEnum** - **AutoSizingReferenceEnum** - **AutoSizingTypeEnum** - **BalanceLinesStyle** - **BaselineFrameGridRelativeOption** - **BaselineGridRelativeOption** - **BehaviorEvents** - **BevelAndEmbossDirection** - **BevelAndEmbossStyle** - **BevelAndEmbossTechnique** - **BindingOptions** - **BitmapCompression** - **BlendMode** - **BlendingSpace** - **BookContentStatus** - **BookletTypeOptions** - **BoundingBoxLimits** - **BuildingBlockTypes** - **BulletCharacterType** - **BulletListExportOption** - **Capitalization** - **CellTypeEnum** - **ChangeBackgroundColorChoices** - **ChangeCaseOptions** - **ChangeConditionsModes** - **ChangeMarkings** - **ChangeTextColorChoices** - **ChangeTypes** - **ChangebarLocations** - **ChangecaseMode** - **ChapterNumberSources** - **CharacterAlignment** - **CharacterCountLocation** - **CharacterDirectionOptions** - **ClippingPathType** - **ColorModel** - **ColorOutputModes** - **ColorRenderingDictionary** - **ColorSettingsPolicy** - **ColorSpace** - **CommentStatusEnum** - **CommentTypeEnum** - **ComposeUsing** - **CompressionQuality** - **ConditionIndicatorMethod** - **ConditionIndicatorMode** - **ConditionUnderlineIndicatorAppearance** - **ContainerType** - **ContentType** - **ContourOptionsTypes** - **ConvertPageBreaks** - **ConvertShapeOptions** - **ConvertTablesOptions** - **CoordinateSpaces** - **CopyrightStatus** - **CornerOptions** - **CreateProxy** - **CrossReferenceType** - **CursorTypes** - **CustomLayoutTypeEnum** - **DataFormat** - **DefaultRenderingIntent** - **DesignOptions** - **DiacriticPositionOptions** - **DigitsTypeOptions** - **DigpubArticleVersion** - **DigpubVersion** - **DimensionAttributes** ``` -------------------------------- ### Table Of Contents Suite API Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest This section details the Table of Contents Suite API for managing TOC styles. ```APIDOC ## Table Of Contents Suite API This API allows for the management of Table of Contents (TOC) styles in InDesign. ### Available TOC Objects: - TOCStyle - TOCStyleEntries These objects are used to define and customize the appearance and content of tables of contents generated within InDesign documents. ``` -------------------------------- ### InDesign Object Model Hierarchy Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest This section outlines the hierarchical structure of the InDesign object model, showing the relationships between core objects like Application, Document, Page, and their properties. ```APIDOC ## InDesign Object Model Hierarchy ### Description This section outlines the hierarchical structure of the InDesign object model, showing the relationships between core objects like Application, Document, Page, and their properties. ### Object Model Structure - **Application** - **Document** - MasterSpread - Spread - Page - PageItem - Graphic - Image - Group - TextFrame - Story - Paragraph - ParagraphStyle - Character - CharacterStyle - Table - TableStyle - Row - Cell - CellStyle - Link - Story - Paragraph - Text - Table - Row - Column - Cell - Swatch - Tint - Color - Book - FindGrepPreference - ChangeGrepPreference - ScriptPreference - Font - **Assignment Suite** - AssignedStories - AssignedStory - Assignment - Assignments - **Basics Suite** - Application - BackgroundTask - BackgroundTasks - ContentPlacerObject - Document - DocumentEvent - Documents - Event - EventListener - EventListeners - Events - IdleEvent - IdleTask - IdleTasks - ImportExportEvent - LayoutWindow - LayoutWindows - MutationEvent - PlaceGun - PrintEvent - ScriptArg - StoryWindow - StoryWindows - Window - Windows - **Book Suite** - Book - BookContent - BookContents - Books - **Color Suite** - Color - ColorGroup - ColorGroupSwatch - ColorGroupSwatches - ColorGroups - Colors - Gradient - GradientStop - GradientStops - Gradients - Ink - Inks - MixedInk - MixedInkGroup - MixedInkGroups - MixedInks - OpacityGradientStop - OpacityGradientStops - Swatch - Swatches - Tint - Tints - TrapPreset - TrapPresets - **Datamerge Suite** - DataMergeField - DataMergeFields - DataMergeImagePlaceholder - DataMergeImagePlaceholders - DataMergeQrcodePlaceholder - DataMergeQrcodePlaceholders - DataMergeTextPlaceholder - DataMergeTextPlaceholders ``` -------------------------------- ### Hyperlinks Suite Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest/#about.html APIs related to managing hyperlinks within InDesign documents, including destinations and sources. ```APIDOC ## Hyperlinks Suite This suite provides functionalities for managing hyperlinks in InDesign documents. ### Available Hyperlink Components: * Bookmark * Bookmarks * BuildingBlock * BuildingBlocks * CrossReferenceFormat * CrossReferenceFormats * CrossReferenceSource * CrossReferenceSources * Hyperlink * HyperlinkExternalPageDestination * HyperlinkExternalPageDestinations * HyperlinkPageDestination * HyperlinkPageDestinations * HyperlinkPageItemSource * HyperlinkPageItemSources * HyperlinkTextDestination * HyperlinkTextDestinations * HyperlinkTextSource * HyperlinkTextSources * HyperlinkURLDestination * HyperlinkURLDestinations * Hyperlinks * ParagraphDestination * ParagraphDestinations ``` -------------------------------- ### Table of Contents Suite API Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest?q=%2FextendscriptAPI%2Findesign-latest%2Fabout.html API for generating and managing Table of Contents (TOC) styles and entries. ```APIDOC ## Table of Contents Suite API ### Description This suite provides functionality to create, customize, and manage Table of Contents (TOC) styles and their corresponding entries within InDesign documents. ### Objects - **TOCStyle**: Defines the appearance and structure of a Table of Contents. - **TOCStyleEntries**: A collection of entries within a `TOCStyle`. ### Usage Allows for the automated generation and styling of Tables of Contents based on document content and defined styles. ```javascript // Example: Accessing TOC styles (conceptual) // var tocStyles = app.tocStyles; // Example: Creating a new TOC style (conceptual) // var newTocStyle = tocStyles.add('My TOC Style'); ``` ``` -------------------------------- ### Assignment Suite Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest?q=%2FextendscriptAPI%2Findesign-latest%2Fabout.html Details of the Assignment Suite, which manages assignments and stories within InDesign. ```APIDOC ## Assignment Suite API ### Description The Assignment Suite provides objects and methods for managing assignments and associated stories within Adobe InDesign. ### Objects - **AssignedStories** - **AssignedStory** - **Assignment** - **Assignments** ``` -------------------------------- ### Stroke Styles Suite API Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest?q=%2FextendscriptAPI%2Findesign-latest%2Fabout.html API for defining and managing various stroke styles, including dashed, dotted, and striped. ```APIDOC ## Stroke Styles Suite API ### Description This suite allows for the programmatic creation, manipulation, and management of different stroke styles in InDesign, such as dashed, dotted, and striped lines. ### Objects - **DashedStrokeStyle**: Represents a dashed stroke style. - **DashedStrokeStyles**: A collection of `DashedStrokeStyle` objects. - **DottedStrokeStyle**: Represents a dotted stroke style. - **DottedStrokeStyles**: A collection of `DottedStrokeStyle` objects. - **StripedStrokeStyle**: Represents a striped stroke style. - **StripedStrokeStyles**: A collection of `StripedStrokeStyle` objects. - **StrokeStyle**: The base object for all stroke styles. - **StrokeStyles**: A collection of `StrokeStyle` objects. ### Usage These objects can be used to define custom stroke appearances for paths and frames within InDesign documents. ```javascript // Example: Accessing stroke styles (conceptual) // var strokeStyles = app.strokeStyles; // Example: Creating a new dashed stroke style (conceptual) // var newDashedStyle = strokeStyles.add('Dashed', DashedStrokeStyle); // newDashedStyle.lineDash = [12, 6]; // Dash length, Gap length ``` ``` -------------------------------- ### Stroke Styles Suite API Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest This section details the Stroke Styles Suite API for managing different types of stroke styles. ```APIDOC ## Stroke Styles Suite API This API provides functionality to work with various stroke styles in InDesign. ### Available Stroke Style Objects: - DashedStrokeStyle - DashedStrokeStyles - DottedStrokeStyle - DottedStrokeStyles - StripedStrokeStyle - StripedStrokeStyles - StrokeStyle - StrokeStyles These objects enable the definition and application of custom stroke styles, including dashed, dotted, and striped patterns. ``` -------------------------------- ### Datamerge Suite Source: https://www.indesignjs.de/extendscriptAPI/indesign-latest?q=%2FextendscriptAPI%2Findesign-latest%2Fabout.html Objects for managing data merge fields and placeholders in InDesign. ```APIDOC ## Datamerge Suite API ### Description The Datamerge Suite provides objects for working with data merge fields and various placeholder types used in data-driven publishing. ### Objects - **DataMergeField** - **DataMergeFields** - **DataMergeImagePlaceholder** - **DataMergeImagePlaceholders** - **DataMergeQrcodePlaceholder** - **DataMergeQrcodePlaceholders** - **DataMergeTextPlaceholder** - **DataMergeTextPlaceholders** ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.