すべてのプロダクト
Search
ドキュメントセンター

Intelligent Media Management:Range

最終更新日:Dec 27, 2024

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

Range

ActiveDocument.Range(Start, End)

Range オブジェクトを返します。各 Range オブジェクトは、開始文字位置と終了文字位置によって定義されます。

重要

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

  • 構文

    expression.ActiveDocument.Range(Start, End)

    または、expression.ActiveDocument.ActiveWindow.Selection.Range

    または、expression.ActiveDocument.Tables.Item(Index).Range

    または、expression.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item(Index).Range

    expression: Application オブジェクト

    • アクティブドキュメント内の Range オブジェクトを返します

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        // Range オブジェクトを返します。
        const range = app.ActiveDocument.Range(0, 100);
      }
    • セルから Range オブジェクトを返します

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        // 最初のテーブルを返します。
        const tableOne = await app.ActiveDocument.Tables.Item(1);
      
        // テーブルの最初の行の最初のセルを返します。
        const cellOne = await tableOne.Rows.Item(1).Cells.Item(1);
        
        // セルから Range オブジェクトを返します。
        const range = await cellOne.Range;
      }

メソッド

ActiveDocument.Range().Item()

指定された Range オブジェクト内の Range オブジェクトを返します。

  • 構文

    expression.ActiveDocument.Range(Start, End).Item({ Start, End })

    または、expression.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item(Index).Range.Item({ Start, End })

    expression: Application オブジェクト

  • パラメータ

    パラメータ

    データ型

    必須

    説明

    Start

    数値

    はい

    開始位置。

    End

    数値

    はい

    終了位置。

    • アクティブドキュメントから Range オブジェクトを返します

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        // Range オブジェクトを返します。
        const range = app.ActiveDocument.Range(0, 100);
      
        // Range オブジェクト内の別の Range オブジェクトを返します。
        const item = await range.Item(0, 50);
      }
    • セルから Range オブジェクトを返します

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        // 最初のテーブルを返します。
        const tableOne = await app.ActiveDocument.Tables.Item(1);
      
        // テーブルの最初の行の最初のセルを返します。
        const cellOne = await tableOne.Rows.Item(1).Cells.Item(1);
        
        // セルから Range オブジェクトを返します。
        const range = await cellOne.Range;
      
        // Range オブジェクト内の別の Range オブジェクトを返します。
        const item = await range.Item(1, 10);
      }

ActiveDocument.Range(Start, End).GetHtmlData()

Range オブジェクト内のフォーマットされた HTML データを返します。

重要

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

  • 構文

    expression.ActiveDocument.Range(Start, End).GetHtmlData()

    expression: Application オブジェクト

  • 戻り値

    パラメータ

    データ型

    説明

    HTML

    文字列

    HTML データ。

    Text

    文字列

    テキストデータ。

  • async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // Range オブジェクトを返します。
      const range = app.ActiveDocument.Range(10, 20);
    
      // Range オブジェクト内のフォーマットされた HTML データを返します。
      const htmlInfo = await range.GetHtmlData();
      console.log(htmlInfo);
    }

ActiveDocument.Range(Start, End).PasteHtml()

フォーマットされた HTML データを Range オブジェクトに貼り付けます。

重要

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

  • 構文

    expression.ActiveDocument.Range(Start, End).PasteHtml({ HTML })

    expression: Application オブジェクト

  • パラメータ

    パラメータ

    データ型

    必須

    説明

    HTML

    文字列

    はい

    HTML データ。ActiveDocument.Range(Start, End).GetHtmlData()メソッドを呼び出して HTML データを返すことができます。

  • async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // Range オブジェクトを返します。
      const range = app.ActiveDocument.Range(10, 20);
    
      // Range オブジェクト内のフォーマットされた HTML データを返します。
      const htmlInfo = await range.GetHtmlData();
    
      // フォーマットされた HTML データを Range オブジェクトに貼り付けます。
      await app.ActiveDocument.Range(110, 110).PasteHtml({
        HTML: htmlInfo.HTML,
      });
    }

ActiveDocument.Range(Start, End).SetRange()

