Object

InsertionPoint

An insertion point between two characters.

Text ›InsertionPoint

Hierarchy

InsertionPoint

3 preference objects

Bullet | NumberingRestartPolicy | Preference

Properties

Type	Access	Description
Boolean	read/write	If true, aligns the baseline of the text to the baseline grid.
Graphic[]	readonly	Lists all graphics contained by the InsertionPoint.
PageItem[]	readonly	Lists all page items contained by the InsertionPoint.
Boolean	read/write	If true, words unassociated with a hyphenation dictionary can break to the next line on any character.
CharacterStyle \| String	read/write	The character style applied to the text. Can also accept: String.
Condition[]	read/write	The applied conditions.
Font \| String	read/write	The font applied to the InsertionPoint, specified as either a font object or the name of font family. Can return: Font or String.
LanguageWithVendors \| String \| Language	read/write	The language of the text. Can return: LanguageWithVendors or Language. Can also accept: String.
CharacterStyle[]	readonly	The applied character styles dictated by nested styles.
NumberingList \| String	read/write	The list to be part of. Can return: NumberingList or String.
ParagraphStyle \| String	read/write	The paragraph style applied to the text. Can also accept: String.
Number \| String unit	readonly	The maximum ascent of any character in the text.
XMLItem[]	readonly	The XML elements associated with the InsertionPoint.
Number 0–500	read/write	The percent of the type size to use for auto leading. (Range: 0 to 500).
Number	read/write	The number of half-width characters at or below which the characters automatically run horizontally in vertical text.
Boolean	read/write	If true, auto tcy includes Roman characters.
Boolean \| BalanceLinesStyle	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.
Number \| String unit	readonly	The vertical offset of the text.
Number \| String unit	read/write	The baseline shift applied to the text.
Bullet	readonly	Bullet character.
ListAlignment	read/write	The alignment of the bullet character.
ListType	read/write	List type for bullets and numbering.
CharacterStyle \| String	read/write	The character style to be used for the text after string. Can return: CharacterStyle or String.
String	read/write	The text after string expression for bullets.
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<Button>	readonly	A collection of buttons.
Capitalization	read/write	The capitalization scheme.
CharacterAlignment	read/write	The alignment of small characters to the largest character in the line.
CharacterDirectionOptions	read/write	The direction of the character.
Number	read/write	The rotation angle (in degrees) of individual characters. Note: The rotation is counterclockwise.
Characters<Character>	readonly	A collection of characters.
CheckBoxes<CheckBox>	readonly	A collection of checkboxes.
Boolean	read/write	If true, uses grid tracking to track non-Roman characters in CJK grids.
ComboBoxes<ComboBox>	readonly	A collection of comboboxes.
String	read/write	The text composer to use to compose the text.
String \| SpecialCharacters +52 more	read/write	The contents of the text. Can return: String or SpecialCharacters enumerator.
Number \| String unit	readonly	The maximum descent of any character in the text.
Number[]	read/write	Value of Design Axes
Number 50–200	read/write	The desired width (as a percentage) of individual characters. (Range: 50 to 200)
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)
Number 0–1000	read/write	The desired word spacing, specified as a percentage of the font word space value. (Range: 0 to 1000)
DiacriticPositionOptions	read/write	Position of diacriticical characters.
DigitsTypeOptions +8 more	read/write	The digits type.
Number 0–150	read/write	The number of characters to drop cap.
Number 0–25	read/write	The number of lines to drop cap.
CharacterStyle \| String	read/write	The character style to apply to the drop cap. Can also accept: String.
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.
Number \| String unit	readonly	Vertical offset of the end of the text.
Number \| String unit	readonly	Horizontal offset of the end of the text.
OutlineJoin	read/write	The stroke join type applied to the characters of the text.
EndnoteRanges<EndnoteRange>	readonly	A collection of endnote text ranges.
EndnoteTextFrames<EndnoteTextFrame>	readonly	A collection of endnote text frames.
Endnotes<Endnote>	readonly	A collection of endnotes.
EPSTexts<EPSText>	readonly	EPSTexts
EventListeners<EventListener>	readonly	A collection of event listeners.
Events<Event>	readonly	A collection of events.
Swatch \| String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the fill of the InsertionPoint. . Can also accept: String.
Number 0–100	read/write	The tint (as a percentage) of the fill color of the InsertionPoint. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
Number \| String unit	read/write	The amount to indent the first line.
String	read/write	The name of the font style.
Footnotes<Footnote>	readonly	A collection of footnotes.
FormFields<FormField>	readonly	A collection of form fields.
AlternateGlyphForms +1 more	read/write	The glyph variant to substitute for standard glyphs.
Number	read/write	The angle of a linear gradient applied to the fill of the text. (Range: -180 to 180)
Number	read/write	The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text.
Number[] \| String[] unit	read/write	The starting point (in page coordinates) of a gradient applied to the fill of the text, in the format [x, y].
Number	read/write	The angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180)
Number	read/write	The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text.
Number[] \| String[] unit	read/write	The starting point (in page coordinates) of a gradient applied to the stroke of the text, in the format [x, y].
GraphicLines<GraphicLine>	readonly	A collection of graphic lines.
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	read/write	The alignment to the frame grid or baseline grid.
Number	read/write	The manual gyoudori setting.
Groups<Group>	readonly	A collection of groups.
HiddenTexts<HiddenText>	readonly	A collection of hidden text objects.
Number \| String unit	readonly	The horizontal offset of the text.
Number	read/write	The horizontal scaling applied to the InsertionPoint.
Number 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)
Boolean	read/write	If true, allows the last word in a text column to be hyphenated.
Number 1–15	read/write	The mininum number of letters at the beginning of a word that can be broken by a hyphen.
Number 1–15	read/write	The minimum number of letters at the end of a word that can be broken by a hyphen.
Boolean	read/write	If true, allows hyphenation of capitalized words.
Number 0–25	read/write	The maximum number of hyphens that can appear on consecutive lines. To specify unlimited consecutive lines, use zero.
Boolean	read/write	If true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true.
Number 3–25	read/write	The minimum number of letters a word must have in order to qualify for hyphenation.
Boolean	read/write	If true, allows hyphenation.
Number \| String unit	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.
Boolean	read/write	If true, ignores optical edge alignment for the paragraph.
Number	readonly	The index of the text in the collection or parent object.
InsertionPoints<InsertionPoint>	readonly	A collection of insertion points.
Boolean	readonly	Returns true if the object specifier resolves to valid objects.
Number	read/write	The number of grid squares in which to arrange the text.
Justification	read/write	The paragraph alignment.
KashidasOptions	read/write	Use of Kashidas for justification
Boolean	read/write	If true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns.
Number 1–50	read/write	The minimum number of lines to keep together in a paragraph before allowing a page break.
Number 1–50	read/write	The minimum number of lines to keep together in a paragraph after a page break.
Boolean	read/write	If true, keeps a specified number of lines together when the paragraph breaks across columns or text frames.
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.
Number 0–5	read/write	The minimum number of lines to keep with the next paragraph.
Boolean	read/write	If the first line in the paragraph should be kept with the last line of previous paragraph.
KentenAlignment	read/write	The alignment of kenten characters relative to the parent characters.
KentenCharacterSet	read/write	The character set used for the custom kenten character. Note: Valid only when kenten kind is custom.
String	read/write	The character used for kenten. Note: Valid only when kenten kind is custom.
Swatch \| String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the fill of kenten characters. Can return: Swatch or String.
Font \| String	read/write	The font to use for kenten characters. Can return: Font or String.
Number	read/write	The size (in points) of kenten characters.
String \| NothingEnum	read/write	The font style of kenten characters. Can return: String or NothingEnum enumerator.
KentenCharacter	read/write	The style of kenten characters.
AdornmentOverprint	read/write	The method of overprinting the kenten fill.
AdornmentOverprint	read/write	The method of overprinting the kenten stroke.
Number	read/write	The distance between kenten characters and their parent characters.
RubyKentenPosition	read/write	The kenten position relative to the parent character.
Swatch \| String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the stroke of kenten characters. Can return: Swatch or String.
Number 0–100	read/write	The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100)
Number 0–100	read/write	The fill tint (as a percentage) of kenten characters. (Range: 0 to 100)
Number	read/write	The stroke weight (in points) of kenten characters.
Number	read/write	The horizontal size of kenten characters as a percent of the original size.
Number	read/write	The vertical size of kenten charachers as a percent of the original size.
String	read/write	The type of pair kerning.
Number	read/write	The amount of space to add or remove between characters, specified in thousands of an em.
CharacterDirectionOptions	read/write	The keyboard direction of the character.
KinsokuHangTypes	read/write	The type of hanging punctuation to allow. Note: Valid only when a kinsoku set is in effect.
KinsokuSet \| KinsokuTable \| String	read/write	The kinsoku set that determines legitimate line breaks. Can return: KinsokuTable, KinsokuSet enumerator or String.
KinsokuType	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.
Number \| String unit	read/write	The amount to indent the last line in the paragraph.
Unit \| Leading	read/write	The leading applied to the text. Can return: Unit or Leading enumerator.
Number	read/write	The amount of space before each character.
LeadingModel	read/write	The point from which leading is measured from line to line.
Number \| String unit	read/write	The width of the left indent.
Number	readonly	The number of objects in the collection.
Boolean	read/write	If true, replaces specific character combinations (e.g., fl, fi) with ligature characters.
Lines<Line>	readonly	A collection of lines.
ListBoxes<ListBox>	readonly	A collection of listboxes.
Number 50–200	read/write	The maximum width (as a percentage) of individual characters. (Range: 50 to 200)
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.
Number 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)
Boolean	read/write	If true, consecutive para borders with completely similar properties are merged.
Number 50–200	read/write	The minimum width (as a percentage) of individual characters. (Range: 50 to 200)
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.
Number 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)
Number = 4 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.
MojikumiTable \| String \| MojikumiTableDefaults +5 more	read/write	The mojikumi table. For information, see mojikumi table defaults. Can return: MojikumiTable, String or MojikumiTableDefaults enumerator.
MultiStateObjects<MultiStateObject>	readonly	A collection of multi-state objects.
NestedGrepStyles<NestedGrepStyle>	readonly	A collection of nested GREP styles.
NestedLineStyles<NestedLineStyle>	readonly	A collection of nested line styles.
NestedStyles<NestedStyle>	readonly	A collection of nested styles.
Boolean	read/write	If true, keeps the text on the same line.
Notes<Note>	readonly	A collection of notes.
ListAlignment	read/write	The alignment of the number.
Boolean	read/write	If true, apply the numbering restart policy.
CharacterStyle \| String	read/write	The character style to be used for the number string. Can return: CharacterStyle or String.
Boolean	read/write	Continue the numbering at this level.
String	read/write	The number string expression for numbering.
NumberingStyle \| String +4 more	read/write	Numbering format options. Can return: NumberingStyle enumerator or String.
Number	read/write	The level of the paragraph.
NumberingRestartPolicy	readonly	Numbering restart policies.
Number	read/write	Determines starting number in a numbered list.
2 Strings[] \| LongIntegers[]	read/write	OpenType features. Can return: Array of Array of 2 Strings or Long Integers.
Boolean	read/write	If true, uses contextual alternate forms in OpenType fonts.
Boolean	read/write	If true, uses discretionary ligatures in OpenType fonts.
OTFFigureStyle	read/write	The figure style in OpenType fonts.
Boolean	read/write	If true, uses fractions in OpenType fonts.
Boolean	read/write	If true, switches hiragana fonts, which have different glyphs for horizontal and vertical.
Boolean	read/write	If true, use historical forms in OpenType fonts.
Boolean	read/write	If true, use alternate justification forms in OpenType fonts
Boolean	read/write	If true, uses localized forms in OpenType fonts.
Boolean	read/write	If true, uses mark positioning in OpenType fonts.
Boolean	read/write	If true, uses ordinals in OpenType fonts.
Boolean	read/write	If true, use overlapping swash forms in OpenType fonts
Boolean	read/write	If true, kerns according to proportional CJK metrics in OpenType fonts.
Boolean	read/write	If true, applies italics to half-width alphanumerics.
Boolean	read/write	If true, use a slashed zeroes in OpenType fonts.
Boolean	read/write	If true, use stretched alternate forms in OpenType fonts
Boolean	read/write	If true, use stylistic alternate forms in OpenType fonts
Number	read/write	The stylistic sets to use in OpenType fonts.
Boolean	read/write	If true, uses swash forms in OpenType fonts.
Boolean	read/write	If true, uses titling forms in OpenType fonts.
Ovals<Oval>	readonly	A collection of ellipses.
Boolean	read/write	If true, the fill color of the characters will overprint.
Boolean	read/write	If true, the stroke of the characters will overprint.
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.
CornerOptions	read/write	The shape to apply to the bottom left corner of rectangular shapes.
Number \| String unit	read/write	The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
Number \| String unit	read/write	The bottom line weight of the border of paragraph.
Number \| String unit	read/write	The distance to offset the bottom edge of the paragraph border.
ParagraphBorderBottomOriginEnum	read/write	The basis (descent or baseline) used to calculate the bottom origin of the paragraph border.
CornerOptions	read/write	The shape to apply to the bottom right corner of rectangular shapes.
Number \| String unit	read/write	The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
Swatch \| String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the paragraph stroke. Can return: Swatch or String.
Boolean	read/write	If true, then paragraph border is also displayed at the points where the paragraph splits across frames or columns.
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.
Boolean	read/write	If true, the paragraph border gap will overprint. Note: Valid only when border type is not solid.
Number 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)
Number \| String unit	read/write	The left line weight of the border of paragraph.
Number \| String unit	read/write	The distance to offset the left edge of the paragraph border.
Boolean	read/write	If true, the paragraph border is on.
Boolean	read/write	If true, the paragraph border will overprint.
Number \| String unit	read/write	The right line weight of the border of paragraph.
Number \| String unit	read/write	The distance to offset the right edge of the paragraph border.
EndCap	read/write	The end shape of an open path.
EndJoin	read/write	The corner join applied to the InsertionPoint.
Number 0–100	read/write	The tint (as a percentage) of the paragraph stroke. (Range: 0 to 100)
CornerOptions	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.
Number \| String unit	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
Number \| String unit	read/write	The top line weight of the border of paragraph.
Number \| String unit	read/write	The distance to offset the top edge of the paragraph border.
ParagraphBorderTopOriginEnum	read/write	The basis (cap height, ascent or baseline) used to calculate the top origin of the paragraph border.
CornerOptions	read/write	The shape to apply to the top right corner of rectangular shapes
Number \| String unit	read/write	The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
StrokeStyle \| String	read/write	The type of the border for the paragraph. Can return: StrokeStyle or String.
ParagraphBorderEnum	read/write	The basis (text width or column width) used to calculate the width of the paragraph border.
ParagraphDirectionOptions	read/write	Paragraph direction.
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.
ParagraphJustificationOptions	read/write	Paragraph justification.
Number	read/write	Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long
CornerOptions	read/write	The shape to apply to the bottom left corner of rectangular shapes.
Number \| String unit	read/write	The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
Number \| String unit	read/write	The distance to offset the bottom edge of the paragraph.
ParagraphShadingBottomOriginEnum	read/write	The basis (descent or baseline) used to calculate the bottom origin of the paragraph shading.
CornerOptions	read/write	The shape to apply to the bottom right corner of rectangular shapes.
Number \| String unit	read/write	The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
Boolean	read/write	If true, forces the shading of the paragraph to be clipped with respect to frame shape.
Swatch \| String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the paragraph shading. Can return: Swatch or String.
Number \| String unit	read/write	The distance to offset the left edge of the paragraph.
Boolean	read/write	If true, the paragraph shading is On.
Boolean	read/write	If true, the paragraph shading will overprint.
Number \| String unit	read/write	The distance to offset the right edge of the paragraph.
Boolean	read/write	If true, suppress printing of the shading of the paragraph.
Number 0–100	read/write	The tint (as a percentage) of the paragraph shading. (Range: 0 to 100)
CornerOptions	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.
Number \| String unit	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
Number \| String unit	read/write	The distance to offset the top edge of the paragraph.
ParagraphShadingTopOriginEnum	read/write	The basis (cap height, ascent or baseline) used to calculate the top origin of the paragraph shading.
CornerOptions	read/write	The shape to apply to the top right corner of rectangular shapes
Number \| String unit	read/write	The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
ParagraphShadingWidthEnum	read/write	The basis (text width or column width) used to calculate the width of the paragraph shading.
Paragraphs<Paragraph>	readonly	A collection of paragraphs.
Cell \| Change \| Character \| Endnote \| EndnoteTextFrame \| Footnote \| InsertionPoint \| Line \| Note \| Paragraph \| Story \| Text \| TextColumn \| TextFrame \| TextPath \| TextStyleRange \| Word \| XMLElement \| HiddenText \| XmlStory	readonly	The parent of the InsertionPoint (a XmlStory, TextPath, TextFrame, EndnoteTextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Story, Cell, XMLElement, Endnote, Footnote, Note, Change or HiddenText).
Story	readonly	The story that contains the text.
TextFrames[]<TextFrame> \| TextPaths[]<TextPath>	readonly	An array of the text frames that contain the text. Can return: Array of TextFrames or TextPaths.
Number \| String unit	read/write	The text size.
Polygons<Polygon>	readonly	A collection of polygons.
Position	read/write	The text position relative to the baseline.
PositionalForms	read/write	The OpenType positional form.
Preferences<Preference>	readonly	A collection of preferences objects.
Object	read/write	A property that allows setting of several properties at the same time.
HyphenationStyleEnum	read/write	The hyphenation style chosen for the provider.
RadioButtons<RadioButton>	readonly	A collection of radio buttons.
Rectangles<Rectangle>	readonly	A collection of rectangles.
Boolean	read/write	If true, disallows line breaks in numbers. If false, lines can break between digits in multi-digit numbers.
Number \| String unit	read/write	The width of the right indent.
Boolean	read/write	If true, rotates Roman characters in vertical text.
RubyAlignments	read/write	The ruby alignment.
Boolean	read/write	If true, auto aligns ruby.
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.
Boolean	read/write	If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to fit one em.
Number	read/write	The number of digits included in auto tcy (tate-chuu-yoko) in ruby.
Boolean	read/write	If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby.
Swatch \| String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby characters. Can return: Swatch or String.
Boolean	read/write	If true, ruby is on.
Font \| String	read/write	The font applied to ruby characters. Can return: Font or String.
Number	read/write	The size (in points) of ruby characters.
String \| NothingEnum	read/write	The font style of ruby characters. Can return: String or NothingEnum enumerator.
Boolean	read/write	If true, uses OpenType Pro fonts for ruby.
Boolean	read/write	If true, constrains ruby overhang to the specified amount. For information on specifying an amount, see ruby parent overhang amount.
AdornmentOverprint	read/write	The method of overprinting the ruby fill.
AdornmentOverprint	read/write	The method of overprinting the ruby stroke.
RubyOverhang	read/write	The amount by which ruby characters can overhang the parent text.
Number	read/write	The amount (as a percentage) to scale the parent text size to determine the ruby text size.
RubyParentSpacing	read/write	The ruby spacing relative to the parent text.
RubyKentenPosition	read/write	The position of ruby characters relative to the parent text.
String	read/write	The ruby string contents.
Swatch \| String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the stroke of ruby characters. Can return: Swatch or String.
Number	read/write	The stroke tint (as a percentage) of ruby characters.
Number 0–100	read/write	The tint (as a percentage) of the ruby fill color. (Range: 0 to 100)
RubyTypes	read/write	The ruby type.
Number	read/write	The stroke weight (in points) of ruby characters.
Number	read/write	The amount of horizontal space between ruby and parent characters.
Number	read/write	The horizontal size of ruby characters, specified as a percent of the original size.
Number	read/write	The amount of vertical space between ruby and parent characters.
Number	read/write	The vertical size of ruby characters, specified as a percent of the original size.
Boolean	read/write	If true, places a rule above the paragraph.
Swatch \| String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule above. Can return: Swatch or String.
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.
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.
Number 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.
Number \| String unit	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.
Number \| String unit	read/write	The line weight of the rule above.
Number \| String unit	read/write	The amount to offset the paragraph rule above from the baseline of the first line the paragraph.
Boolean	read/write	If true, the paragraph rule above will overprint.
Number \| String unit	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.
Number 0–100	read/write	The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100)
StrokeStyle \| String	read/write	The stroke type of the rule above the paragraph. Can return: StrokeStyle or String.
RuleWidth	read/write	The basis (text width or column width) used to calculate the width of the paragraph rule above.
Boolean	read/write	If true, applies a paragraph rule below.
Swatch \| String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule below. Can return: Swatch or String.
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.
Boolean	read/write	If true, the gap color of the rule below will overprint.
Number 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.
Number \| String unit	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.
Number \| String unit	read/write	The line weight of the rule below.
Number \| String unit	read/write	The amount to offset the the paragraph rule below from the baseline of the last line of the paragraph.
Boolean	read/write	If true, the rule below will overprint.
Number \| String unit	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.
Number 0–100	read/write	The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100)
StrokeStyle \| String	read/write	The stroke type of the rule below the paragraph. Can return: StrokeStyle or String.
RuleWidth	read/write	The basis (text width or column width) used to calculate the width of the paragraph rule below.
Unit \| Spacing	read/write	The space between paragraphs using same style. Can return: Unit or Spacing enumerator.
Boolean	read/write	If true, the line changes size when characters are scaled.
Boolean	read/write	If true, applies shatai rotation.
Boolean	read/write	If true, adjusts shatai tsume.
Number	read/write	The shatai lens angle (in degrees).
Number	read/write	The amount (as a percentage) of shatai obliquing to apply.
SignatureFields<SignatureField>	readonly	A collection of signature fields.
SingleWordJustification	read/write	The alignment to use for lines that contain a single word.
Number	read/write	The skew angle of the InsertionPoint.
Number \| String unit	read/write	The height of the paragraph space below.
Number \| String unit	read/write	The height of the paragraph space above.
Number \| String unit	read/write	The minimum space after a span or a split column
Number \| String unit	read/write	The minimum space before a span or a split column
SpanColumnTypeOptions	read/write	Whether a paragraph should be a single column, span columns or split columns
ShortInteger(1-40) \| SpanColumnCountOptions	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<SplineItem>	readonly	The spline items collection.
Number \| String unit	read/write	The inside gutter if the paragraph splits columns
Number \| String unit	read/write	The outside gutter if the paragraph splits columns
StartParagraph	read/write	The location at which to start the paragraph.
Swatch \| String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch or String.
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.
Boolean	read/write	If true, the gap color of the strikethrough stroke will overprint. Note: Valid when strike through type is not solid.
Number 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.
Number \| String unit	read/write	The amount by which to offset the strikethrough stroke from the text baseline.
Boolean	read/write	If true, the strikethrough stroke will overprint.
Number 0–100	read/write	The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100)
StrokeStyle \| String	read/write	The stroke type of the strikethrough stroke. Can return: StrokeStyle or String.
Number \| String unit	read/write	The stroke weight of the strikethrough stroke.
Boolean	read/write	If true, draws a strikethrough line through the text.
TextStrokeAlign	read/write	The stroke alignment applied to the text.
Swatch \| String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the InsertionPoint. Can also accept: String.
Number 0–100	read/write	The tint (as a percentage) of the stroke color of the InsertionPoint. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
Number \| String unit	read/write	The stroke weight applied to the characters of the text.
Boolean	readonly	If true, the applied style has been overridden with additional attributes.
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<TabStop>	readonly	A collection of tab stops.
Tables<Table>	readonly	A collection of tables.
Boolean	read/write	If true, makes the character horizontal in vertical text.
Number	read/write	The horizontal offset for horizontal characters in vertical text.
Number	read/write	The vertical offset for horizontal characters in vertical text.
TextBoxes<TextBox>	readonly	A collection of text boxes.
TextColumns<TextColumn>	readonly	A collection of text columns.
TextFrames<TextFrame>	readonly	A collection of text frames.
TextStyleRanges<TextStyleRange>	readonly	A collection of text style ranges.
TextVariableInstances<TextVariableInstance>	readonly	A collection of text variable instances.
Texts<Text>	readonly	A collection of text objects.
Number	read/write	The amount by which to loosen or tighten a block of text, specified in thousands of an em.
Number	read/write	The amount of space after each character.
Boolean	read/write	If true, ideographic spaces will not wrap to the next line like text characters.
Number	read/write	The amount of horizontal character compression.
Boolean	read/write	If true, underlines the text.
Swatch \| String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch or String.
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.
Boolean	read/write	If true, the gap color of the underline stroke will overprint.
Number 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.
Number \| String unit	read/write	The amount by which to offset the underline from the text baseline.
Boolean	read/write	If true, the underline stroke color will overprint.
Number 0–100	read/write	The underline stroke tint (as a percentage). (Range: 0 to 100)
StrokeStyle \| String	read/write	The stroke type of the underline stroke. Can return: StrokeStyle or String.
Number \| String unit	read/write	The stroke weight of the underline stroke.
Number	read/write	The vertical scaling applied to the InsertionPoint.
Boolean	read/write	If true, turns on warichu.
WarichuAlignment	read/write	The warichu alignment.
Number	read/write	The minimum number of characters allowed after a line break.
Number	read/write	The minimum number of characters allowed before a line break.
Number	read/write	The gap between lines of warichu characters.
Number	read/write	The number of lines of warichu within a single normal line.
Number	read/write	The amount (as a percentage) to scale parent text size to determine warichu size.
Words<Word>	readonly	A collection of words.
Number	read/write	The x (horizontal) offset for diacritic adjustment.
Number	read/write	The y (vertical) offset for diacritic adjustment.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.

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

