選択範囲 - Intelligent Media Management - Alibaba Cloud ドキュメントセンター

このトピックでは、テキストドキュメントの Selection オブジェクトに関連する API 操作について説明します。

Selection

ActiveDocument.ActiveWindow.Selection

ウィンドウまたはペインで現在の選択範囲を取得します。選択範囲は、ドキュメント内の選択された（またはハイライトされた）領域を表すか、ドキュメント内で何も選択されていない場合は挿入ポイントを表します。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。
ドキュメントウィンドウペインごとに 1 つの Selection オブジェクトしか存在できず、アプリケーション全体でアクティブにできる Selection オブジェクトは 1 つだけです。

構文
expression.ActiveDocument.ActiveWindow.Selection
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // Selection オブジェクトを取得します。
  const selection = await app.ActiveDocument.ActiveWindow.Selection;
}

メソッド

ActiveDocument.ActiveWindow.Selection.Copy()

Copy() メソッドを使用して、選択範囲をクリップボードにコピーできます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveDocument.ActiveWindow.Selection.Copy()
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;

  // Selection オブジェクトを取得します。
  await app.ActiveDocument.Range.SetRange(1, 10);

  // 選択範囲をクリップボードにコピーします。
  await app.ActiveDocument.ActiveWindow.Selection.Copy();

  // 選択範囲がクリップボードにコピーされ、Ctrl+V を使用して貼り付けることができます。
}

ActiveDocument.ActiveWindow.Selection.Delete()

Delete() メソッドを使用して、選択範囲を削除できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveDocument.ActiveWindow.Selection.Delete({ Unit, Count })
expression: ドキュメントタイプのアプリケーションオブジェクト。

パラメーター

プロパティ	タイプ	必須	説明
Unit	Enum	はい	使用する単位を指定します。文字と行のみがサポートされています。詳細については、「WdUnits」をご参照ください。
Count	Number	いいえ	削除する単位の数。有効値: 1。デフォルト値: 1。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 選択範囲を削除します。
  app.ActiveDocument.ActiveWindow.Selection.Delete(1);
}

ActiveDocument.ActiveWindow.Selection.GoTo()

GoTo() メソッドを使用して、指定されたページやブックマークなどの位置にジャンプできます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。
テキストドキュメントは動的レイアウトです。大きなドキュメントでジャンプを実行するには、長い時間がかかります。スクリプトに loading を追加することをお勧めします。

構文
expression.ActiveDocument.ActiveWindow.Selection.GoTo(What, Which, Count, Name)
expression: ドキュメントタイプのアプリケーションオブジェクト。

パラメーター

プロパティ	タイプ	必須	説明
What	Number	いいえ	範囲または選択範囲の移動先のアイテムのタイプ。詳細については、「WdGoToItem」をご参照ください。
Which	Number	いいえ	範囲または選択範囲の移動先のアイテム。詳細については、「WdGoToDirection」をご参照ください。
Count	Number	いいえ	ドキュメント内のアイテムの数。デフォルト値は 1 です。正の整数のみが有効です。
Name	String	いいえ	ブックマークの名前。 What パラメーターに `wdGoToBookmark` を指定する場合は、ブックマークの名前を指定できます。説明指定したブックマーク名と Count の値が一致しない場合、ジャンプを実行できません。

戻り値
ジャンプの実行後に、ページまたはブックマークを返します。

例

指定されたページにジャンプする

async function example() {
  await instance.ready();

  const app = instance.Application;

  // 指定されたページにジャンプします。
  const page = await app.ActiveDocument.ActiveWindow.Selection.GoTo(
    app.Enum.WdGoToItem.wdGoToPage,
    app.Enum.WdGoToDirection.wdGoToAbsolute,
    3,
  );
}

指定されたブックマークにジャンプする

async function example() {
  await instance.ready();

  const app = instance.Application;

  // ブックマークを追加します。
  await app.ActiveDocument.ActiveWindow.Bookmarks.Add({
    Name: 'Aliyun',
    Range: {
      Start: 1,
      End: 10,
    },
  });

  // 指定されたブックマークにジャンプします。
  // 方法 1

  await app.ActiveDocument.ActiveWindow.Selection.GoTo(
    app.Enum.WdGoToItem.wdGoToBookmark, 
    app.Enum.WdGoToDirection.wdGoToAbsolute,
    undefined, 
    'Aliyun', 
  );

  // 方法 2
  await app.ActiveDocument.ActiveWindow.Selection.GoTo({
    What: app.Enum.WdGoToItem.wdGoToBookmark,
    Which: app.Enum.WdGoToDirection.wdGoToAbsolute,
    Name: 'Aliyun', 
  });
}

ActiveDocument.ActiveWindow.Selection.Information()

Information() メソッドを使用して、選択範囲に関する情報を取得できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。
テキストドキュメントは動的レイアウトです。正確なページ数は、ドキュメントの一番下までスクロールすることによってのみ取得できます。

構文
expression.ActiveDocument.ActiveWindow.Selection.Information(WdInformation)
expression: ドキュメントタイプのアプリケーションオブジェクト。

パラメーター