既存の Range オブジェクトの開始文字位置と終了文字位置を設定します。

  • 構文

    expression.ActiveDocument.Range(Start, End).SetRange({ Start, End })

    または、expression.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item(Index).Range.SetRange({ Start, End })

    expression: Application オブジェクト

  • パラメータ

    パラメータ

    データ型

    必須

    説明

    Start

    数値

    はい

    開始文字位置。

    End

    数値

    はい

    終了文字位置。

    • アクティブドキュメント内の既存の Range オブジェクトの開始文字位置と終了文字位置を設定します

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        // Range オブジェクトを返します。
        const range = app.ActiveDocument.Range(0, 100);
      
        // Range オブジェクトの開始文字位置と終了文字位置を設定します。
        await range.SetRange(10, 20);
      }
    • セル内の既存の範囲の開始文字位置と終了文字位置を設定します

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        // 最初のテーブルを返します。
        const tableOne = await app.ActiveDocument.Tables.Item(1);
      
        // テーブルの最初の行の最初のセルを返します。
        const cellOne = await tableOne.Rows.Item(1).Cells.Item(1);
        
        // セルから Range オブジェクトを返します。
        const range = await cellOne.Range;
      
        // Range オブジェクトの開始文字位置と終了文字位置を設定します。
        const newRange = await range.SetRange({
          Start: 1,
          End: 10,
        });
      }

ActiveDocument.Range(Start, End).Find

範囲内で特定の情報を検索します。

重要

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

  • 構文

    expression.ActiveDocument.Range(Start, End).Find

    expression: Application オブジェクト

  • パラメータ

    パラメータ

    データ型

    デフォルト値

    必須

    説明

    Text

    文字列

    はい

    検索する情報。

    ShowHighlight

    ブール値

    true

    いいえ

    情報を強調表示するかどうかを指定します。

    FilterConfig

    オブジェクト

    true

    いいえ

    構成項目 (WebOffice V8.5.1+ でサポート)

  • FilterConfig

    要素

    データ型

    デフォルト値

    必須

    説明

    isCaseSensitive

    ブール値

    false

    いいえ

    大文字と小文字を区別するかどうかを指定します。

    isWholeWordMatched

    ブール値

    false

    いいえ

    完全一致を使用するかどうかを指定します。

    isWidthIgnored

    ブール値

    false

    いいえ

    文字幅(全角と半角)を無視するかどうかを指定します。

    isWildcardMatched

    ブール値

    false

    いいえ

    ワイルドカード文字を使用するかどうかを指定します。

    isRegexMatched

    ブール値

    false

    いいえ

    正規表現を適用するかどうかを指定します。ワイルドカード文字と正規表現の両方が検索に適用される場合、正規表現が優先されます。

  • async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // 指定された Range オブジェクトを返します。
      const range = await app.ActiveDocument.Range(0, 10);
    
      // 情報を検索します。
      range.Find('WPS')
    }

プロパティ

ActiveDocument.Range(Start, End).Start

Range オブジェクトの開始位置を返します。

  • 構文

    expression.ActiveDocument.Range(Start, End).Start

    または、expression.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item(Index).Range.Start

    expression: Application オブジェクト

    • アクティブドキュメント内の Range オブジェクトの開始文字位置を返します

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        // Range オブジェクトを返します。
        const range = app.ActiveDocument.Range(0, 100);
      
        // Range オブジェクトの開始位置を返します。
        const start = await range.Start;
        console.log(start);
      }
    • セル内の Range オブジェクトの開始位置を返します

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        // 最初のテーブルを返します。
        const tableOne = await app.ActiveDocument.Tables.Item(1);
      
        // テーブルの最初の行の最初のセルを返します。
        const cellOne = await tableOne.Rows.Item(1).Cells.Item(1);
        
        // セルから Range オブジェクトを返します。
        const range = await cellOne.Range;
      
        // Range オブジェクトの開始位置を返します。
        const start = await range.Start;
        console.log(start);
        }

ActiveDocument.Range(Start, End).End

