XmlStory

XML text content that has not yet been placed in the layout.

Methods:

addEventListener, asynchronousExportFile, changeGlyph, changeGrep, changeText, changeTransliterate, changecase, clearOverrides, convertBulletsAndNumberingToText, createOutlines, duplicate, extractLabel, findGlyph, findGrep, findText, findTransliterate, getElements, insertLabel, removeEventListener, toSource, toSpecifier

Objects:

AdornmentOverprint, AlternateGlyphForms, BalanceLinesStyle, Boolean, Bullet, Buttons, Capitalization, CellStyleMappings, Changes, CharStyleMappings, CharacterAlignment, CharacterDirectionOptions, CharacterStyle, Characters, CheckBoxes, ComboBoxes, CornerOptions, DiacriticPositionOptions, DigitsTypeOptions, EPSTexts, EndCap, EndJoin, EndnoteRanges, EndnoteTextFrames, Endnotes, EventListeners, Events, Font, Footnotes, FormFields, Graphic, GraphicLines, GridAlignment, GridDataInformation, Groups, HiddenTexts, HyphenationStyleEnum, InCopyExportOption, InsertionPoints, Justification, KashidasOptions, KentenAlignment, KentenCharacter, KentenCharacterSet, KinsokuHangTypes, KinsokuSet, KinsokuTable, KinsokuType, LanguageWithVendors, Leading, LeadingModel, Lines, Link, LinkedStoryOption, ListAlignment, ListBoxes, ListType, LockStateValues, MojikumiTable, MojikumiTableDefaults, MultiStateObjects, NamedGrid, NestedGrepStyles, NestedLineStyles, NestedStyles, Notes, NothingEnum, Number, NumberingList, NumberingRestartPolicy, NumberingStyle, OTFFigureStyle, Object, OutlineJoin, Ovals, PageItem, PageItems, ParaStyleMappings, ParagraphBorderBottomOriginEnum, ParagraphBorderEnum, ParagraphBorderTopOriginEnum, ParagraphDirectionOptions, ParagraphJustificationOptions, ParagraphShadingBottomOriginEnum, ParagraphShadingTopOriginEnum, ParagraphShadingWidthEnum, ParagraphStyle, Paragraphs, Polygons, Position, PositionalForms, Preferences, RadioButtons, Rectangles, RubyAlignments, RubyKentenPosition, RubyOverhang, RubyParentSpacing, RubyTypes, RuleWidth, SignatureFields, SingleWordJustification, SpanColumnCountOptions, SpanColumnTypeOptions, SpecialCharacters, SplineItems, StartParagraph, StoryPreference, StoryTypes, String, StrokeStyle, Swatch, TabStops, TableStyleMappings, Tables, TextBoxes, TextColumns, TextFrames, TextPaths, TextStrokeAlign, TextStyleRanges, TextVariableInstances, Texts, TypefiElementAnchors, WarichuAlignment, Words, XMLItem

Preferences:

InCopyExportOption, LinkedStoryOption, Preferences, StoryPreference

Hierarchy:

Superclass: Story

Class: XmlStory

Property Listing

Property

Type

Access

Description

alignToBaseline

Boolean

read/write

If true, aligns the baseline of the text to the baseline grid.

allGraphics

Array of Graphic

readonly

Lists all graphics contained by the XmlStory.

allPageItems

Array of PageItem

readonly

Lists all page items contained by the XmlStory.

allowArbitraryHyphenation

Boolean

read/write

If true, words unassociated with a hyphenation dictionary can break to the next line on any character.

appliedCharacterStyle

CharacterStyle

String

read/write

The character style applied to the text. Can also accept: String.

appliedFont

Font

String

read/write

The font applied to the XmlStory, specified as either a font object or the name of font family. Can return: Font or String.

appliedLanguage

LanguageWithVendors

LanguageCanalsoaccept:String

read/write

The language of the text. Can return: LanguageWithVendors or Language. Can also accept: String.

appliedNamedGrid

NamedGrid

read/write

The named grid in use.

appliedNestedStyles

Array of CharacterStyle

readonly

The applied character styles dictated by nested styles.

appliedNumberingList

NumberingList

String

read/write

The list to be part of. Can return: NumberingList or String.

appliedParagraphStyle

ParagraphStyle

String

read/write

The paragraph style applied to the text. Can also accept: String.

associatedXMLElement

XMLItem

readonly

The XML element associated with the XmlStory.

autoLeading

Number (range 0 - 500)

read/write

The percent of the type size to use for auto leading. (Range: 0 to 500).

autoTcy

Number

read/write

The number of half-width characters at or below which the characters automatically run horizontally in vertical text.

autoTcyIncludeRoman

Boolean

read/write

If true, auto tcy includes Roman characters.

balanceRaggedLines

Boolean

BalanceLinesStyle

BalanceLinesStyle.FULLY_BALANCED

BalanceLinesStyle.NO_BALANCING

BalanceLinesStyle.PYRAMID_SHAPE

BalanceLinesStyle.VEE_SHAPE

read/write

If true or set to an enumeration value, balances ragged lines. Note: Not valid with a single-line text composer. Can return: Boolean or BalanceLinesStyle enumerator.

baselineShift

Number

String

read/write

The baseline shift applied to the text.

bulletChar

Bullet

readonly

Bullet character.

bulletsAlignment

ListAlignment

ListAlignment.CENTER_ALIGN

ListAlignment.LEFT_ALIGN

ListAlignment.RIGHT_ALIGN

read/write

The alignment of the bullet character.

bulletsAndNumberingListType

ListType

ListType.BULLET_LIST

ListType.NO_LIST

ListType.NUMBERED_LIST

read/write

List type for bullets and numbering.

bulletsCharacterStyle

CharacterStyle

String

read/write

The character style to be used for the text after string. Can return: CharacterStyle or String.

bulletsTextAfter

String

read/write

The text after string expression for bullets.

bunriKinshi

Boolean

read/write

If true, adds the double period (..), ellipse (...), and double hyphen (--) to the selected kinsoku set. Note: Valid only when a kinsoku set is in effect.

buttons

Buttons Button

readonly

A collection of buttons.

capitalization

Capitalization

Capitalization.ALL_CAPS

Capitalization.CAP_TO_SMALL_CAP

Capitalization.NORMAL

Capitalization.SMALL_CAPS

read/write

The capitalization scheme.

cellStyleMappings

CellStyleMappings CellStyleMapping

readonly

A collection of cell style mappings.

changes

Changes Change

readonly

A collection of changes.

charStyleMappings

CharStyleMappings CharStyleMapping

readonly

A collection of char style mappings.

characterAlignment

CharacterAlignment

CharacterAlignment.ALIGN_BASELINE

CharacterAlignment.ALIGN_EM_BOTTOM

CharacterAlignment.ALIGN_EM_CENTER

CharacterAlignment.ALIGN_EM_TOP

CharacterAlignment.ALIGN_ICF_BOTTOM

CharacterAlignment.ALIGN_ICF_TOP

read/write

The alignment of small characters to the largest character in the line.

characterDirection

CharacterDirectionOptions

CharacterDirectionOptions.DEFAULT_DIRECTION

CharacterDirectionOptions.LEFT_TO_RIGHT_DIRECTION

CharacterDirectionOptions.RIGHT_TO_LEFT_DIRECTION

read/write

The direction of the character.

characterRotation

Number

read/write

The rotation angle (in degrees) of individual characters. Note: The rotation is counterclockwise.

characters

Characters Character

readonly

A collection of characters.

checkBoxes

CheckBoxes

readonly

A collection of checkboxes.

cjkGridTracking

Boolean

read/write

If true, uses grid tracking to track non-Roman characters in CJK grids.

comboBoxes

ComboBoxes

readonly

A collection of comboboxes.

composer

String

read/write

The text composer to use to compose the text.

contents

String

SpecialCharacters

SpecialCharacters.ARABIC_COMMA

SpecialCharacters.ARABIC_KASHIDA

SpecialCharacters.ARABIC_QUESTION_MARK

SpecialCharacters.ARABIC_SEMICOLON

SpecialCharacters.AUTO_PAGE_NUMBER

SpecialCharacters.BULLET_CHARACTER

SpecialCharacters.COLUMN_BREAK

SpecialCharacters.COPYRIGHT_SYMBOL

SpecialCharacters.DEGREE_SYMBOL

SpecialCharacters.DISCRETIONARY_HYPHEN

SpecialCharacters.DISCRETIONARY_LINE_BREAK

SpecialCharacters.DOTTED_CIRCLE

SpecialCharacters.DOUBLE_LEFT_QUOTE

