textdocument

TextDocument 对象

new TextDocument(docText)

app.project.item(index).layer(index).property("Source Text").value

描述

TextDocument 对象存储了 TextLayer 的 Source Text 属性的值。通过构造函数创建它，并传递要封装的字符串。

示例

以下代码设置了一些源文本的值，并显示一个弹窗展示新值。

var myTextDocument = new TextDocument("HappyCake");
myTextLayer.property("Source Text").setValue(myTextDocument);
alert(myTextLayer.property("Source Text").value);

以下代码为文本设置关键帧值，以显示随时间变化的不同单词。

var textProp = myTextLayer.property("Source Text");
textProp.setValueAtTime(0, newTextDocument("Happy"));
textProp.setValueAtTime(.33, newTextDocument("cake"));
textProp.setValueAtTime(.66, newTextDocument("is"));
textProp.setValueAtTime(1, newTextDocument("yummy!"));

以下代码为一些文本设置各种字符和段落样式。

var textProp = myTextLayer.property("Source Text");
var textDocument = textProp.value;
myString = "Happy holidays!";
textDocument.resetCharStyle();
textDocument.fontSize = 60;
textDocument.fillColor = [1, 0, 0];
textDocument.strokeColor = [0, 1, 0];
textDocument.strokeWidth = 2;
textDocument.font = "Times New Roman PSMT";
textDocument.strokeOverFill = true;
textDocument.applyStroke = true;
textDocument.applyFill = true;
textDocument.text = myString;
textDocument.justification = ParagraphJustification.CENTER_JUSTIFY;
textDocument.tracking = 50;
textProp.setValue(textDocument);

属性

TextDocument.allCaps

textDocument.allCaps

描述

如果文本图层启用了“全部大写”，则为 true；否则为 false。要设置此值，请使用 After Effects 24.0 中添加的 fontCapsOption。

此值仅反映文本图层中的第一个字符。

类型

布尔值；只读。

TextDocument.applyFill

textDocument.applyFill

描述

当为 true 时，文本图层显示填充。访问 fillColor 属性以获取实际颜色。当为 false 时，仅显示描边。

类型

布尔值；可读写。

TextDocument.applyStroke

textDocument.applyStroke

描述

当为 true 时，文本图层显示描边。访问 strokeColor 属性以获取实际颜色，访问 strokeWidth 以获取其粗细。当为 false 时，仅显示填充。

类型

布尔值；可读写。

TextDocument.autoHyphenate

textDocument.autoHyphenate

描述

文本图层的自动连字符段落选项。

如果此属性具有混合值，则读取为 undefined。

此值反映文本图层中的所有段落。

如果更改此值，它将为文本图层中的所有段落设置指定的设置。

类型

布尔值；可读写。

TextDocument.autoLeading

textDocument.autoLeading

描述

文本图层的自动行距字符选项。

如果此属性具有混合值，则读取为 undefined。

此值反映文本图层中的所有段落。

如果更改此值，它将为文本图层中的所有段落设置指定的设置。

类型

布尔值；可读写。

TextDocument.autoKernType

textDocument.autoKernType

描述

文本图层的自动字距类型选项。

此值仅反映文本图层中的第一个字符。

如果更改此值，它将为文本图层中的所有字符设置指定的设置。

类型

AutoKernType 枚举值；可读写。可能的值包括：

AutoKernType.NO_AUTO_KERN
AutoKernType.METRIC_KERN
AutoKernType.OPTICAL_KERN

TextDocument.baselineDirection

textDocument.baselineDirection

描述

文本图层的基线方向选项。这对于垂直文本中的日语文本尤为重要。“BASELINE_VERTICAL_CROSS_STREAM” 也称为 Tate-Chu-Yoko。

此值仅反映文本图层中的第一个字符。

如果更改此值，它将为文本图层中的所有字符设置指定的设置。

类型

BaselineDirection 枚举值；可读写。可能的值包括：

BaselineDirection.BASELINE_WITH_STREAM
BaselineDirection.BASELINE_VERTICAL_ROTATED
BaselineDirection.BASELINE_VERTICAL_CROSS_STREAM

TextDocument.baselineLocs

textDocument.baselineLocs

描述

文本图层的基线 (x,y) 位置。段落文本框中的换行被视为多行。

类型

浮点值数组，形式如下：

[
  line0.start_x,
  line0.start_y,
  line0.end_x,
  line0.end_y,
  line1.start_x,
  line1.start_y,
  line1.end_x,
  line1.end_y,
  ...
  lineN-1.start_x,
  lineN-1.start_y,
  lineN-1.end_x,
  lineN-1.end_y
]

TextDocument.baselineShift

textDocument.baselineShift

描述

此文本图层的基线偏移量（以像素为单位）。

此值仅反映文本图层中的第一个字符。

如果更改此值，它将为文本图层中的所有字符设置指定的设置。

类型

浮点值；可读写。

TextDocument.boxAutoFitPolicy

textDocument.boxAutoFitPolicy

描述

启用自动调整框高度以适应框中的文本内容。框仅向下增长。

默认为 BoxAutoFitPolicy.NONE。

如果 TextDocument.boxVerticalAlignment 不是 BoxVerticalAlignment.TOP，则此功能将被禁用。

类型

BoxAutoFitPolicy 枚举值；可读写。可能的值包括：