範囲の終了位置を返します。

  • 構文

    expression.ActiveDocument.Range(Start, End).End

    または、expression.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item(Index).Range.End

    expression: Application オブジェクト

    • アクティブドキュメント内の Range オブジェクトの終了位置を返します

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        // Range オブジェクトを返します。
        const range = app.ActiveDocument.Range(0, 100);
      
        // Range オブジェクトの終了位置を返します。
        const end = await range.End;
        console.log(end);
      }
    • セル内の範囲の終了位置を返します。

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        // 最初のテーブルを返します。
        const tableOne = await app.ActiveDocument.Tables.Item(1);
      
        // テーブルの最初の行の最初のセルを返します。
        const cellOne = await tableOne.Rows.Item(1).Cells.Item(1);
        
        // セルから Range オブジェクトを返します。
        const range = await cellOne.Range;
      
        // Range オブジェクトの終了位置を返します。
        const end = await range.End;
        console.log(end);
      }

ActiveDocument.Range(Start, End).Font

範囲のフォントを表す Font オブジェクトを返します。

  • 構文

    expression.ActiveDocument.Range(Start, End).Font

    または、expression.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item(Index).Range.Font

    expression: Application オブジェクト

    • アクティブドキュメント内の範囲の Font オブジェクトを返します

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        // Range オブジェクトを返します。
        const range = app.ActiveDocument.Range(0, 100);
      
        // Font オブジェクトを返します。
        const font = await range.Font;
        console.log(font);
      }
    • セル内の範囲の Font オブジェクトを返します

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        // 最初のテーブルを返します。
        const tableOne = await app.ActiveDocument.Tables.Item(1);
      
        // テーブルの最初の行の最初のセルを返します。
        const cellOne = await tableOne.Rows.Item(1).Cells.Item(1);
        
        // セルから Range オブジェクトを返します。
        const range = await cellOne.Range;
      
        // Font オブジェクトを返します。
        const font = await range.Font;
      }

ActiveDocument.ActiveWindow.Selection.Range.HighlightColorIndex

範囲の蛍光ペンの色を設定または返します。蛍光ペンの色は、ページを更新した後も残ります。

  • 構文

    expression.ActiveDocument.ActiveWindow.Selection.Range.HighlightColorIndex=WdColorIndex

    expression: Application オブジェクト

  • パラメータ

    パラメータ

    データ型

    必須

    説明

    WdColorIndex

    列挙型

    いいえ

    指定された範囲の蛍光ペンの色を指定します。詳細については、WdColorIndex を参照してください。

  • async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // 指定された範囲の蛍光ペンの色を設定または返します。蛍光ペンの色は、ページを更新した後も残ります。
      app.ActiveDocument.ActiveWindow.Selection.Range.HighlightColorIndex = 7;
    }

ActiveDocument.ActiveWindow.Selection.Range.HighlightColorIndexTemp

範囲の蛍光ペンの色を設定または返します。蛍光ペンの色は、ページを更新すると消えます。

  • 構文

    expression.ActiveDocument.ActiveWindow.Selection.Range.HighlightColorIndexTemp=WdColorIndex

    expression: Application オブジェクト

  • パラメータ

    パラメータ

    データ型

    必須

    説明

    WdColorIndex

    列挙型

    いいえ

    指定された範囲の蛍光ペンの色。詳細については、WdColorIndex を参照してください。

  • async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // 指定された範囲の蛍光ペンの色を設定または返します。蛍光ペンの色は、ページを更新すると消えます。
      app.ActiveDocument.ActiveWindow.Selection.Range.HighlightColorIndexTemp = 7;
    }

ActiveDocument.Range.Information()