captures? Boolean This parameter is obsolete.

→ void

Apply a character style.

using CharacterStyle The character style to apply.

→ void

Apply one or more conditions.

using Condition[] The condition(s) to apply

removeExisting? Boolean If true, remove existing conditions.

→ void

Apply a paragraph style.

using ParagraphStyle The paragraph style to apply.

clearingOverrides? Boolean If true, clear any text attributes before applying the style.

→ BackgroundTask

asynchronously exports the object(s) to a file.

format ExportFormat | 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.

using? PDFExportPreset The export style.

versionComments? String The comment for this version.

forceSave? Boolean If true, forcibly saves a version.

→ void

Tag the object or the parent story using default tags defined in XML preference.

→ Text[]

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

reverseOrder? Boolean If true, returns the results in reverse order.

→ Text[]

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

reverseOrder? Boolean If true, returns the results in reverse order.

→ Text[]

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

reverseOrder? Boolean If true, returns the results in reverse order.

→ Text[]

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

reverseOrder? Boolean If true, returns the results in reverse order.

→ void

Sets the case of the text.

using ChangecaseMode The text case option.

→ void

Clears the specified types of override.

overridesToClear? OverrideType The types of override to clear.

→ void

Convert bullets and numbering to text.

→ Note

Converts the text to a note.

