Intelligent Media Management:ブックマーク

ブックマーク

ActiveDocument.Bookmarks

アクティブなドキュメント内のすべてのブックマークを取得します。

• 構文

  expression.ActiveDocument.Bookmarks

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // アクティブなドキュメント内のすべてのブックマークを取得します。
    const bookmarks = await app.ActiveDocument.Bookmarks;
  }

メソッド

ActiveDocument.Bookmarks.Add()

ブックマークを追加します。

• 構文

  expression.ActiveDocument.Bookmarks.Add({ Name, Range })

  expression: アプリケーションオブジェクト。

• パラメーター

  パラメーター	タイプ	必須	説明
  Name	String	はい	ブックマークの名前。名前は次の要件を満たしている必要があります。 名前には文字のみを含めることができます。 名前にはスペース、数字、ピリオド (.) などの特殊文字を含めることはできません。
  Range	Object	はい	ブックマークによってマークされるテキストの範囲。ブックマークは、折りたたまれた範囲 (挿入ポイント) に設定できます。

  Range の説明

  パラメーター	タイプ	必須	説明
  Start	Number	はい	ブックマークによってマークされる範囲の開始位置。
  End	Number	はい	ブックマークによってマークされる範囲の終了位置。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // アクティブなドキュメント内のすべてのブックマークを取得します。
    const bookmarks = await app.ActiveDocument.Bookmarks;
  
    // ブックマークを追加します。
    await bookmarks.Add({
      Name: 'Aliyun',
      Range: {
        Start: 1,
        End: 10,
      },
    });
  }

ActiveDocument.Bookmarks.GetBookmarkText()

ブックマーク内のコンテンツを取得します。

• 構文

  expression.ActiveDocument.Bookmarks.GetBookmarkText(Name)

  expression: アプリケーションオブジェクト。

• パラメーター

  パラメーター	タイプ	必須	説明
  Name	String	はい	ブックマークの名前。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // アクティブなドキュメント内のすべてのブックマークを取得します。
    const bookmarks = await app.ActiveDocument.Bookmarks;
  
    // ブックマークを追加します。
    await bookmarks.Add({
      Name: 'Aliyun',
      Range: {
        Start: 1,
        End: 10,
      },
    });
  
    // ブックマークのコンテンツを取得します。
    const bookmarkText = await bookmarks.GetBookmarkText('Aliyun');
    console.log(bookmarkText);
  }

ActiveDocument.Bookmarks.Json()

ドキュメント内のすべてのブックマークに関する情報を取得します。

• 構文

  expression.ActiveDocument.Bookmarks.Json()

  expression: アプリケーションオブジェクト。

• パラメーター

  パラメーター	タイプ	説明
  name	String	ブックマークの名前。
  begin	Number	ブックマークの開始位置。
  end	Number	ブックマークの終了位置。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // アクティブなドキュメント内のすべてのブックマークを取得します。
    const bookmarks = await app.ActiveDocument.Bookmarks;
  
  
    // ブックマークを追加します。
    await app.ActiveDocument.Bookmarks.Add({
      Name: 'Aliyun',
      Range: {
        Start: 1,
        End: 10,
      },
    });
  
    // アクティブなドキュメント内のすべてのブックマークに関する情報を取得します。
    const bookmarks = await app.ActiveDocument.Bookmarks.Json();
    console.log(bookmarks);
  }

ActiveDocument.Bookmarks.ReplaceBookmark()

指定されたブックマークのコンテンツを置き換えます。

• 構文

  expression.ActiveDocument.Bookmarks.ReplaceBookmark(Data)

  expression: アプリケーションオブジェクト。

• パラメーター

  パラメーター	タイプ	必須	説明
  Data	Array.<Object>	はい	置き換えたいコンテンツの構造体。

• Data の説明

  パラメーター	タイプ	必須	説明
  name	String	はい	コンテンツを置き換えたいブックマークの名前。
  type	String	はい	コンテンツを置き換えたいブックマークのタイプ。このパラメーターを TEXT に設定します。
  value	String	はい	置き換えたいコンテンツ。

• 戻り値

  Boolean タイプの値。戻り値が true の場合、置き換えは成功しました。戻り値が false の場合、置き換えは失敗しました。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // アクティブなドキュメント内のすべてのブックマークを取得します。
    const bookmarks = await app.ActiveDocument.Bookmarks;
  
    // ブックマークを追加します。
    await bookmarks.Add({
      Name: 'Aliyun',
      Range: {
        Start: 1,
        End: 10,
      },
    });
  
    // ブックマークのコンテンツを置き換えます。
    const isReplaceSuccess = await bookmarks.ReplaceBookmark([
      {
        name: 'Aliyun',
        type: 'text',
        value: 'Content to replace with', // 置き換えるコンテンツ
      },
    ]);
    console.log(isReplaceSuccess);
  }

  ActiveDocument.Bookmarks.Exists(Name)

  指定されたブックマークが存在するかどうかを確認します。

  重要

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