BoxAutoFitPolicy.NONE
BoxAutoFitPolicy.HEIGHT_CURSOR
BoxAutoFitPolicy.HEIGHT_PRECISE_BOUNDS
BoxAutoFitPolicy.HEIGHT_BASELINE

TextDocument.boxFirstBaselineAlignment

textDocument.boxFirstBaselineAlignment

描述

控制第一行文本相对于框顶部的对齐方式。

如果 TextDocument.boxFirstBaselineAlignmentMinimum 不为零，则此功能将被禁用。

默认为 BoxFirstBaselineAlignment.ASCENT。

类型

BoxFirstBaselineAlignment 枚举值；可读写。可能的值包括：

BoxFirstBaselineAlignment.ASCENT
BoxFirstBaselineAlignment.CAP_HEIGHT
BoxFirstBaselineAlignment.EM_BOX
BoxFirstBaselineAlignment.LEADING
BoxFirstBaselineAlignment.LEGACY_METRIC
BoxFirstBaselineAlignment.MINIMUM_VALUE_ASIAN
BoxFirstBaselineAlignment.MINIMUM_VALUE_ROMAN
BoxFirstBaselineAlignment.TYPO_ASCENT
BoxFirstBaselineAlignment.X_HEIGHT

TextDocument.boxFirstBaselineAlignmentMinimum

textDocument.boxFirstBaselineAlignmentMinimum

描述

手动控制第一行文本相对于框顶部的位置。

此处设置的非零值将覆盖 TextDocument.boxFirstBaselineAlignment 值的效果。

默认为零。

类型

浮点值；可读写。

TextDocument.boxInsetSpacing

textDocument.boxInsetSpacing

描述

控制框边界与可组合文本框开始位置之间的内部间距。相同的值应用于框的所有四个边。

默认为零。

类型

浮点值；可读写。

TextDocument.boxOverflow

textDocument.boxOverflow

描述

如果文本的某些部分未组合到框中，则返回 true。

类型

布尔值；只读。

TextDocument.boxText

textDocument.boxText

描述

如果文本图层是段落（有界）文本图层，则为 true；否则为 false。

类型

布尔值；只读。

TextDocument.boxTextPos

textDocument.boxTextPos

描述

段落（框）文本图层的锚点的图层坐标，作为像素尺寸的 [宽度, 高度] 数组。

如果 boxText 对文本图层不返回 true，则抛出异常。

类型

([X,Y]) 位置坐标数组；可读写。

示例

// 对于段落文本图层，返回图层锚点的 [x, y] 位置（图层坐标）。
// 例如，使用默认字符面板设置时，大约为 [0, -25]。
var boxTextLayerPos = myTextLayer.sourceText.value.boxTextPos;

TextDocument.boxTextSize

textDocument.boxTextSize

描述

段落（框）文本图层的大小，作为像素尺寸的 [宽度, 高度] 数组。

如果 boxText 对文本图层不返回 true，则抛出异常。

类型

两个整数的数组（最小值为 1）；可读写。

TextDocument.boxVerticalAlignment

textDocument.boxVerticalAlignment

描述

启用框中组合文本的自动垂直对齐。

默认为 BoxVerticalAlignment.TOP

类型

BoxVerticalAlignment 枚举值；可读写。可能的值包括：

BoxVerticalAlignment.TOP
BoxVerticalAlignment.CENTER
BoxVerticalAlignment.BOTTOM
BoxVerticalAlignment.JUSTIFY

TextDocument.composedLineCount

textDocument.composedLineCount

描述

返回文本图层中组合行的数量，如果所有文本都溢出，则可能为零。

TextDocument 对象实例从组合状态初始化，后续对 TextDocument 对象实例的更改不会导致重新组合。

即使从 TextDocument 对象实例中删除所有文本，此处返回的值仍保持不变。

类型

整数；只读。

TextDocument.composerEngine

textDocument.composerEngine

描述

文本图层的段落组合引擎选项。默认情况下，新的文本图层将使用 ComposerEngine.UNIVERSAL_TYPE_ENGINE；其他枚举值仅在 After Effects 22.1.1 中 Universal Type Engine（以前称为南亚和中东引擎）成为默认引擎之前创建的项目中遇到。

如果此属性具有混合值，则读取为 undefined。

此属性可读写，但如果写入除 ComposerEngine.UNIVERSAL_TYPE_ENGINE 之外的任何枚举值，则会抛出异常。

实际上，您可以将旧文档从 ComposerEngine.LATIN_CJK_ENGINE 更改为 ComposerEngine.UNIVERSAL_TYPE_ENGINE，但不能反向更改。

此值反映文本图层中的所有段落。

如果更改此值，它将为文本图层中的所有段落设置指定的设置。

类型

ComposerEngine 枚举值；可读写。可能的值包括：

ComposerEngine.LATIN_CJK_ENGINE
ComposerEngine.UNIVERSAL_TYPE_ENGINE

TextDocument.digitSet

textDocument.digitSet

描述

文本图层的数字集选项。

此值仅反映文本图层中的第一个字符。

如果更改此值，它将为文本图层中的所有字符设置指定的设置。

类型

DigitSet 枚举值；可读写。可能的值包括：

DigitSet.DEFAULT_DIGITS
DigitSet.ARABIC_DIGITS
DigitSet.HINDI_DIGITS
DigitSet.FARSI_DIGITS
DigitSet.ARABIC_DIGITS_RTL

TextDocument.direction

textDocument.direction

描述

文本图层的段落方向选项。

如果此属性