→ Table

Converts the text to a table.

columnSeparator? String The character that starts a new column in the new table.

rowSeparator? String The character starts a new row in the new table.

numberOfColumns? Number The number of columns in the table. Note: Valid only when the column and row separator characters are the same.

→ void

Create Email QR Code on the page item or document

emailAddress? String QR code Email Address

subject? String QR code Email Subject

body? String QR code Email Body Message

qrCodeSwatch? Swatch | String Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String.

withProperties? String[] Initial values for properties of the new InsertionPoint. Above parameters can also be passed as properties

→ Endnote

Creates a new endnote. Internally it creates the endnote reference and its endnote text range.

→ void

Create Hyperlink QR Code on the page item or document

urlLink? String QR code Hyperlink URL

qrCodeSwatch? Swatch | String Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String.

withProperties? String[] Initial values for properties of the new InsertionPoint. Above parameters can also be passed as properties

→ PageItem[]

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.

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

→ void

Create Plain Text QR Code on the page item

plainText? String QR code Plain Text

qrCodeSwatch? Swatch | String Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String.

withProperties? String[] Initial values for properties of the new InsertionPoint. Above parameters can also be passed as properties

→ Boolean

Create thumbnail for selected text using the applied style and overrides with the given properties.

previewText String Text to use as sample

pointSize Number Text font size (in points)