SpecialCharacters.DOUBLE_RIGHT_QUOTE

SpecialCharacters.DOUBLE_STRAIGHT_QUOTE

SpecialCharacters.ELLIPSIS_CHARACTER

SpecialCharacters.EM_DASH

SpecialCharacters.EM_SPACE

SpecialCharacters.END_NESTED_STYLE

SpecialCharacters.EN_DASH

SpecialCharacters.EN_SPACE

SpecialCharacters.EVEN_PAGE_BREAK

SpecialCharacters.FIGURE_SPACE

SpecialCharacters.FIXED_WIDTH_NONBREAKING_SPACE

SpecialCharacters.FLUSH_SPACE

SpecialCharacters.FOOTNOTE_SYMBOL

SpecialCharacters.FORCED_LINE_BREAK

SpecialCharacters.FRAME_BREAK

SpecialCharacters.HAIR_SPACE

SpecialCharacters.HEBREW_GERESH

SpecialCharacters.HEBREW_GERSHAYIM

SpecialCharacters.HEBREW_MAQAF

SpecialCharacters.HEBREW_SOF_PASUK

SpecialCharacters.INDENT_HERE_TAB

SpecialCharacters.LEFT_TO_RIGHT_EMBEDDING

SpecialCharacters.LEFT_TO_RIGHT_MARK

SpecialCharacters.LEFT_TO_RIGHT_OVERRIDE

SpecialCharacters.NEXT_PAGE_NUMBER

SpecialCharacters.NONBREAKING_HYPHEN

SpecialCharacters.NONBREAKING_SPACE

SpecialCharacters.ODD_PAGE_BREAK

SpecialCharacters.PAGE_BREAK

SpecialCharacters.PARAGRAPH_SYMBOL

SpecialCharacters.POP_DIRECTIONAL_FORMATTING

SpecialCharacters.PREVIOUS_PAGE_NUMBER

SpecialCharacters.PUNCTUATION_SPACE

SpecialCharacters.QUARTER_SPACE

SpecialCharacters.REGISTERED_TRADEMARK

SpecialCharacters.RIGHT_INDENT_TAB

SpecialCharacters.RIGHT_TO_LEFT_EMBEDDING

SpecialCharacters.RIGHT_TO_LEFT_MARK

SpecialCharacters.RIGHT_TO_LEFT_OVERRIDE

SpecialCharacters.SECTION_MARKER

SpecialCharacters.SECTION_SYMBOL

SpecialCharacters.SINGLE_LEFT_QUOTE

SpecialCharacters.SINGLE_RIGHT_QUOTE

SpecialCharacters.SINGLE_STRAIGHT_QUOTE

SpecialCharacters.SIXTH_SPACE

SpecialCharacters.TEXT_VARIABLE

SpecialCharacters.THIN_SPACE

SpecialCharacters.THIRD_SPACE

SpecialCharacters.TRADEMARK_SYMBOL

SpecialCharacters.ZERO_WIDTH_JOINER

SpecialCharacters.ZERO_WIDTH_NONJOINER

readonly

The contents of the text. Can return: String or SpecialCharacters enumerator.

desiredGlyphScaling

Number (range 50 - 200)

read/write

The desired width (as a percentage) of individual characters. (Range: 50 to 200)

desiredLetterSpacing

Number

read/write

The desired letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500)

desiredWordSpacing

Number (range 0 - 1000)

read/write

The desired word spacing, specified as a percentage of the font word space value. (Range: 0 to 1000)

diacriticPosition

DiacriticPositionOptions

DiacriticPositionOptions.DEFAULT_POSITION

DiacriticPositionOptions.LOOSE_POSITION

DiacriticPositionOptions.MEDIUM_POSITION

DiacriticPositionOptions.OPENTYPE_POSITION

DiacriticPositionOptions.OPENTYPE_POSITION_FROM_BASELINE

DiacriticPositionOptions.TIGHT_POSITION

read/write

Position of diacriticical characters.

digitsType

DigitsTypeOptions

DigitsTypeOptions.ARABIC_DIGITS

DigitsTypeOptions.BENGALI_DIGITS

DigitsTypeOptions.BURMESE_DIGITS

DigitsTypeOptions.DEFAULT_DIGITS

DigitsTypeOptions.DEVANAGARI_DIGITS

DigitsTypeOptions.FARSI_DIGITS

DigitsTypeOptions.FULL_FARSI_DIGITS

DigitsTypeOptions.GUJARATI_DIGITS

DigitsTypeOptions.GURMUKHI_DIGITS

DigitsTypeOptions.HINDI_DIGITS

DigitsTypeOptions.KANNADA_DIGITS

DigitsTypeOptions.KHMER_DIGITS

DigitsTypeOptions.LAO_DIGITS

DigitsTypeOptions.MALAYALAM_DIGITS

DigitsTypeOptions.NATIVE_DIGITS

DigitsTypeOptions.ORIYA_DIGITS

DigitsTypeOptions.TAMIL_DIGITS

DigitsTypeOptions.TELUGU_DIGITS

DigitsTypeOptions.THAI_DIGITS

DigitsTypeOptions.TIBETAN_DIGITS

read/write

The digits type.

dropCapCharacters

Number (range 0 - 150)

read/write

The number of characters to drop cap.

dropCapLines

Number (range 0 - 25)

read/write

The number of lines to drop cap.

dropCapStyle

CharacterStyle

String

read/write

The character style to apply to the drop cap. Can also accept: String.

dropcapDetail

Number

read/write

Details about the drop cap based on the glyph outlines. 1 = left side bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid.

endJoin

OutlineJoin

OutlineJoin.BEVEL_END_JOIN

OutlineJoin.MITER_END_JOIN

OutlineJoin.ROUND_END_JOIN

read/write

The stroke join type applied to the characters of the text.

endnoteRanges

EndnoteRanges EndnoteRange

readonly

A collection of endnote text ranges.

endnoteTextFrames

EndnoteTextFrames EndnoteTextFrame

readonly

A collection of endnote text frames.

endnotes

Endnotes Endnote

readonly

A collection of endnotes.

epstexts

EPSTexts EPSText

readonly

EPSTexts

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

fillColor

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the fill of the XmlStory. . Can also accept: String.

fillTint

Number (range 0 - 100)

read/write

The tint (as a percentage) of the fill color of the XmlStory. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)

firstLineIndent

Number

String

read/write

The amount to indent the first line.

fontStyle

String

read/write

The name of the font style.

footnotes

Footnotes Footnote

readonly

A collection of footnotes.

formFields

FormFields FormField

readonly

A collection of form fields.

glyphForm

AlternateGlyphForms

AlternateGlyphForms.EXPERT_FORM

AlternateGlyphForms.FULL_WIDTH_FORM

AlternateGlyphForms.JIS04_FORM

AlternateGlyphForms.JIS78_FORM

AlternateGlyphForms.JIS83_FORM

AlternateGlyphForms.JIS90_FORM

AlternateGlyphForms.MONOSPACED_HALF_WIDTH_FORM

AlternateGlyphForms.NLC_FORM

AlternateGlyphForms.NONE

AlternateGlyphForms.PROPORTIONAL_WIDTH_FORM

AlternateGlyphForms.QUARTER_WIDTH_FORM

AlternateGlyphForms.THIRD_WIDTH_FORM

AlternateGlyphForms.TRADITIONAL_FORM

read/write

The glyph variant to substitute for standard glyphs.

gradientFillAngle

Number

read/write

The angle of a linear gradient applied to the fill of the text. (Range: -180 to 180)

gradientFillLength

Number

read/write

The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text.

gradientFillStart

Array of Number

Array of String

read/write

The starting point (in page coordinates) of a gradient applied to the fill of the text, in the format [x, y].

gradientStrokeAngle

Number

read/write

The angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180)

gradientStrokeLength

Number

read/write

The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text.

gradientStrokeStart

Array of Number

Array of String

read/write

The starting point (in page coordinates) of a gradient applied to the stroke of the text, in the format [x, y].

graphicLines

GraphicLines GraphicLine

readonly

A collection of graphic lines.

gridAlignFirstLineOnly

Boolean

read/write

If true, aligns only the first line to the frame grid or baseline grid. If false, aligns all lines to the grid.

gridAlignment

GridAlignment

GridAlignment.ALIGN_BASELINE

GridAlignment.ALIGN_EM_BOTTOM

GridAlignment.ALIGN_EM_CENTER

GridAlignment.ALIGN_EM_TOP

GridAlignment.ALIGN_ICF_BOTTOM

GridAlignment.ALIGN_ICF_TOP