プロパティ	タイプ	必須	説明
WdInformation	Enum	はい	返却する選択範囲または範囲に関する情報のタイプを指定します。詳細については、「WdInformation」をご参照ください。

戻り値
現在のページ番号を示す数値を返します。

例

async function example() {
  await instance.ready();

  const app = instance.Application;

  // 現在のページ番号を取得します。
  const currentPage = await app.ActiveDocument.ActiveWindow.Selection.Information(app.Enum.WdInformation.wdActiveEndPageNumber);
  console.log(currentPage );
}

ActiveDocument.ActiveWindow.Selection.InsertAfter()

InsertAfter() メソッドを使用して、選択範囲の後にテキストを挿入できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveDocument.ActiveWindow.Selection.InsertAfter({ Text })
expression: ドキュメントタイプのアプリケーションオブジェクト。
パラメーター
プロパティ
タイプ
必須
説明
Text
String
はい
挿入するテキスト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 選択範囲の後にテキストを挿入します。
  await app.ActiveDocument.ActiveWindow.Selection.InsertAfter({
    Text: 'Text',
  });
}

ActiveDocument.ActiveWindow.Selection.InsertBreak()

InsertBreak() メソッドを使用して、選択範囲の後に改行を挿入できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveDocument.ActiveWindow.Selection.InsertBreak({ Type })
expression: ドキュメントタイプのアプリケーションオブジェクト。
パラメーター
プロパティ
タイプ
必須
説明
Type
Enum
いいえ
挿入する改行のタイプ。デフォルト値: wdPageBreak。詳細については、「WdBreakType」をご参照ください。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 選択範囲の後に改行を挿入します。
  await app.ActiveDocument.ActiveWindow.Selection.InsertBreak();
}

ActiveDocument.ActiveWindow.Selection.InsertParagraph()

InsertParagraph() メソッドを使用して、選択範囲を新しい段落に置き換えることができます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveDocument.ActiveWindow.Selection.InsertParagraph()
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 選択範囲を新しい段落に置き換えます。
  await app.ActiveDocument.ActiveWindow.Selection.InsertParagraph();
}

ActiveDocument.ActiveWindow.Selection.MoveDown()

MoveDown() メソッドを使用して、選択範囲を下に移動できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveDocument.ActiveWindow.Selection.MoveDown({ Unit, Count, Extend })
expression: ドキュメントタイプのアプリケーションオブジェクト。

パラメーター

プロパティ	タイプ	必須	説明
Unit	Enum	いいえ	選択範囲を移動する単位。デフォルト値: `wdLine`。詳細については、「WdUnits」をご参照ください。説明値が `wdWindow` の場合、 Count の値に関係なく、選択範囲を 1 単位だけ移動できます。それ以外の場合は、 Count を指定することで、選択範囲を移動する単位の数を指定できます。
Count	Number	いいえ	選択範囲を移動する単位の数。デフォルト値: 1。
Extend	Enum	いいえ	選択範囲の移動方法を指定します。デフォルト値: `wdMove`。詳細については、「WdMovementType」をご参照ください。説明値が `wdMove` の場合、選択範囲は終点に折りたたまれて下に移動します。値が `wdExtend` の場合、選択範囲は下に拡張されます。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 選択範囲を下に移動します。
  await app.ActiveDocument.ActiveWindow.Selection.MoveDown();
}

ActiveDocument.ActiveWindow.Selection.MoveLeft()

MoveLeft() メソッドを使用して、選択範囲を左に移動できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveDocument.ActiveWindow.Selection.MoveLeft({ Unit, Count, Extend })
expression: ドキュメントタイプのアプリケーションオブジェクト。

パラメーター

プロパティ	タイプ	必須	説明
Unit	Enum	いいえ	選択範囲を移動する単位。デフォルト値: `wdCharacter`。詳細については、「WdUnits」をご参照ください。
Count	Number	いいえ	選択範囲を移動する単位の数。デフォルト値: 1。
Extend	Enum	いいえ	選択範囲の移動方法を指定します。デフォルト値: `wdMove`。詳細については、「WdMovementType」をご参照ください。説明値が `wdMove` の場合、選択範囲は終点に折りたたまれて左に移動します。値が `wdExtend` の場合、選択範囲は左に拡張されます。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 選択範囲を左に移動します。
  await app.ActiveDocument.ActiveWindow.Selection.MoveLeft();
}

ActiveDocument.ActiveWindow.Selection.MoveRight()

MoveRight() メソッドを使用して、選択範囲を右に移動できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveDocument.ActiveWindow.Selection.MoveRight({ Unit, Count, Extend })
expression: ドキュメントタイプのアプリケーションオブジェクト。

パラメーター

プロパティ	タイプ	必須	説明
Unit	Enum	いいえ	選択範囲を移動する単位。デフォルト値: `wdCharacter`。詳細については、「WdUnits」をご参照ください。
Count	Number	いいえ	選択範囲を移動する単位の数。デフォルト値: 1。
Extend	Enum	いいえ	選択範囲の移動方法を指定します。デフォルト値: `wdMove`。詳細については、「WdMovementType」をご参照ください。説明値が `wdMove` の場合、選択範囲は終点に折りたたまれて右に移動します。値が `wdExtend` の場合、選択範囲は右に拡張されます。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 選択範囲を右に移動します。
  await app.ActiveDocument.ActiveWindow.Selection.MoveRight();
}