space ColorSpace Color space RGB, CMYK or LAB

colorValue Number[] Color values

to File The path to the export file.

charOrParaStyle StyleType The applied style type to use.

→ Link

Experimental: Place the text fragment fetched from url onto insertion point and create a link

linkResourceURI String Resource URI for the link.

name? String The tag name for the key.

→ void

Create Text Msg QR Code on the page item or document

cellNumber? String QR code Text Phone Number

textMessage? String QR code Text Message

qrCodeSwatch? Swatch | String Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String.

withProperties? String[] Initial values for properties of the new InsertionPoint. Above parameters can also be passed as properties

→ Boolean

Create thumbnail for selected text with the given properties.

previewText String Text to use as sample

pointSize Number Text font size (in points)

space ColorSpace Color space RGB, CMYK or LAB

colorValue Number[] Color values

to File The path to the export file.

→ void

Create Business Card QR Code on the page item or load on document's placegun

firstName? String QR code Business Card First Name

lastName? String QR code Business Card Last Name

jobTitle? String QR code Business Card Title

cellPhone? String QR code Business Card Cell Phone Number

phone? String QR code Business Card Phone Number

email? String QR code Business Card Email Address

organisation? String QR code Business Card Organisation

streetAddress? String QR code Business Card Street Address

city? String QR code Business Card City