GridAlignment.NONE

read/write

The alignment to the frame grid or baseline grid.

gridData

GridDataInformation

readonly

Default grid properties. Note: Applies to named, layout, and frame (story) grids.

gridGyoudori

Number

read/write

The manual gyoudori setting.

groups

Groups Group

readonly

A collection of groups.

hiddenTexts

HiddenTexts HiddenText

readonly

A collection of hidden text objects.

horizontalScale

Number

read/write

The horizontal scaling applied to the XmlStory.

hyphenWeight

Number (range 0 - 10)

read/write

The relative desirability of better spacing vs. fewer hyphens. A lower value results in greater use of hyphens. (Range: 0 to 100)

hyphenateAcrossColumns

Boolean

read/write

If true, allows the last word in a text column to be hyphenated.

hyphenateAfterFirst

Number (range 1 - 15)

read/write

The mininum number of letters at the beginning of a word that can be broken by a hyphen.

hyphenateBeforeLast

Number (range 1 - 15)

read/write

The minimum number of letters at the end of a word that can be broken by a hyphen.

hyphenateCapitalizedWords

Boolean

read/write

If true, allows hyphenation of capitalized words.

hyphenateLadderLimit

Number (range 0 - 25)

read/write

The maximum number of hyphens that can appear on consecutive lines. To specify unlimited consecutive lines, use zero.

hyphenateLastWord

Boolean

read/write

If true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true.

hyphenateWordsLongerThan

Number (range 3 - 25)

read/write

The minimum number of letters a word must have in order to qualify for hyphenation.

hyphenation

Boolean

read/write

If true, allows hyphenation.

hyphenationZone

Number

String

read/write

The amount of white space allowed at the end of a line of non-justified text before hypenation begins. Note: Valid when composer is single-line composer.

id

Number

readonly

The unique ID of the XmlStory.

ignoreEdgeAlignment

Boolean

read/write

If true, ignores optical edge alignment for the paragraph.

incopyExportOptions

InCopyExportOption

readonly

Export options for InCopy INCX document format.

index

Number

readonly

The index of the XmlStory within its containing object.

insertionPoints

InsertionPoints InsertionPoint

readonly

A collection of insertion points.

isEndnoteStory

Boolean

readonly

returns true if it's an endnote story otherwise returns false.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

itemLink

Link

readonly

The source file of the link.

jidori

Number

read/write

The number of grid squares in which to arrange the text.

justification

Justification

Justification.AWAY_FROM_BINDING_SIDE

Justification.CENTER_ALIGN

Justification.CENTER_JUSTIFIED

Justification.FULLY_JUSTIFIED

Justification.LEFT_ALIGN

Justification.LEFT_JUSTIFIED

Justification.RIGHT_ALIGN

Justification.RIGHT_JUSTIFIED

Justification.TO_BINDING_SIDE

read/write

The paragraph alignment.

kashidas

KashidasOptions

KashidasOptions.DEFAULT_KASHIDAS

KashidasOptions.KASHIDAS_OFF

read/write

Use of Kashidas for justification

keepAllLinesTogether

Boolean

read/write

If true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns.

keepFirstLines

Number (range 1 - 50)

read/write

The minimum number of lines to keep together in a paragraph before allowing a page break.

keepLastLines

Number (range 1 - 50)

read/write

The minimum number of lines to keep together in a paragraph after a page break.

keepLinesTogether

Boolean

read/write

If true, keeps a specified number of lines together when the paragraph breaks across columns or text frames.

keepRuleAboveInFrame

Boolean

read/write

If true, forces the rule above the paragraph to remain in the frame bounds. Note: Valid only when rule above is true.

keepWithNext

Number (range 0 - 5)

read/write

The minimum number of lines to keep with the next paragraph.

keepWithPrevious

Boolean

read/write

If the first line in the paragraph should be kept with the last line of previous paragraph.

kentenAlignment

KentenAlignment

KentenAlignment.ALIGN_KENTEN_CENTER

KentenAlignment.ALIGN_KENTEN_LEFT

read/write

The alignment of kenten characters relative to the parent characters.

kentenCharacterSet

KentenCharacterSet

KentenCharacterSet.CHARACTER_INPUT

KentenCharacterSet.JIS

KentenCharacterSet.KUTEN

KentenCharacterSet.SHIFT_JIS

KentenCharacterSet.UNICODE

read/write

The character set used for the custom kenten character. Note: Valid only when kenten kind is custom.

kentenCustomCharacter

String

read/write

The character used for kenten. Note: Valid only when kenten kind is custom.

kentenFillColor

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the fill of kenten characters. Can return: Swatch or String.

kentenFont

Font

String

read/write

The font to use for kenten characters. Can return: Font or String.

kentenFontSize

Number

read/write

The size (in points) of kenten characters.

kentenFontStyle

String

NothingEnum.NOTHING

read/write

The font style of kenten characters. Can return: String or NothingEnum enumerator.

kentenKind

KentenCharacter

KentenCharacter.CUSTOM

KentenCharacter.KENTEN_BLACK_CIRCLE

KentenCharacter.KENTEN_BLACK_TRIANGLE

KentenCharacter.KENTEN_BULLSEYE

KentenCharacter.KENTEN_FISHEYE

KentenCharacter.KENTEN_SESAME_DOT

KentenCharacter.KENTEN_SMALL_BLACK_CIRCLE

KentenCharacter.KENTEN_SMALL_WHITE_CIRCLE

KentenCharacter.KENTEN_WHITE_CIRCLE

KentenCharacter.KENTEN_WHITE_SESAME_DOT

KentenCharacter.KENTEN_WHITE_TRIANGLE

KentenCharacter.NONE

read/write

The style of kenten characters.

kentenOverprintFill

AdornmentOverprint

AdornmentOverprint.AUTO

AdornmentOverprint.OVERPRINT_OFF

AdornmentOverprint.OVERPRINT_ON

read/write

The method of overprinting the kenten fill.

kentenOverprintStroke

AdornmentOverprint

AdornmentOverprint.AUTO

AdornmentOverprint.OVERPRINT_OFF

AdornmentOverprint.OVERPRINT_ON

read/write

The method of overprinting the kenten stroke.

kentenPlacement

Number

read/write

The distance between kenten characters and their parent characters.

kentenPosition

RubyKentenPosition

RubyKentenPosition.ABOVE_RIGHT

RubyKentenPosition.BELOW_LEFT

read/write

The kenten position relative to the parent character.

kentenStrokeColor

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the stroke of kenten characters. Can return: Swatch or String.

kentenStrokeTint

Number (range 0 - 100)

read/write

The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100)

kentenTint

Number (range 0 - 100)

read/write

The fill tint (as a percentage) of kenten characters. (Range: 0 to 100)

kentenWeight

Number

read/write

The stroke weight (in points) of kenten characters.

kentenXScale

Number

read/write

The horizontal size of kenten characters as a percent of the original size.

kentenYScale

Number

read/write

The vertical size of kenten charachers as a percent of the original size.

kerningMethod

String

read/write

The type of pair kerning.

keyboardDirection

CharacterDirectionOptions

CharacterDirectionOptions.DEFAULT_DIRECTION

CharacterDirectionOptions.LEFT_TO_RIGHT_DIRECTION

CharacterDirectionOptions.RIGHT_TO_LEFT_DIRECTION

read/write

The keyboard direction of the character.

kinsokuHangType

KinsokuHangTypes

KinsokuHangTypes.KINSOKU_HANG_FORCE

KinsokuHangTypes.KINSOKU_HANG_REGULAR

KinsokuHangTypes.NONE

read/write

The type of hanging punctuation to allow. Note: Valid only when a kinsoku set is in effect.

kinsokuSet

KinsokuSet

KinsokuSet.HARD_KINSOKU

KinsokuSet.KOREAN_KINSOKU

KinsokuSet.NOTHING

KinsokuSet.SIMPLIFIED_CHINESE_KINSOKU

KinsokuSet.SOFT_KINSOKU

KinsokuSet.TRADITIONAL_CHINESE_KINSOKU

KinsokuTable

String

read/write

The kinsoku set that determines legitimate line breaks. Can return: KinsokuTable, KinsokuSet enumerator or String.

kinsokuType

KinsokuType

KinsokuType.KINSOKU_PRIORITIZE_ADJUSTMENT_AMOUNT

KinsokuType.KINSOKU_PUSH_IN_FIRST

KinsokuType.KINSOKU_PUSH_OUT_FIRST

KinsokuType.KINSOKU_PUSH_OUT_ONLY

read/write

The type of kinsoku processing for preventing kinsoku characters from beginning or ending a line. Note: Valid only when a kinsoku set is defined.