ページ情報を返します。ページの総数のみが使用可能です。

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

  • ドキュメントにはリキッドレイアウトデザインが適用されています。したがって、ドキュメントの総ページ数は、ドキュメントの最後のページを参照したときにのみ使用可能です。

  • 構文

    expression.ActiveDocument.Range.Information(WdInformation)

    expression: Application オブジェクト

  • パラメータ

    次の表は、app.Enum.WdInformation を使用して取得できる選択範囲または範囲に関する情報のタイプを示しています。

    パラメータ

    データ型

    必須

    説明

    WdInformation

    列挙型

    はい

    ページ情報。ページの総数のみが使用可能です。詳細については、WdInformation を参照してください。

  • 戻り値

    パラメータ

    データ型

    説明

    PagesCount

    数値

    組版が完了したページ数。

    End

    ブール値

    組版が終了したかどうかを示します。

  • async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      // 総ページ数を返します。
      const totalPages = await app.ActiveDocument.Range.Information(app.Enum.WdInformation.wdNumberOfPagesInDocument);
      console.log(totalPages);
    }
    

ActiveDocument.Range(Start, End).Paragraphs

範囲内のすべての段落を返します。

重要

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

  • 構文

    expression.ActiveDocument.Range(Start, End).Paragraphs

    または、expression.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item(Index).Range.Paragraphs

    expression: Application オブジェクト

    • アクティブドキュメント内の範囲のすべての段落を返します

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        // Range オブジェクトを返します。
        const range = app.ActiveDocument.Range(0, 100);
      
        // Range オブジェクト内のすべての段落を返します。
        const info = await range.Paragraphs;
      }
    • セル内の Range オブジェクトのすべての段落を返します

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        // 最初のテーブルを返します。
        const tableOne = await app.ActiveDocument.Tables.Item(1);
      
        // テーブルの最初の行の最初のセルを返します。
        const cellOne = await tableOne.Rows.Item(1).Cells.Item(1);
        
        // セルから Range オブジェクトを返します。
        const range = await cellOne.Range;
      
        // Range オブジェクト内のすべての段落を返します。
        const paragraphFormat = await range.Paragraphs;
      }

ActiveDocument.Range(Start, End).ParagraphFormat

範囲の段落フォーマット設定を返します。

  • 構文

    expression.ActiveDocument.Range(Start, End).ParagraphFormat

    または、expression.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item(Index).Range.ParagraphFormat

    expression: Application オブジェクト

    • アクティブドキュメント内の範囲の段落フォーマット設定を返します

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        // Range オブジェクトを返します。
        const range = app.ActiveDocument.Range(0, 100);
      
        // Range オブジェクトの段落フォーマット設定を返します。
        const info = await range.ParagraphFormat;
      }
    • セル内の範囲の段落フォーマット設定を返します

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        // 最初のテーブルを返します。
        const tableOne = await app.ActiveDocument.Tables.Item(1);
      
        // テーブルの最初の行の最初のセルを返します。
        const cellOne = await tableOne.Rows.Item(1).Cells.Item(1);
        
        // セルから Range オブジェクトを返します。
        const range = await cellOne.Range;
      
        // Range オブジェクトの段落フォーマット設定を返します。
        const paragraphFormat = await range.ParagraphFormat;
      }

ActiveDocument.Range(Start, End).Text

範囲のテキストを設定およびクエリします。

重要
  • JS-SDK V1.1.10 以降では、テキストクエリがサポートされています。

  • JS-SDK V1.1.11 以降では、テキスト設定がサポートされています。

  • 構文

    expression.ActiveDocument.Range(Start, End).Text

    または、expression.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item(Index).Range.Text

    expression: Application オブジェクト

    • アクティブドキュメント内の範囲のテキストを設定およびクエリします

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        // Range オブジェクトを返します。
        const range = app.ActiveDocument.Range(0, 100);
      
        // テキストを返します。
        const text = await range.Text;
        console.log(text);
      
        // テキストを設定します。
        range.Text = 'Aliyun';
      }
    • セル内の範囲のテキストを設定およびクエリします

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        // 最初のテーブルを返します。
        const tableOne = await app.ActiveDocument.Tables.Item(1);
      
        // テーブルの最初の行の最初のセルを返します。
        const cellOne = await tableOne.Rows.Item(1).Cells.Item(1);
        
        // セルから Range オブジェクトを返します。
        const range = await cellOne.Range;
      
        // テキストを返します。
        const text = await range.Text;
        console.log(text);
      
        // テキストを設定します。
        range.Text = 'Aliyun';
      }