adrState? String QR code Business Card State

country? String QR code Business Card Country

postalCode? String QR code Business Card Postal Code

website? String QR code Business Card URL

qrCodeSwatch? Swatch | String Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String.

withProperties? String[] Initial values for properties of the new InsertionPoint. Above parameters can also be passed as properties

→ Text

Duplicates the text in the specified location.

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

→ void

Exports the object(s) to a file.

to File The path to the export file.

showingOptions? Boolean If true, displays the export options dialog.

using? PDFExportPreset The export style.

versionComments? String The comment for this version.

forceSave? Boolean If true, forcibly saves a version.

→ Text[]

Finds glyphs that match the find what value.

reverseOrder? Boolean If true, returns the results in reverse order.

→ Text[]

Finds text that matches the find what value.

reverseOrder? Boolean If true, returns the results in reverse order.

→ HyperlinkTextSource[]

Finds hyperlink sources that intersecting with specified text range.

sortOrder? RangeSortOrder The sort order of found ranges.

→ Text[]

Finds text that matches the find what value.

reverseOrder? Boolean If true, returns the results in reverse order.

→ Text[]

Finds text that matches the find character type value.

reverseOrder? Boolean If true, returns the results in reverse order.

→ InsertionPoint[]

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

→ Boolean

If true, Nth design axis of variable font is hidden.