label

String

read/write

A property that can be set to any string.

lastLineIndent

Number

String

read/write

The amount to indent the last line in the paragraph.

leading

Unit

Leading

Leading.AUTO

read/write

The leading applied to the text. Can return: Unit or Leading enumerator.

leadingAki

Number

read/write

The amount of space before each character.

leadingModel

LeadingModel

LeadingModel.LEADING_MODEL_AKI_ABOVE

LeadingModel.LEADING_MODEL_AKI_BELOW

LeadingModel.LEADING_MODEL_CENTER

LeadingModel.LEADING_MODEL_CENTER_DOWN

LeadingModel.LEADING_MODEL_ROMAN

read/write

The point from which leading is measured from line to line.

leftIndent

Number

String

read/write

The width of the left indent.

length

Number

readonly

The number of objects in the collection.

ligatures

Boolean

read/write

If true, replaces specific character combinations (e.g., fl, fi) with ligature characters.

lines

Lines Line

readonly

A collection of lines.

linkedStoryOptions

LinkedStoryOption

readonly

Linked story options

listBoxes

ListBoxes

readonly

A collection of listboxes.

lockState

LockStateValues

LockStateValues.CHECKED_IN_STORY

LockStateValues.CHECKED_OUT_STORY

LockStateValues.EMBEDDED_STORY

LockStateValues.LOCKED_STORY

LockStateValues.MISSING_LOCK_STATE

LockStateValues.MIXED_LOCK_STATE

LockStateValues.NONE

LockStateValues.UNMANAGED_STORY

readonly

The lock state.

maximumGlyphScaling

Number (range 50 - 200)

read/write

The maximum width (as a percentage) of individual characters. (Range: 50 to 200)

maximumLetterSpacing

Number

read/write

The maximum letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500) Note: Valid only when text is justified.

maximumWordSpacing

Number (range 0 - 1000)

read/write

The maximum word spacing, specified as a percentage of the font word space value. Note: Valid only when text is justified. (Range: 0 to 1000)

minimumGlyphScaling

Number (range 50 - 200)

read/write

The minimum width (as a percentage) of individual characters. (Range: 50 to 200)

minimumLetterSpacing

Number

read/write

The minimum letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500) Note: Valid only when text is justified.

minimumWordSpacing

Number (range 0 - 1000)

read/write

The minimum word spacing, specified as a percentage of the font word space value. Note: Valid only when text is justified. (Range: 0 to 1000)

miterLimit

Number (range 0 - 1000)

read/write

The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join.

mojikumi

MojikumiTable

String

MojikumiTableDefaults

MojikumiTableDefaults.LINE_END_ALL_ONE_EM_ENUM

MojikumiTableDefaults.LINE_END_ALL_ONE_HALF_EM_ENUM

MojikumiTableDefaults.LINE_END_PERIOD_ONE_EM_ENUM

MojikumiTableDefaults.LINE_END_UKE_NO_FLOAT_ENUM

MojikumiTableDefaults.NOTHING

MojikumiTableDefaults.ONE_EM_INDENT_LINE_END_ALL_NO_FLOAT_ENUM

MojikumiTableDefaults.ONE_EM_INDENT_LINE_END_ALL_ONE_EM_ENUM

MojikumiTableDefaults.ONE_EM_INDENT_LINE_END_ALL_ONE_HALF_EM_ENUM

MojikumiTableDefaults.ONE_EM_INDENT_LINE_END_PERIOD_ONE_EM_ENUM

MojikumiTableDefaults.ONE_EM_INDENT_LINE_END_UKE_NO_FLOAT_ENUM

MojikumiTableDefaults.ONE_EM_INDENT_LINE_END_UKE_ONE_HALF_EM_ENUM

MojikumiTableDefaults.ONE_OR_ONE_HALF_EM_INDENT_LINE_END_ALL_ONE_EM_ENUM

MojikumiTableDefaults.ONE_OR_ONE_HALF_EM_INDENT_LINE_END_PERIOD_ONE_EM_ENUM

MojikumiTableDefaults.ONE_OR_ONE_HALF_EM_INDENT_LINE_END_UKE_NO_FLOAT_ENUM

MojikumiTableDefaults.ONE_OR_ONE_HALF_EM_INDENT_LINE_END_UKE_ONE_HALF_EM_ENUM

MojikumiTableDefaults.SIMP_CHINESE_DEFAULT

MojikumiTableDefaults.TRAD_CHINESE_DEFAULT

read/write

The mojikumi table. For information, see mojikumi table defaults. Can return: MojikumiTable, String or MojikumiTableDefaults enumerator.

multiStateObjects

MultiStateObjects MultiStateObject

readonly

A collection of multi-state objects.

name

String

read/write

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

nestedGrepStyles

NestedGrepStyles NestedGrepStyle

readonly

A collection of nested GREP styles.

nestedLineStyles

NestedLineStyles NestedLineStyle

readonly

A collection of nested line styles.

nestedStyles

NestedStyles NestedStyle

readonly

A collection of nested styles.

noBreak

Boolean

read/write

If true, keeps the text on the same line.

notes

Notes Note

readonly

A collection of notes.

numberingAlignment

ListAlignment

ListAlignment.CENTER_ALIGN

ListAlignment.LEFT_ALIGN

ListAlignment.RIGHT_ALIGN

read/write

The alignment of the number.

numberingApplyRestartPolicy

Boolean

read/write

If true, apply the numbering restart policy.

numberingCharacterStyle

CharacterStyle

String

read/write

The character style to be used for the number string. Can return: CharacterStyle or String.

numberingContinue

Boolean

read/write

Continue the numbering at this level.

numberingExpression

String

read/write

The number string expression for numbering.

numberingFormat

NumberingStyle

NumberingStyle.ARABIC

NumberingStyle.ARABIC_ABJAD

NumberingStyle.ARABIC_ALIF_BA_TAH

NumberingStyle.DOUBLE_LEADING_ZEROS

NumberingStyle.FORMAT_NONE

NumberingStyle.HEBREW_BIBLICAL

NumberingStyle.HEBREW_NON_STANDARD

NumberingStyle.KANJI

NumberingStyle.KATAKANA_MODERN

NumberingStyle.KATAKANA_TRADITIONAL

NumberingStyle.LOWER_LETTERS

NumberingStyle.LOWER_ROMAN

NumberingStyle.SINGLE_LEADING_ZEROS

NumberingStyle.TRIPLE_LEADING_ZEROS

NumberingStyle.UPPER_LETTERS

NumberingStyle.UPPER_ROMAN

String

read/write

Numbering format options. Can return: NumberingStyle enumerator or String.

numberingLevel

Number

read/write

The level of the paragraph.

numberingRestartPolicies

NumberingRestartPolicy

readonly

Numbering restart policies.

numberingStartAt

Number

read/write

Determines starting number in a numbered list.

opentypeFeatures

Array of 2 Strings

Array of LongIntegers

read/write

OpenType features. Can return: Array of Array of 2 Strings or Long Integers.

otfContextualAlternate

Boolean

read/write

If true, uses contextual alternate forms in OpenType fonts.

otfDiscretionaryLigature

Boolean

read/write

If true, uses discretionary ligatures in OpenType fonts.

otfFigureStyle

OTFFigureStyle

OTFFigureStyle.DEFAULT_VALUE

OTFFigureStyle.PROPORTIONAL_LINING

OTFFigureStyle.PROPORTIONAL_OLDSTYLE

OTFFigureStyle.TABULAR_LINING

OTFFigureStyle.TABULAR_OLDSTYLE

read/write

The figure style in OpenType fonts.

otfFraction

Boolean

read/write

If true, uses fractions in OpenType fonts.

otfHVKana

Boolean

read/write

If true, switches hiragana fonts, which have different glyphs for horizontal and vertical.

otfHistorical

Boolean

read/write

If true, use historical forms in OpenType fonts.

otfJustificationAlternate

Boolean

read/write

If true, use alternate justification forms in OpenType fonts

otfLocale

Boolean

read/write

If true, uses localized forms in OpenType fonts.

otfMark

Boolean

read/write

If true, uses mark positioning in OpenType fonts.

otfOrdinal

Boolean

read/write

If true, uses ordinals in OpenType fonts.

otfOverlapSwash

Boolean

read/write

If true, use overlapping swash forms in OpenType fonts

otfProportionalMetrics

Boolean

read/write

If true, kerns according to proportional CJK metrics in OpenType fonts.

otfRomanItalics

Boolean

read/write

If true, applies italics to half-width alphanumerics.