• 構文

  expression.ActiveDocument.Bookmarks.Exists(Name)

  expression: アプリケーションオブジェクト。

• パラメーター

  パラメーター	タイプ	必須	説明
  Name	String	はい	ブックマークの名前。

• 戻り値

  Boolean タイプの値。戻り値が true の場合、ブックマークは存在します。そうでない場合、ブックマークは存在しません。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // ブックマークを追加します。
    await app.ActiveDocument.Bookmarks.Add({
      Name: 'WebOffice',
      Range: {
        Start: 1,
        End: 10,
      },
    });
  
    // ブックマークが存在するかどうかを確認します。
    const isExist = await app.ActiveDocument.Bookmarks.Exists('WebOffice');
    console.log(isExist); // true
  }

  プロパティ

  ActiveDocument.Bookmarks.Count

  アクティブなドキュメント内のブックマークコンテンツコントロールの数を返します。

  重要

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

• 構文

  expression.ActiveDocument.Bookmarks.Count

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // ブックマークを追加します。
    await app.ActiveDocument.Bookmarks.Add({
      Name: 'WebOffice',
      Range: {
        Start: 1,
        End: 10,
      },
    });
  
    // ブックマークの数を取得します。
    const count = await app.ActiveDocument.Bookmarks.Count;
    console.log(count);
  }

  ActiveDocument.Bookmarks.DefaultSorting

  ブックマークの並べ替えオプションを設定します。

  重要

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

• 構文

  expression.ActiveDocument.Bookmarks.DefaultSorting = WdBookmarkSortBy

  expression: アプリケーションオブジェクト。

• WdBookmarkSortBy 設定の詳細については、Enum.WdBookmarkSortBy を参照してください。

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
  
    // ブックマークを並べ替えます。
    const sort = await app.ActiveDocument.Bookmarks.DefaultSorting;
  
    // ブックマークの並べ替えオプションを設定します。
    app.ActiveDocument.Bookmarks.DefaultSorting = 0;
  }WdBookmarkSortBy の詳細については、Enum.WdBookmarkSortBy を参照してください。

ブックマーク

ActiveDocument.Bookmarks.Item()

指定されたブックマークを取得します。

• 構文

  expression.ActiveDocument.Bookmarks.Item(Name)

  expression: アプリケーションオブジェクト。

• パラメーター

  パラメーター	タイプ	必須	説明
  Name	String	はい	ブックマークの名前。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // アクティブなドキュメント内のすべてのブックマークを取得します。
    const bookmarks = await app.ActiveDocument.Bookmarks;
  
    // ブックマークを追加します。
    await bookmarks.Add({
      Name: 'Aliyun',
      Range: {
        Start: 1,
        End: 10,
      },
    });
  
    // ブックマークを取得します。
    await app.ActiveDocument.Bookmarks.Item('Aliyun');
  }

メソッド

ActiveDocument.Bookmarks.Item(Name).Delete()

指定されたブックマークを削除します。

• 構文

  expression.ActiveDocument.Bookmarks.Item(Name).Delete()

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // アクティブなドキュメント内のすべてのブックマークを取得します。
    const bookmarks = await app.ActiveDocument.Bookmarks;
  
    // ブックマークを追加します。
    await bookmarks.Add({
      Name: 'Aliyun',
      Range: {
        Start: 1,
        End: 10,
      },
    });
  
    // ブックマークを取得します。
    await app.ActiveDocument.Bookmarks.Item('Aliyun');
  
    // ブックマークを削除します。
    await app.ActiveDocument.Bookmarks.Item('Aliyun').Delete();
  }

  ActiveDocument.Bookmarks.Item(Name1).Copy(Name2)

  指定されたブックマークをコピーします。

  重要

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

• 構文

  expression.ActiveDocument.Bookmarks.Item(Name1).Copy(Name2)

  expression: アプリケーションオブジェクト。

• パラメーター

  パラメーター	タイプ	必須	説明
  Name	String	はい	ブックマークの名前。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // ブックマークを追加します。
    await app.ActiveDocument.Bookmarks.Add({
      Name: 'WebOffice',
      Range: {
        Start: 1,
        End: 10,
      },
    });
  
    // ブックマークをコピーします。
    await app.ActiveDocument.Bookmarks.Item('WebOffice').Copy('NewBookmark');
  }

  ActiveDocument.Bookmarks.Item(Name).Select()

• 指定されたブックマークを選択します。

  重要

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