nthAxisIndex Number Index of design axis.

→ void

Associates the page item with the specified XML element while preserving existing content.

using XMLElement The XML element.

→ Text

Moves the text to the specified location.

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

→ Varies[]

Places the file.

fileName File The file to place

showingOptions? Boolean Whether to display the import options dialog

withProperties? Object Initial values for properties of the placed object(s)

→ void

Recomposes the text in the InsertionPoint.

→ void

Deletes the InsertionPoint.

→ Boolean

Removes the event listener.

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.

→ void

Selects the object.

existingSelection? SelectionOptions The selection status of the InsertionPoint in relation to previously selected objects.

→ void

Set Nth design axis of a variable font.

nthAxisIndex Number Index of design axis.

nthAxisValue Number Value of nth design axis.

→ void

Jump to the text range.

→ Boolean

If true, text has local overrides

charOrParaStyle StyleType Style type to look at.

charStyleAsOverride? Boolean Whether to consider character styles as overrides or not

→ String

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

→ String

Retrieves the object specifier.

Parameter of 12

Method parameters that accept a InsertionPoint.

AnchoredObjectSetting.insertAnchoredObject(storyOffset)DataMergeTextPlaceholders.add(storyOffset)Endnote.insertTextInEndnote(storyOffset)Footnotes.add(reference)InsertionPoints.itemByRange(from)InsertionPoints.nextItem(obj)InsertionPoints.previousItem(obj)Notes.add(reference)Tables.add(reference)TextVariableInstances.add(reference)XMLComments.add(storyOffset)XMLInstructions.add(storyOffset)

Return 11

Methods that return a InsertionPoint.

InsertionPoint.getElements()InsertionPoints.[]()InsertionPoints.anyItem()InsertionPoints.everyItem()InsertionPoints.firstItem()InsertionPoints.item()InsertionPoints.itemByRange()InsertionPoints.lastItem()InsertionPoints.middleItem()InsertionPoints.nextItem()InsertionPoints.previousItem()

InsertionPoint

Properties

Methods

Object of 37

Parameter of 12

Return 11