otfSlashedZero

Boolean

read/write

If true, use a slashed zeroes in OpenType fonts.

otfStretchedAlternate

Boolean

read/write

If true, use stretched alternate forms in OpenType fonts

otfStylisticAlternate

Boolean

read/write

If true, use stylistic alternate forms in OpenType fonts

otfStylisticSets

Number

read/write

The stylistic sets to use in OpenType fonts.

otfSwash

Boolean

read/write

If true, uses swash forms in OpenType fonts.

otfTitling

Boolean

read/write

If true, uses titling forms in OpenType fonts.

ovals

Ovals Oval

readonly

A collection of ellipses.

overflows

Boolean

readonly

If true, the story has overset text.

overprintFill

Boolean

read/write

If true, the fill color of the characters will overprint.

overprintStroke

Boolean

read/write

If true, the stroke of the characters will overprint.

pageItems

PageItems PageItem

readonly

The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.

paraStyleMappings

ParaStyleMappings ParaStyleMapping

readonly

A collection of para style mappings.

paragraphBorderBottomLeftCornerOption

CornerOptions

CornerOptions.BEVEL_CORNER

CornerOptions.FANCY_CORNER

CornerOptions.INSET_CORNER

CornerOptions.INVERSE_ROUNDED_CORNER

CornerOptions.NONE

CornerOptions.ROUNDED_CORNER

read/write

The shape to apply to the bottom left corner of rectangular shapes.

paragraphBorderBottomLeftCornerRadius

Number

String

read/write

The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes

paragraphBorderBottomLineWeight

Number

String

read/write

The bottom line weight of the border of paragraph.

paragraphBorderBottomOffset

Number

String

read/write

The distance to offset the bottom edge of the paragraph border.

paragraphBorderBottomOrigin

ParagraphBorderBottomOriginEnum

ParagraphBorderBottomOriginEnum.BASELINE_BOTTOM_ORIGIN

ParagraphBorderBottomOriginEnum.DESCENT_BOTTOM_ORIGIN

read/write

The basis (descent or baseline) used to calculate the bottom origin of the paragraph border.

paragraphBorderBottomRightCornerOption

CornerOptions

CornerOptions.BEVEL_CORNER

CornerOptions.FANCY_CORNER

CornerOptions.INSET_CORNER

CornerOptions.INVERSE_ROUNDED_CORNER

CornerOptions.NONE

CornerOptions.ROUNDED_CORNER

read/write

The shape to apply to the bottom right corner of rectangular shapes.

paragraphBorderBottomRightCornerRadius

Number

String

read/write

The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes

paragraphBorderColor

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the paragraph stroke. Can return: Swatch or String.

paragraphBorderDisplayIfSplits

Boolean

read/write

If true, then paragraph border is also displayed at the points where the paragraph splits across frames or columns.

paragraphBorderGapColor

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the paragraph border gap. Note: Valid only when the border type is not solid. Can return: Swatch or String.

paragraphBorderGapOverprint

Boolean

read/write

If true, the paragraph border gap will overprint. Note: Valid only when border type is not solid.

paragraphBorderGapTint

Number (range 0 - 100)

read/write

The tint (as a percentage) of the paragraph border gap. Note: Valid only when the border type is not solid. (Range: 0 to 100)

paragraphBorderLeftLineWeight

Number

String

read/write

The left line weight of the border of paragraph.

paragraphBorderLeftOffset

Number

String

read/write

The distance to offset the left edge of the paragraph border.

paragraphBorderOn

Boolean

read/write

If true, the paragraph border is on.

paragraphBorderOverprint

Boolean

read/write

If true, the paragraph border will overprint.

paragraphBorderRightLineWeight

Number

String

read/write

The right line weight of the border of paragraph.

paragraphBorderRightOffset

Number

String

read/write

The distance to offset the right edge of the paragraph border.

paragraphBorderStrokeEndCap

EndCap

EndCap.BUTT_END_CAP

EndCap.PROJECTING_END_CAP

EndCap.ROUND_END_CAP

read/write

The end shape of an open path.

paragraphBorderStrokeEndJoin

EndJoin

EndJoin.BEVEL_END_JOIN

EndJoin.MITER_END_JOIN

EndJoin.ROUND_END_JOIN

read/write

The corner join applied to the XmlStory.

paragraphBorderTint

Number (range 0 - 100)

read/write

The tint (as a percentage) of the paragraph stroke. (Range: 0 to 100)

paragraphBorderTopLeftCornerOption

CornerOptions

CornerOptions.BEVEL_CORNER

CornerOptions.FANCY_CORNER

CornerOptions.INSET_CORNER

CornerOptions.INVERSE_ROUNDED_CORNER

CornerOptions.NONE

CornerOptions.ROUNDED_CORNER

read/write

The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight.

paragraphBorderTopLeftCornerRadius

Number

String

read/write

The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes

paragraphBorderTopLineWeight

Number

String

read/write

The top line weight of the border of paragraph.

paragraphBorderTopOffset

Number

String

read/write

The distance to offset the top edge of the paragraph border.

paragraphBorderTopOrigin

ParagraphBorderTopOriginEnum

ParagraphBorderTopOriginEnum.ASCENT_TOP_ORIGIN

ParagraphBorderTopOriginEnum.BASELINE_TOP_ORIGIN

ParagraphBorderTopOriginEnum.LEADING_TOP_ORIGIN

read/write

The basis (cap height, ascent or baseline) used to calculate the top origin of the paragraph border.

paragraphBorderTopRightCornerOption

CornerOptions

CornerOptions.BEVEL_CORNER

CornerOptions.FANCY_CORNER

CornerOptions.INSET_CORNER

CornerOptions.INVERSE_ROUNDED_CORNER

CornerOptions.NONE

CornerOptions.ROUNDED_CORNER

read/write

The shape to apply to the top right corner of rectangular shapes

paragraphBorderTopRightCornerRadius

Number

String

read/write

The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes

paragraphBorderType

StrokeStyle

String

read/write

The type of the border for the paragraph. Can return: StrokeStyle or String.

paragraphBorderWidth

ParagraphBorderEnum

ParagraphBorderEnum.COLUMN_WIDTH

ParagraphBorderEnum.TEXT_WIDTH

read/write

The basis (text width or column width) used to calculate the width of the paragraph border.

paragraphDirection

ParagraphDirectionOptions

ParagraphDirectionOptions.LEFT_TO_RIGHT_DIRECTION

ParagraphDirectionOptions.RIGHT_TO_LEFT_DIRECTION

read/write

Paragraph direction.

paragraphGyoudori

Boolean

read/write

If true, the gyoudori mode applies to the entire paragraph. If false, the gyoudori mode applies to each line in the paragraph.

paragraphJustification

ParagraphJustificationOptions

ParagraphJustificationOptions.ARABIC_JUSTIFICATION

ParagraphJustificationOptions.DEFAULT_JUSTIFICATION

ParagraphJustificationOptions.NASKH_JUSTIFICATION

ParagraphJustificationOptions.NASKH_KASHIDA_JUSTIFICATION

ParagraphJustificationOptions.NASKH_KASHIDA_JUSTIFICATION_FRAC

ParagraphJustificationOptions.NASKH_TATWEEL_JUSTIFICATION

ParagraphJustificationOptions.NASKH_TATWEEL_JUSTIFICATION_FRAC

read/write

Paragraph justification.

paragraphKashidaWidth

Number

read/write

Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long

paragraphShadingBottomLeftCornerOption

CornerOptions

CornerOptions.BEVEL_CORNER

CornerOptions.FANCY_CORNER

CornerOptions.INSET_CORNER

CornerOptions.INVERSE_ROUNDED_CORNER

CornerOptions.NONE

CornerOptions.ROUNDED_CORNER

read/write

The shape to apply to the bottom left corner of rectangular shapes.

paragraphShadingBottomLeftCornerRadius

Number

String

read/write

The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes

paragraphShadingBottomOffset

Number

String

read/write

The distance to offset the bottom edge of the paragraph.

paragraphShadingBottomOrigin

ParagraphShadingBottomOriginEnum

ParagraphShadingBottomOriginEnum.BASELINE_BOTTOM_ORIGIN

ParagraphShadingBottomOriginEnum.DESCENT_BOTTOM_ORIGIN

read/write

The basis (descent or baseline) used to calculate the bottom origin of the paragraph shading.

paragraphShadingBottomRightCornerOption

CornerOptions

CornerOptions.BEVEL_CORNER

CornerOptions.FANCY_CORNER

CornerOptions.INSET_CORNER

CornerOptions.INVERSE_ROUNDED_CORNER

