このトピックでは、テキストドキュメントの段落オブジェクトに関連する API 操作について説明します。
段落
ActiveDocument.Range(Start, End).Paragraphs
範囲内のすべての段落を返します。
JS-SDK V1.1.14 以降でのみ、この機能がサポートされています。
この機能は PC にのみ適用されます。
構文
expression.ActiveDocument.Range(Start, End).Paragraphsexpression: アプリケーション オブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // 範囲内のすべての段落を返します。 const paragraphs = app.ActiveDocument.Range(0, 100).Paragraphs; }
メソッド
ActiveDocument.Range(Start, End).Paragraphs.Item()
段落オブジェクトを返します。
JS-SDK V1.1.14 以降でのみ、この機能がサポートされています。
構文
expression.ActiveDocument.Range(Start, End).Paragraphs.Item(Index)expression: アプリケーション オブジェクト。
パラメータ
パラメータ
型
必須
説明
Index
数値
はい
段落のインデックス。
例
async function example() { await instance.ready(); const app = instance.Application; // 範囲内のすべての段落を返します。 const paragraphs = app.ActiveDocument.Range(0, 100).Paragraphs; // 最初の段落オブジェクトを返します。 const paragraph = paragraphs.Item(1); }
プロパティ
ActiveDocument.Range(Start, End).Paragraphs.Count
範囲内の段落の総数を返します。
JS-SDK V1.1.14 以降でのみ、この機能がサポートされています。
構文
expression.ActiveDocument.Range(Start, End).Paragraphs.Countexpression: アプリケーション オブジェクト。
戻り値
段落の数を表す
数値。例
async function example() { await instance.ready(); const app = instance.Application; // 範囲内の段落の総数を返します。 const count = await app.ActiveDocument.Range(0, 100).Paragraphs.Count; console.log(count); }
ActiveDocument.Range(Start, End).Paragraphs.Item(Index).Range
段落オブジェクトに含まれるドキュメントの一部を返します。
JS-SDK V1.1.14 以降でのみ、この機能がサポートされています。
構文
expression.ActiveDocument.Range(Start, End).Paragraphs.Item(Index).Rangeexpression: アプリケーション オブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // 範囲内のすべての段落を返します。 const paragraphs = app.ActiveDocument.Range(0, 100).Paragraphs; // 最初の段落オブジェクトを返します。 const paragraph = paragraphs.Item(1); // この段落に含まれるドキュメントの一部を返します。 const range = await paragraph.Range; }
ParagraphFormat
ActiveDocument.Range(Start, End).ParagraphFormat
指定された範囲の段落設定を返します。
JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。
構文
expression.ActiveDocument.Range(Start, End).ParagraphFormatまたは
expression.ActiveDocument.ActiveWindow.Selection.ParagraphFormatexpression: アプリケーション オブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // 指定された範囲の段落設定を返します。 const paragraphFormat = await app.ActiveDocument.Range(0, 20).ParagraphFormat; }
メソッド
ActiveDocument.Range(Start, End).ParagraphFormat.SetFixedLineSpacing(Value, Unit)
固定の行間隔を設定します。
構文
expression.ActiveDocument.Range(Start, End).ParagraphFormat.SetFixedLineSpacingまたは
expression.ActiveDocument.ActiveWindow.Selection.ParagraphFormatexpression: アプリケーション オブジェクト。
パラメータ
パラメータ
型
必須
説明
Value
数値
はい
行間隔。有効値: ポイントの場合は 0 ~ 1000、センチメートルの場合は 0 ~ 55、ミリメートルの場合は 0 ~ 550、インチの場合は 0 ~ 22。
Unit
列挙型
はい
行間隔の単位。
例
//@file=base.docx async function example() { await instance.ready(); const app = instance.Application; // ParagraphFormat オブジェクトを返します。 const paragraphFormat = await app.ActiveDocument.Range(0, 20).ParagraphFormat; // 固定行間隔を 18 ポイントに設定します。 await paragraphFormat.SetFixedLineSpacing(18, 0); }
ActiveDocument.Range(Start, End).ParagraphFormat.setParagraphAlignment
指定された段落の配置を設定します。
JS-SDK V1.1.19 以降でのみ、この機能がサポートされています。
構文
expression.ActiveDocument.Range(Start, End).ParagraphFormat.setParagraphAlignmentexpression: アプリケーション オブジェクト。
パラメータ
パラメータ
型
必須
説明
Value
列挙型
はい
段落の配置。
例
async function example() { await instance.ready(); const app = instance.Application; // ParagraphFormat オブジェクトを返します。 const paragraphFormat = await app.ActiveDocument.Range(0, 20).ParagraphFormat; // 中央揃えを適用します。 paragraphFormat.setParagraphAlignment(app.Enum.WdAlignmentMode.wdCenter); }
プロパティ
ActiveDocument.Range(Start, End).ParagraphFormat.CharacterUnitFirstLineIndent
段落の字下げを設定します。
JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。
構文
expression.ActiveDocument.Range(Start, End).ParagraphFormat.CharacterUnitFirstLineIndentまたは
expression.ActiveDocument.ActiveWindow.Selection.ParagraphFormatexpression: アプリケーション オブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // 指定された範囲の段落設定を返します。 const paragraphFormat = await app.ActiveDocument.Range(0, 20).ParagraphFormat; // 2 単位の字下げを設定します。 paragraphFormat.CharacterUnitFirstLineIndent = 2; }
ActiveDocument.Range(Start, End).ParagraphFormat.LineSpacingRule
指定された段落フォーマットの行間隔を設定します。 詳細については、「WdLineSpacing」をご参照ください。
JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。
構文
expression.ActiveDocument.Range(Start, End).ParagraphFormat.LineSpacingRuleまたは
expression.ActiveDocument.ActiveWindow.Selection.ParagraphFormatexpression: アプリケーション オブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // 指定された範囲の段落設定を返します。 const paragraphFormat = await app.ActiveDocument.Range(0, 20).ParagraphFormat; // 1.5 行間隔を設定します。 paragraphFormat.LineSpacingRule = 1; }