• 構文

  expression.ActiveDocument.Bookmarks.Item(Name).Select()

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // ブックマークを追加します。
    await app.ActiveDocument.Bookmarks.Add({
      Name: 'WebOffice',
      Range: {
        Start: 1,
        End: 10,
      },
    });
  
    // ブックマークによってマークされたコンテンツを選択します。
    await app.ActiveDocument.Bookmarks.Item('WebOffice').Select();
  }

プロパティ

ActiveDocument.Bookmarks.Item(Name).Name

指定されたブックマークの名前を取得します。

• 構文

  expression.ActiveDocument.Bookmarks.Item(Name).Name

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // アクティブなドキュメント内のすべてのブックマークを取得します。
    const bookmarks = await app.ActiveDocument.Bookmarks;
  
    // ブックマークを追加します。
    await bookmarks.Add({
      Name: 'Aliyun',
      Range: {
        Start: 1,
        End: 10,
      },
    });
  
    // ブックマークを取得します。
    await app.ActiveDocument.Bookmarks.Item('Aliyun');
  
    // ブックマークの名前を取得します。
    await app.ActiveDocument.Bookmarks.Item('Aliyun').Name;
  }

  ActiveDocument.Bookmarks.Item(Name).Empty

  指定されたブックマークが空かどうかを判断します。

  重要

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

• 構文

  expression.ActiveDocument.Bookmarks.Item(Name).Empty

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // ブックマークを追加します。
    await app.ActiveDocument.Bookmarks.Add({
      Name: 'WebOffice',
      Range: {
        Start: 1,
        End: 10,
      },
    });
  
    // ブックマークが空かどうかを確認します。
    const isEmpty = await app.ActiveDocument.Bookmarks.Item('WebOffice').Empty;
    console.log(isEmpty); // false
  }

  ActiveDocument.Bookmarks.Item(Name).Start

• 指定されたブックマーク内のコンテンツの開始位置を取得します。

  重要

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

• 構文

  expression.ActiveDocument.Bookmarks.Item(Name).Start

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // ブックマークを追加します。
    await app.ActiveDocument.Bookmarks.Add({
      Name: 'WebOffice',
      Range: {
        Start: 1,
        End: 10,
      },
    });
  
    // ブックマーク内のコンテンツの開始位置を取得します。
    const start = await app.ActiveDocument.Bookmarks.Item('WebOffice').Start;
    console.log(start); // 1
  }

  ActiveDocument.Bookmarks.Item(Name).End

• 指定されたブックマーク内のコンテンツの終了位置を取得します。

  重要

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

• 構文

  expression.ActiveDocument.Bookmarks.Item(Name).End

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // ブックマークを追加します。
    await app.ActiveDocument.Bookmarks.Add({
      Name: 'WebOffice',
      Range: {
        Start: 1,
        End: 10,
      },
    });
  
    // 指定されたブックマーク内のコンテンツの終了位置を取得します。
    const end = await app.ActiveDocument.Bookmarks.Item('WebOffice').End;
    console.log(end); // 10
  }

  ActiveDocument.Bookmarks.Item(Name).Range

• 指定されたブックマークに含まれるドキュメントの範囲を取得します。

  重要

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

• 構文

  expression.ActiveDocument.Bookmarks.Item(Name).Range

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // ブックマークを追加します。
    await app.ActiveDocument.Bookmarks.Add({
      Name: 'WebOffice',
      Range: {
        Start: 1,
        End: 10,
      },
    });
  
    // ブックマークに含まれるドキュメントの範囲を取得します。
    await app.ActiveDocument.Bookmarks.Item('WebOffice').Range;
  }

  ActiveDocument.Bookmarks.Item(Name).StoryType

• 指定されたブックマークのストーリータイプを取得します。

  重要

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

• 構文

  expression.ActiveDocument.Bookmarks.Item(Name).StoryType

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // ブックマークを追加します。
    await app.ActiveDocument.Bookmarks.Add({
      Name: 'WebOffice',
      Range: {
        Start: 1,
        End: 10,
      },
    });
  
    // ブックマークのストーリータイプを取得します。
    await app.ActiveDocument.Bookmarks.Item('WebOffice').StoryType;
  }

  ActiveDocument.Bookmarks.Item(Name).Column

• 指定されたブックマークが表の列かどうかを判断します。

  重要

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

• 構文

  expression.ActiveDocument.Bookmarks.Item(Name).Column

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // ブックマークを追加します。
    await app.ActiveDocument.Bookmarks.Add({
      Name: 'WebOffice',
      Range: {
        Start: 1,
        End: 10,
      },
    });
  
    // ブックマークが表の列かどうかを判断します。
    const column = await app.ActiveDocument.Bookmarks.Item('WebOffice').Column;
    console.log(column); // false
  }