CornerOptions.NONE

CornerOptions.ROUNDED_CORNER

read/write

The shape to apply to the bottom right corner of rectangular shapes.

paragraphShadingBottomRightCornerRadius

Number

String

read/write

The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes

paragraphShadingClipToFrame

Boolean

read/write

If true, forces the shading of the paragraph to be clipped with respect to frame shape.

paragraphShadingColor

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the paragraph shading. Can return: Swatch or String.

paragraphShadingLeftOffset

Number

String

read/write

The distance to offset the left edge of the paragraph.

paragraphShadingOn

Boolean

read/write

If true, the paragraph shading is On.

paragraphShadingOverprint

Boolean

read/write

If true, the paragraph shading will overprint.

paragraphShadingRightOffset

Number

String

read/write

The distance to offset the right edge of the paragraph.

paragraphShadingSuppressPrinting

Boolean

read/write

If true, suppress printing of the shading of the paragraph.

paragraphShadingTint

Number (range 0 - 100)

read/write

The tint (as a percentage) of the paragraph shading. (Range: 0 to 100)

paragraphShadingTopLeftCornerOption

CornerOptions

CornerOptions.BEVEL_CORNER

CornerOptions.FANCY_CORNER

CornerOptions.INSET_CORNER

CornerOptions.INVERSE_ROUNDED_CORNER

CornerOptions.NONE

CornerOptions.ROUNDED_CORNER

read/write

The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight.

paragraphShadingTopLeftCornerRadius

Number

String

read/write

The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes

paragraphShadingTopOffset

Number

String

read/write

The distance to offset the top edge of the paragraph.

paragraphShadingTopOrigin

ParagraphShadingTopOriginEnum

ParagraphShadingTopOriginEnum.ASCENT_TOP_ORIGIN

ParagraphShadingTopOriginEnum.BASELINE_TOP_ORIGIN

ParagraphShadingTopOriginEnum.LEADING_TOP_ORIGIN

read/write

The basis (cap height, ascent or baseline) used to calculate the top origin of the paragraph shading.

paragraphShadingTopRightCornerOption

CornerOptions

CornerOptions.BEVEL_CORNER

CornerOptions.FANCY_CORNER

CornerOptions.INSET_CORNER

CornerOptions.INVERSE_ROUNDED_CORNER

CornerOptions.NONE

CornerOptions.ROUNDED_CORNER

read/write

The shape to apply to the top right corner of rectangular shapes

paragraphShadingTopRightCornerRadius

Number

String

read/write

The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes

paragraphShadingWidth

ParagraphShadingWidthEnum

ParagraphShadingWidthEnum.COLUMN_WIDTH

ParagraphShadingWidthEnum.TEXT_WIDTH

read/write

The basis (text width or column width) used to calculate the width of the paragraph shading.

paragraphs

Paragraphs Paragraph

readonly

A collection of paragraphs.

parent

Document

readonly

The parent of the XmlStory (a Document).

pointSize

Number

String

read/write

The text size.

polygons

Polygons Polygon

readonly

A collection of polygons.

position

Position

Position.NORMAL

Position.OT_DENOMINATOR

Position.OT_NUMERATOR

Position.OT_SUBSCRIPT

Position.OT_SUPERSCRIPT

Position.SUBSCRIPT

Position.SUPERSCRIPT

read/write

The text position relative to the baseline.

positionalForm

PositionalForms

PositionalForms.CALCULATE

PositionalForms.FINAL

PositionalForms.INITIAL

PositionalForms.ISOLATED

PositionalForms.MEDIAL

PositionalForms.NONE

read/write

The OpenType positional form.

preferences

Preferences Preference

readonly

A collection of preferences objects.

properties

Object

read/write

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

providerHyphenationStyle

HyphenationStyleEnum

HyphenationStyleEnum.HYPH_AESTHETIC

HyphenationStyleEnum.HYPH_ALL

HyphenationStyleEnum.HYPH_ALL_BUT_UNAESTHETIC

HyphenationStyleEnum.HYPH_PREFERRED_AESTHETIC

read/write

The hyphenation style chosen for the provider.

radioButtons

RadioButtons RadioButton

readonly

A collection of radio buttons.

rectangles

Rectangles Rectangle

readonly

A collection of rectangles.

rensuuji

Boolean

read/write

If true, disallows line breaks in numbers. If false, lines can break between digits in multi-digit numbers.

rightIndent

Number

String

read/write

The width of the right indent.

rotateSingleByteCharacters

Boolean

read/write

If true, rotates Roman characters in vertical text.

rubyAlignment

RubyAlignments

RubyAlignments.RUBY_1_AKI

RubyAlignments.RUBY_CENTER

RubyAlignments.RUBY_EQUAL_AKI

RubyAlignments.RUBY_FULL_JUSTIFY

RubyAlignments.RUBY_JIS

RubyAlignments.RUBY_LEFT

RubyAlignments.RUBY_RIGHT

read/write

The ruby alignment.

rubyAutoAlign

Boolean

read/write

If true, auto aligns ruby.

rubyAutoScaling

Boolean

read/write

If true, automatically scales ruby to the specified percent of parent text size. For information on specifying a percent, see ruby parent scaling percent.

rubyAutoTcyAutoScale

Boolean

read/write

If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to fit one em.

rubyAutoTcyDigits

Number

read/write

The number of digits included in auto tcy (tate-chuu-yoko) in ruby.

rubyAutoTcyIncludeRoman

Boolean

read/write

If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby.

rubyFill

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby characters. Can return: Swatch or String.

rubyFlag

Boolean

read/write

If true, ruby is on.

rubyFont

Font

String

read/write

The font applied to ruby characters. Can return: Font or String.

rubyFontSize

Number

read/write

The size (in points) of ruby characters.

rubyFontStyle

String

NothingEnum.NOTHING

read/write

The font style of ruby characters. Can return: String or NothingEnum enumerator.

rubyOpenTypePro

Boolean

read/write

If true, uses OpenType Pro fonts for ruby.

rubyOverhang

Boolean

read/write

If true, constrains ruby overhang to the specified amount. For information on specifying an amount, see ruby parent overhang amount.

rubyOverprintFill

AdornmentOverprint

AdornmentOverprint.AUTO

AdornmentOverprint.OVERPRINT_OFF

AdornmentOverprint.OVERPRINT_ON

read/write

The method of overprinting the ruby fill.

rubyOverprintStroke

AdornmentOverprint

AdornmentOverprint.AUTO

AdornmentOverprint.OVERPRINT_OFF

AdornmentOverprint.OVERPRINT_ON

read/write

The method of overprinting the ruby stroke.

rubyParentOverhangAmount

RubyOverhang

RubyOverhang.NONE

RubyOverhang.RUBY_OVERHANG_HALF_CHAR

RubyOverhang.RUBY_OVERHANG_HALF_RUBY

RubyOverhang.RUBY_OVERHANG_NO_LIMIT

RubyOverhang.RUBY_OVERHANG_ONE_CHAR

RubyOverhang.RUBY_OVERHANG_ONE_RUBY

read/write

The amount by which ruby characters can overhang the parent text.

rubyParentScalingPercent

Number

read/write

The amount (as a percentage) to scale the parent text size to determine the ruby text size.

rubyParentSpacing

RubyParentSpacing

RubyParentSpacing.RUBY_PARENT_121_AKI

RubyParentSpacing.RUBY_PARENT_BOTH_SIDES

RubyParentSpacing.RUBY_PARENT_EQUAL_AKI

RubyParentSpacing.RUBY_PARENT_FULL_JUSTIFY

RubyParentSpacing.RUBY_PARENT_NO_ADJUSTMENT

read/write

The ruby spacing relative to the parent text.

rubyPosition

RubyKentenPosition

RubyKentenPosition.ABOVE_RIGHT

RubyKentenPosition.BELOW_LEFT

read/write

The position of ruby characters relative to the parent text.

rubyString

String

read/write

The ruby string contents.

rubyStroke

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the stroke of ruby characters. Can return: Swatch or String.

rubyStrokeTint

Number

read/write

The stroke tint (as a percentage) of ruby characters.

rubyTint

Number (range 0 - 100)

read/write

The tint (as a percentage) of the ruby fill color. (Range: 0 to 100)

rubyType

RubyTypes

RubyTypes.GROUP_RUBY

RubyTypes.PER_CHARACTER_RUBY

read/write

The ruby type.

rubyWeight

Number

read/write

The stroke weight (in points) of ruby characters.

rubyXOffset

Number

read/write

The amount of horizontal space between ruby and parent characters.

rubyXScale

Number

read/write