ActiveDocument.ActiveWindow.Selection.MoveUp()

MoveUp() メソッドを使用して、選択範囲を上に移動できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveDocument.ActiveWindow.Selection.MoveUp({ Unit, Count, Extend })
expression: ドキュメントタイプのアプリケーションオブジェクト。

パラメーター

プロパティ	タイプ	必須	説明
Unit	Enum	いいえ	選択範囲を移動する単位。デフォルト値: `wdLine`。詳細については、「WdUnits」をご参照ください。説明値が `wdWindow` の場合、 Count の値に関係なく、選択範囲を 1 単位だけ移動できます。それ以外の場合は、 Count を指定することで、選択範囲を移動する単位の数を指定できます。
Count	Number	いいえ	選択範囲を移動する単位の数。デフォルト値: 1。
Extend	Enum	いいえ	選択範囲の移動方法を指定します。デフォルト値: `wdMove`。詳細については、「WdMovementType」をご参照ください。説明値が `wdMove` の場合、選択範囲は終点に折りたたまれて上に移動します。値が `wdExtend` の場合、選択範囲は上に拡張されます。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 選択範囲を上に移動します。
  await app.ActiveDocument.ActiveWindow.Selection.MoveUp();
}

ActiveDocument.ActiveWindow.Selection.TypeBackspace()

TypeBackspace() メソッドを使用して、選択範囲の前にある文字を削除できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveDocument.ActiveWindow.Selection.TypeBackspace()
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 選択範囲を下に移動します。
  await app.ActiveDocument.ActiveWindow.Selection.MoveDown();

  // 選択範囲の前にある文字を削除します。
  await app.ActiveDocument.ActiveWindow.Selection.TypeBackspace();
}

プロパティ

ActiveDocument.ActiveWindow.Selection.Cells

Cells プロパティを使用して、選択範囲内のすべてのセルを取得できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveDocument.ActiveWindow.Selection.Cells
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // Selection オブジェクトを取得します。
  const selection = await app.ActiveDocument.ActiveWindow.Selection;

  // すべてのセルを取得します。
  const font = await selection.Cells;
}

ActiveDocument.ActiveWindow.Selection.Font

Font プロパティを使用して、選択範囲の文字フォーマットを取得できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveDocument.ActiveWindow.Selection.Font
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // Selection オブジェクトを取得します。
  const selection = await app.ActiveDocument.ActiveWindow.Selection;

  // 選択範囲の文字フォーマットを取得します。
  const font = await selection.Font;
}

ActiveDocument.ActiveWindow.Selection.InlineShapes

InlineShapes プロパティを使用して、選択範囲内のすべての InlineShape オブジェクトを取得できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveDocument.ActiveWindow.Selection.InlineShapes
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // Selection オブジェクトを取得します。
  const selection = await app.ActiveDocument.ActiveWindow.Selection;

  // すべての InlineShape オブジェクトを取得します。
  const font = await selection.InlineShapes;
}

ActiveDocument.ActiveWindow.Selection.ParagraphFormat

ParagraphFormat プロパティを使用して、選択範囲の段落設定を取得できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveDocument.ActiveWindow.Selection.ParagraphFormat
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // Selection オブジェクトを取得します。
  const selection = await app.ActiveDocument.ActiveWindow.Selection;

  // 段落設定を取得します。
  const paragraphFormat = await selection.ParagraphFormat;
}

ActiveDocument.ActiveWindow.Selection.Range

Range プロパティを使用して、選択範囲に含まれるドキュメントの部分を取得できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveDocument.ActiveWindow.Selection.Range
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // Selection オブジェクトを取得します。
  const selection = await app.ActiveDocument.ActiveWindow.Selection;

  // ドキュメントの一部を取得します。
  const paragraphFormat = await selection.ParagraphFormat;
}

ActiveDocument.ActiveWindow.Selection.Rows

Rows プロパティを使用して、選択範囲内のすべてのテーブル行を取得できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveDocument.ActiveWindow.Selection.Rows
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // Selection オブジェクトを取得します。
  const selection = await app.ActiveDocument.ActiveWindow.Selection;

  // すべてのテーブル行を取得します。
  const paragraphFormat = await selection.ParagraphFormat;
}

ActiveDocument.ActiveWindow.Selection.Tables

Tables プロパティを使用して、選択範囲内のすべてのテーブルを取得できます。

重要

JS-SDK V1.1.10 以降でのみ、この機能がサポートされています。

構文
expression.ActiveDocument.ActiveWindow.Selection.Tables
expression: ドキュメントタイプのアプリケーションオブジェクト。

例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // Selection オブジェクトを取得します。
  const selection = await app.ActiveDocument.ActiveWindow.Selection;

  // すべてのテーブルを取得します。
  const paragraphFormat = await selection.ParagraphFormat;
}