The horizontal size of ruby characters, specified as a percent of the original size.

rubyYOffset

Number

read/write

The amount of vertical space between ruby and parent characters.

rubyYScale

Number

read/write

The vertical size of ruby characters, specified as a percent of the original size.

ruleAbove

Boolean

read/write

If true, places a rule above the paragraph.

ruleAboveColor

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule above. Can return: Swatch or String.

ruleAboveGapColor

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the paragraph rule above. Note: Valid only when the paragraph rule above type is not solid. Can return: Swatch or String.

ruleAboveGapOverprint

Boolean

read/write

If true, the stroke gap of the paragraph rule above will overprint. Note: Valid only the rule above type is not solid.

ruleAboveGapTint

Number (range 0 - 100)

read/write

The tint (as a percentage) of the stroke gap color of the paragraph rule. (Range: 0 to 100) Note: Valid only when the rule above type is not solid.

ruleAboveLeftIndent

Number

String

read/write

The distance to indent the left edge of the paragraph rule above (based on either the text width or the column width of the first line in the paragraph.

ruleAboveLineWeight

Number

String

read/write

The line weight of the rule above.

ruleAboveOffset

Number

String

read/write

The amount to offset the paragraph rule above from the baseline of the first line the paragraph.

ruleAboveOverprint

Boolean

read/write

If true, the paragraph rule above will overprint.

ruleAboveRightIndent

Number

String

read/write

The distance to indent the right edge of the paragraph rule above (based on either the text width or the column width of the first line in the paragraph.

ruleAboveTint

Number (range 0 - 100)

read/write

The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100)

ruleAboveType

StrokeStyle

String

read/write

The stroke type of the rule above the paragraph. Can return: StrokeStyle or String.

ruleAboveWidth

RuleWidth

RuleWidth.COLUMN_WIDTH

RuleWidth.TEXT_WIDTH

read/write

The basis (text width or column width) used to calculate the width of the paragraph rule above.

ruleBelow

Boolean

read/write

If true, applies a paragraph rule below.

ruleBelowColor

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule below. Can return: Swatch or String.

ruleBelowGapColor

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the paragraph rule below. Note: Valid only when the paragraph rule below type is not solid. Can return: Swatch or String.

ruleBelowGapOverprint

Boolean

read/write

If true, the gap color of the rule below will overprint.

ruleBelowGapTint

Number (range 0 - 100)

read/write

The tint (as a percentage) of the stroke gap color of the paragraph rule below. (Range: 0 to 100) Note: Valid only when the paragraph rule below type is not solid.

ruleBelowLeftIndent

Number

String

read/write

The distance to indent the left edge of the paragraph rule below (based on either the text width or the column width of the last line in the paragraph.

ruleBelowLineWeight

Number

String

read/write

The line weight of the rule below.

ruleBelowOffset

Number

String

read/write

The amount to offset the the paragraph rule below from the baseline of the last line of the paragraph.

ruleBelowOverprint

Boolean

read/write

If true, the rule below will overprint.

ruleBelowRightIndent

Number

String

read/write

The distance to indent the right edge of the paragraph rule below (based on either the text width or the column width of the last line in the paragraph.

ruleBelowTint

Number (range 0 - 100)

read/write

The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100)

ruleBelowType

StrokeStyle

String

read/write

The stroke type of the rule below the paragraph. Can return: StrokeStyle or String.

ruleBelowWidth

RuleWidth

RuleWidth.COLUMN_WIDTH

RuleWidth.TEXT_WIDTH

read/write

The basis (text width or column width) used to calculate the width of the paragraph rule below.

scaleAffectsLineHeight

Boolean

read/write

If true, the line changes size when characters are scaled.

shataiAdjustRotation

Boolean

read/write

If true, applies shatai rotation.

shataiAdjustTsume

Boolean

read/write

If true, adjusts shatai tsume.

shataiDegreeAngle

Number

read/write

The shatai lens angle (in degrees).

shataiMagnification

Number

read/write

The amount (as a percentage) of shatai obliquing to apply.

signatureFields

SignatureFields SignatureField

readonly

A collection of signature fields.

singleWordJustification

SingleWordJustification

SingleWordJustification.CENTER_ALIGN

SingleWordJustification.FULLY_JUSTIFIED

SingleWordJustification.LEFT_ALIGN

SingleWordJustification.RIGHT_ALIGN

read/write

The alignment to use for lines that contain a single word.

skew

Number

read/write

The skew angle of the XmlStory.

spaceAfter

Number

String

read/write

The height of the paragraph space below.

spaceBefore

Number

String

read/write

The height of the paragraph space above.

spanColumnMinSpaceAfter

Number

String

read/write

The minimum space after a span or a split column

spanColumnMinSpaceBefore

Number

String

read/write

The minimum space before a span or a split column

spanColumnType

SpanColumnTypeOptions

SpanColumnTypeOptions.SINGLE_COLUMN

SpanColumnTypeOptions.SPAN_COLUMNS

SpanColumnTypeOptions.SPLIT_COLUMNS

read/write

Whether a paragraph should be a single column, span columns or split columns

spanSplitColumnCount

ShortInteger(1-40)

SpanColumnCountOptions

SpanColumnCountOptions.ALL

read/write

The number of columns a paragraph spans or the number of split columns. Can return: Short Integer (1 - 40) or SpanColumnCountOptions enumerator.

splineItems

SplineItems SplineItem

readonly

The spline items collection.

splitColumnInsideGutter

Number

String

read/write

The inside gutter if the paragraph splits columns

splitColumnOutsideGutter

Number

String

read/write

The outside gutter if the paragraph splits columns

startParagraph

StartParagraph

StartParagraph.ANYWHERE

StartParagraph.NEXT_COLUMN

StartParagraph.NEXT_EVEN_PAGE

StartParagraph.NEXT_FRAME

StartParagraph.NEXT_ODD_PAGE

StartParagraph.NEXT_PAGE

read/write

The location at which to start the paragraph.

storyPreferences

StoryPreference

readonly

Story preference settings.

storyTitle

String

read/write

Title for this InCopy story.

storyType

StoryTypes

StoryTypes.INDEXING_STORY

StoryTypes.REGULAR_STORY

StoryTypes.TOC_STORY

readonly

The type of story.

strikeThroughColor

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch or String.

strikeThroughGapColor

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: Swatch or String.

strikeThroughGapOverprint

Boolean

read/write

If true, the gap color of the strikethrough stroke will overprint. Note: Valid when strike through type is not solid.

strikeThroughGapTint

Number (range 0 - 100)

read/write

The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 to 100) Note: Valid when strike through type is not solid.

strikeThroughOffset

Number

String

read/write

The amount by which to offset the strikethrough stroke from the text baseline.

strikeThroughOverprint

Boolean

read/write

If true, the strikethrough stroke will overprint.

strikeThroughTint

Number (range 0 - 100)

read/write

The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100)

strikeThroughType

StrokeStyle

String

read/write

The stroke type of the strikethrough stroke. Can return: StrokeStyle or String.

strikeThroughWeight

Number

String

read/write

The stroke weight of the strikethrough stroke.

strikeThru

Boolean

read/write

If true, draws a strikethrough line through the text.

strokeAlignment

TextStrokeAlign

TextStrokeAlign.CENTER_ALIGNMENT

TextStrokeAlign.OUTSIDE_ALIGNMENT

read/write

The stroke alignment applied to the text.

strokeColor

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the XmlStory. Can also accept: String.

strokeTint

Number (range 0 - 100)

read/write

The tint (as a percentage) of the stroke color of the XmlStory. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)

strokeWeight

Number

String

read/write

The stroke weight applied to the characters of the text.

styleOverridden

Boolean

readonly

If true, the applied style has been overridden with additional attributes.

tabList

Array of Arrays of Property Name/Value Pairs.

read/write

A list of the tab stops in the paragraph. Can return: Array of Arrays of Property Name/Value Pairs.

tabStops

TabStops TabStop

readonly

A collection of tab stops.

tableStyleMappings

TableStyleMappings TableStyleMapping

readonly

A collection of table style mappings.

tables

Tables Table

readonly

A collection of tables.

tatechuyoko

Boolean

read/write

If true, makes the character horizontal in vertical text.

tatechuyokoXOffset

Number

read/write

The horizontal offset for horizontal characters in vertical text.

tatechuyokoYOffset

Number

read/write

The vertical offset for horizontal characters in vertical text.

textBoxes

TextBoxes

readonly

A collection of text boxes.

textColumns

TextColumns TextColumn

readonly

A collection of text columns.

textContainers

Array of TextFrames

Array of TextPaths TextPath

readonly

Array of text frames or text paths. Can return: Array of TextFrames or TextPaths.

textFrames

TextFrames TextFrame

readonly

A collection of text frames.

textStyleRanges

TextStyleRanges TextStyleRange

readonly

A collection of text style ranges.

textVariableInstances

TextVariableInstances TextVariableInstance

readonly

A collection of text variable instances.

texts

Texts Text

readonly

A collection of text objects.

trackChanges

Boolean

read/write

If true, track changes is turned on.

tracking

Number

read/write

The amount by which to loosen or tighten a block of text, specified in thousands of an em.

trailingAki

Number

read/write

The amount of space after each character.

treatIdeographicSpaceAsSpace

Boolean

read/write

If true, ideographic spaces will not wrap to the next line like text characters.

tsume

Number

read/write

The amount of horizontal character compression.

typefiElementAnchors

TypefiElementAnchors TypefiElementAnchor

readonly

A list of Typefi element anchors

underline

Boolean

read/write

If true, underlines the text.

underlineColor

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch or String.

underlineGapColor

Swatch

String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the gap of the underline stroke. Note: Valid when underline type is not solid. Can return: Swatch or String.

underlineGapOverprint

Boolean

read/write

If true, the gap color of the underline stroke will overprint.

underlineGapTint

Number (range 0 - 100)

read/write

The tint (as a percentage) of the gap color of the underline stroke. (Range: 0 to 100) Note: Valid when underline type is not solid.

underlineOffset

Number

String

read/write

The amount by which to offset the underline from the text baseline.

underlineOverprint

Boolean

read/write

If true, the underline stroke color will overprint.

underlineTint

Number (range 0 - 100)

read/write

The underline stroke tint (as a percentage). (Range: 0 to 100)

underlineType

StrokeStyle

String

read/write

The stroke type of the underline stroke. Can return: StrokeStyle or String.

underlineWeight

Number

String

read/write

The stroke weight of the underline stroke.

userText

Boolean

read/write

Indicates whether the text is user or placeholder text.

verticalScale

Number

read/write

The vertical scaling applied to the XmlStory.

warichu

Boolean

read/write

If true, turns on warichu.

warichuAlignment

WarichuAlignment

WarichuAlignment.AUTO

WarichuAlignment.CENTER_ALIGN

WarichuAlignment.CENTER_JUSTIFIED

WarichuAlignment.FULLY_JUSTIFIED

WarichuAlignment.LEFT_ALIGN

WarichuAlignment.LEFT_JUSTIFIED

WarichuAlignment.RIGHT_ALIGN

WarichuAlignment.RIGHT_JUSTIFIED

read/write

The warichu alignment.

warichuCharsAfterBreak

Number

read/write

The minimum number of characters allowed after a line break.

warichuCharsBeforeBreak

Number

read/write

The minimum number of characters allowed before a line break.

warichuLineSpacing

Number

read/write

The gap between lines of warichu characters.

warichuLines

Number

read/write

The number of lines of warichu within a single normal line.

warichuSize

Number

read/write

The amount (as a percentage) to scale parent text size to determine warichu size.

words

Words Word

readonly

A collection of words.

xOffsetDiacritic

Number

read/write

The x (horizontal) offset for diacritic adjustment.

yOffsetDiacritic

Number

read/write

The y (vertical) offset for diacritic adjustment.

Constants/Events

Name

Type

Access

Description

AFTER_PLACE

String

readonly

Dispatched after a XmlStory is placed. This event bubbles. This event is not cancelable.

BEFORE_PLACE

String

readonly

Dispatched before a XmlStory is placed. This event bubbles. This event is cancelable.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

BackgroundTask asynchronousExportFile (format:Varies ExportFormat String, to:File, [showingOptions:Boolean=Boolean], using:PDFExportPreset, versionComments:String, [forceSave:Boolean=Boolean])

asynchronously exports the object(s) to a file.

Parameter

Type

Description

format

ExportFormat

ExportFormat.EPS_TYPE

ExportFormat.EPUB

ExportFormat.FIXED_LAYOUT_EPUB

ExportFormat.HTML

ExportFormat.HTMLFXL

ExportFormat.INCOPY_MARKUP

ExportFormat.INDESIGN_MARKUP

ExportFormat.INDESIGN_SNIPPET

ExportFormat.INTERACTIVE_PDF

ExportFormat.JPG

ExportFormat.PACKAGED_XFL

ExportFormat.PDF_TYPE

ExportFormat.PNG_FORMAT

ExportFormat.RTF

ExportFormat.SWF

ExportFormat.TAGGED_TEXT

ExportFormat.TEXT_TYPE

ExportFormat.XML

String

The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.

to

File

The path to the export file.

showingOptions

Boolean

If true, displays the export options dialog. (Optional)

(default: false)

using

PDFExportPreset

The export style. (Optional)

versionComments

String

The comment for this version. (Optional)

forceSave

Boolean

If true, forcibly saves a version. (Optional)

(default: false)

Text changeGlyph (reverseOrder:Boolean)

Finds glyphs that match the find what value and replaces the glyphs with the change to value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text changeGrep (reverseOrder:Boolean)

Finds text that matches the find what value and replaces the text with the change to value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text changeText (reverseOrder:Boolean)

Finds text that matches the find what value and replaces the text with the change to value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text changeTransliterate (reverseOrder:Boolean)

Finds text that matches the find character type value and replaces the text with the change character type value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

undefined changecase (using:ChangecaseMode)

Sets the case of the text.

Parameter

Type

Description

using

ChangecaseMode

ChangecaseMode.LOWERCASE

ChangecaseMode.SENTENCECASE

ChangecaseMode.TITLECASE

ChangecaseMode.UPPERCASE

The text case option.

undefined clearOverrides ([overridesToClear:OverrideType=OverrideType])

Clears the specified types of override.

Parameter

Type

Description

overridesToClear

OverrideType

OverrideType.ALL

OverrideType.CHARACTER_ONLY

OverrideType.PARAGRAPH_ONLY

The types of override to clear. (Optional)

(default: OverrideType.ALL)

undefined convertBulletsAndNumberingToText ()

Convert bullets and numbering to text.

PageItem createOutlines ([deleteOriginal:Boolean=Boolean])

Converts text to outlines. Each line of text becomes a polygon object. When the converted text is a single letter that has no internal spaces or detached parts, the polygon contains only a single path. Note: To determine whether a font allows the creation of outlines, see allow outlines.

Parameter

Type

Description

deleteOriginal

Boolean

If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional)

(default: true)

Text duplicate (to:LocationOptions, reference:Varies Cell Column Row Story Table Text PageItem)

Duplicates the text in the specified location.

Parameter

Type

Description

to

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location relative to the reference object or within the containing object.

reference

Cell

Column

Row

Story

Table

Text

PageItem

The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

Text findGlyph (reverseOrder:Boolean)

Finds glyphs that match the find what value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text findGrep (reverseOrder:Boolean)

Finds text that matches the find what value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text findText (reverseOrder:Boolean)

Finds text that matches the find what value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text findTransliterate (reverseOrder:Boolean)

Finds text that matches the find character type value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

XmlStory getElements ()

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

undefined insertLabel (key:String, value:String)

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

Parameter

Type

Description

key

String

The key.

value

String

The value.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the XmlStory.

String toSpecifier ()

Retrieves the object specifier.

Object of

Bullet.parent

CellStyleMapping.parent

Change.parent

CharStyleMapping.parent

Character.parent

Endnote.parent

EndnoteRange.parent

Event.parent

EventListener.parent

Footnote.parent

GridDataInformation.parent

HiddenText.parent

InCopyExportOption.parent

InsertionPoint.parent

Line.parent

LinkedStoryOption.parent

MutationEvent.parent

NestedGrepStyle.parent

NestedLineStyle.parent

NestedStyle.parent

Note.parent

NumberingRestartPolicy.parent

ParaStyleMapping.parent

Paragraph.parent

Preference.parent

StoryPreference.parent

TabStop.parent

Table.parent

TableStyleMapping.parent

Text.parent

TextColumn.parent

TextStyleRange.parent

TextVariableInstance.parent

TypefiElementAnchor.parent

Word.parent

Return

XmlStory.getElements()

XmlStories.anyItem()

XmlStories.everyItem()

XmlStories.itemByRange()

XmlStories.nextItem()

XmlStories.previousItem()

XmlStories.itemByID()

XmlStories.item()

XmlStories.[]()

XmlStories.itemByName()

XmlStories.firstItem()

XmlStories.lastItem()

XmlStories.middleItem()