Word 文書のコンテンツコントロールに関連する API 操作 - Intelligent Media Management

このトピックでは、ドキュメントのコンテンツコントロールに関連する API 操作について説明します。

ContentControls

ActiveDocument.ContentControls

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

重要

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

構文
expression.ActiveDocument.ContentControls
expression: アプリケーションオブジェクト。

例

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;
}

メソッド

ActiveDocument.ContentControls.Add()

カーソルの位置にコンテンツコントロールを挿入します。

重要

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

構文
expression.ActiveDocument.ContentControls.Add({ Type })
expression: アプリケーションオブジェクト。

パラメーター

パラメーター	データ型	必須	説明
Type	Enum	はい	コンテンツコントロールのタイプ。WdContentControlType の定数のいずれかに設定できます。このパラメーターを空のままにすると、リッチテキスト形式 (RTF) のコンテンツコントロールが挿入されます。重要 JS-SDK V1.1.15 以降では、ドロップダウンリストコンテンツコントロールを挿入できます。

戻り値
挿入されたコンテンツコントロール。

例

RTF コンテンツコントロールを挿入する

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

  const app = instance.Application;

  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const contentControls = await app.ActiveDocument.ContentControls;

  // カーソルの位置に RTF コンテンツコントロールを挿入します。
  await contentControls.Add();
}

ドロップダウンリストコンテンツコントロールを挿入する

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

  const app = instance.Application;

  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const contentControls = await app.ActiveDocument.ContentControls;

  // カーソルの位置にドロップダウンリスト コンテンツコントロールを挿入します。
  await contentControls.Add({
    Type: 4,
  });
}

ActiveDocument.ContentControls.Item()

アクティブなドキュメント内のコンテンツコントロールのコレクションの中から、指定されたコンテンツコントロールを返します。

重要

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

構文
expression.ActiveDocument.ContentControls.Item(Index)
expression: アプリケーションオブジェクト。
パラメーター
パラメーター
データ型
必須
説明
Index
Number
はい
返すコンテンツコントロールのインデックス番号。
戻り値
指定された ContentControl オブジェクト。
例
```
async function example() {
  await instance.ready();

  const app = instance.Application;

  // 最初の ContentControl オブジェクトを返します。
  const contentControl = await app.ActiveDocument.ContentControls.Item(1);
}
```
ActiveDocument.ContentControls.SetItemsContent()
複数のコンテンツコントロールを設定します。SetItemsContent メソッドを呼び出すには、jsconfig 構成ファイルに wps.enableSuperContentControlApi = true を追加する必要があります。
構文
expression.ActiveDocument.ContentControls.SetItemsContent({Value, Key, CompareTitle })
expression: アプリケーションオブジェクト。

パラメーター

パラメーター	データ型	必須	説明
Value	String	はい	設定するコンテンツ。
Key	String	はい	タイトルまたはタグ。
CompareTitle	Boolean	はい	タイトルで一括設定を実行するかどうかを指定します。このパラメーターが true に設定されている場合、タイトルで一括設定が実行されます。このパラメーターが false に設定されている場合、タグで一括設定が実行されます。

例

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

  const app = instance.Application;

  const contentControls = await app.ActiveDocument.ContentControls;
  await contentControls.SetItemsContent({ Value: "Batch replace content of content controls", Key: "test", CompareTitle: true });
}

プロパティ

ActiveDocument.ContentControls.Count

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

構文
expression.ActiveDocument.ContentControls.Count
expression: アプリケーションオブジェクト。
戻り値
アクティブなドキュメント内のコンテンツコントロールの数。

例

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

  const app = instance.Application;

  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const contentControls = await app.ActiveDocument.ContentControls;
  
  // コンテンツコントロールの数を返します。
  const count = await contentControls.Count;
  console.log(count);
}

ContentControl

ActiveDocument.ContentControls.Item(Index)

指定されたコンテンツコントロールを返します。

重要

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

構文
expression.ActiveDocument.ContentControls.Item(Index)
expression: アプリケーションオブジェクト。
パラメーター
パラメーター
データ型
必須
説明
Index
String
はい
返すコンテンツコントロールの序数。
戻り値
指定されたコンテンツコントロール。

例

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const contentControls = await app.ActiveDocument.ContentControls;

  // 最初の ContentControl オブジェクトを返します。
  const contentControl = await contentControls.Item(1);
}

ActiveDocument.ContentControls.Item(Index).SetPlaceholderText()

指定されたコンテンツコントロールのプレースホルダーテキストを設定します。

構文
expression.ActiveDocument.ContentControls.Item(Index).SetPlaceholderText({ Text })
expression: アプリケーションオブジェクト。
パラメーター
パラメーター
データ型
必須
説明
Text
String
はい
指定されたコンテンツコントロールのプレースホルダーテキスト。

例

//@file=base.docx
async function example() {
  await instance.ready();

  const app = instance.Application;

  // すべてのコンテンツコントロールを返します。
  const contentControls = await app.ActiveDocument.ContentControls;

  // 最初のコンテンツコントロールを返します。
  const contentControl = await contentControls.Item(1);

  // 最初のコンテンツコントロールのプレースホルダーテキストを設定します。
  await contentControl.SetPlaceholderText({ Text: 'WebOffice' });
}

プロパティ

ActiveDocument.ContentControls.Item(Index).PlaceholderText

コンテンツコントロールのプレースホルダーテキストを返します。

重要

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

構文
expression.ActiveDocument.ContentControls.Item(Index).PlaceholderText
expression: アプリケーションオブジェクト。

例

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const contentControls = await app.ActiveDocument.ContentControls;

  // 最初の ContentControl オブジェクトを返します。
  const contentControl = await contentControls.Item(1);

  // コンテンツコントロールのプレースホルダーテキストを返します。
  const placeholderText = await contentControl.PlaceholderText;
  console.log(placeholderText);
}

ActiveDocument.ContentControls.Item(Index).Range

コンテンツコントロールのコンテンツを表す Range オブジェクトを返します。Range.Text を使用して、コンテンツコントロール内の Range オブジェクトのテキストを設定または返すことができます。

重要

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

構文
expression.ActiveDocument.ContentControls.Item(Index).Range
expression: アプリケーションオブジェクト。

例

ContentControl オブジェクトの範囲を返す

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const contentControls = await app.ActiveDocument.ContentControls;

  // 最初の ContentControl オブジェクトを返します。
  const contentControl = await contentControls.Item(1);

  // コンテンツコントロールの範囲を返します。
  const range = await contentControl.Range;
  console.log(range);
}

ContentControl オブジェクト内のテキストを返すおよび設定する

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const contentControls = await app.ActiveDocument.ContentControls;

  // 最初の ContentControl オブジェクトを返します。
  const contentControl = await contentControls.Item(1);

  // コンテンツコントロールの範囲を返します。
  const range = await contentControl.Range;

  // コンテンツコントロール内のテキストを返します。
  const text = range.Text;
  console.log(text);

  // コンテンツコントロールのテキストを設定します。
  range.Text = 'Aliyun';
}

ActiveDocument.ContentControls.Item(Index).Tag

コンテンツコントロールのタグを設定または返します。

重要

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

構文
expression.ActiveDocument.ContentControls.Item(Index).Tag
expression: アプリケーションオブジェクト。

例

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const contentControls = await app.ActiveDocument.ContentControls;

  // 最初の ContentControl オブジェクトを返します。
  const contentControl = await contentControls.Item(1);

  // コンテンツコントロールのタグを設定します。
  contentControl.Tag = 'Aliyun';

  // コンテンツコントロールのタグを返します。
  const Tag = await contentControl.Tag;
  console.log(Tag);
}

ActiveDocument.ContentControls.Item(Index).Title

コンテンツコントロールのタイトルを設定または返します。

重要

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

構文
expression.ActiveDocument.ContentControls.Item(Index).Title
expression: アプリケーションオブジェクト。

例

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const contentControls = await app.ActiveDocument.ContentControls;

  // 最初の ContentControl オブジェクトを返します。
  const contentControl = await contentControls.Item(1);

  // コンテンツコントロールのタイトルを設定します。
  contentControl.Title = 'Aliyun';

  // コンテンツコントロールのタイトルを返します。
  const title = await contentControl.Title;
  console.log(title);

ContentControlListEntries

ActiveDocument.ContentControls.Item(Index).DropdownListEntries

ドロップダウンリストコンテンツコントロール内のすべての項目を返します。このプロパティは読み取り専用です。

重要

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

構文
expression.ActiveDocument.ContentControls.Item(Index).DropdownListEntries
expression: アプリケーションオブジェクト。

例

ドロップダウンリストコンテンツコントロールを挿入し、コンテンツコントロール内のすべての項目を返す

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツ コントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウン リスト コンテンツ コントロールを挿入します。
  const ContentControl = await ContentControls.Add({
    Type: 4,
  });

  // ドロップダウン リスト コンテンツ コントロール内のすべてのアイテムを返します。
  const ContentControlListEntries = await ContentControl.
  DropdownListEntries;
}

既存のドロップダウンリストコンテンツコントロール内のすべての項目を返す

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await ContentControls.Add({
    Type: 4,
  });

  // ドキュメント内のコンテンツコントロールの数 (テキスト コンテンツコントロールとドロップダウンリスト コンテンツコントロールを含む) を返します。
  // 挿入後にコンテンツコントロールの数が 2 である場合 (コンソールに出力されるカウント結果は 2)、新しいコンテンツコントロールのインデックスは 2 です。
  const Count = await WPSOpenApi.Application.ActiveDocument.ContentControls.Count;

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const ContentControlListEntries = await WPSOpenApi.Application.ActiveDocument.ContentControls.Item(Count).DropdownListEntries;
}

メソッド

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Add()

ドロップダウンリストまたはコンボボックスコンテンツコントロールに項目を追加し、ドロップダウンリストまたはコンボボックスコンテンツコントロールに追加された項目を表す ContentControlListEntry オブジェクトを返します。

重要

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

構文
expression.ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Add({ Text, Value, Index })
expression: アプリケーションオブジェクト。

例

コンテンツコントロールを挿入するときに、ドロップダウンリストコンテンツコントロールに項目を追加する

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await ContentControls.Add({
    Type: 4,
  });

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const ContentControlListEntries = await ContentControl.
  DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロールに項目を追加します。
  await ContentControlListEntries.Add({
    Text: 'Text 1',
    Value: 'Value 1',
    Index: 1,
  });

  // ドロップダウンリスト コンテンツコントロールに別の項目を追加します。 Value パラメーターと Index パラメーターはオプションです。 Value パラメーターを指定しないでおくと、Value パラメーターは Text パラメーターと同じ値になります。
  await ContentControlListEntries.Add({
    Text: 'Text 2',
  });
}

既存のドロップダウンリストコンテンツコントロールに項目を追加する

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await ContentControls.Add({
    Type: 4,
  });

  // ドキュメント内のコンテンツコントロールの数 (テキスト コンテンツコントロールとドロップダウンリスト コンテンツコントロールを含む) を返します。
  // 挿入後にコンテンツコントロールの数が 2 である場合 (コンソールに出力されるカウント結果は 2)、新しいコンテンツコントロールのインデックスは 2 です。
  const Count = await WPSOpenApi.Application.ActiveDocument.ContentControls.Count;

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const ContentControlListEntries = await WPSOpenApi.Application.ActiveDocument.ContentControls.Item(Count).DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロールに項目を追加します。
  await ContentControlListEntries.Add({
    Text: 'Text 1',
    Value: 'Value 1',
    Index: 1,
  });
}

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Clear()

ドロップダウンリストまたはコンボボックスコンテンツコントロールからすべての項目を削除します。

重要

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

構文
expression.ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Clear()
expression: アプリケーションオブジェクト。

例

ドロップダウンリストコンテンツコントロールを挿入し、ドロップダウンリストコンテンツコントロールからすべての項目を削除する

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await ContentControls.Add({
    Type: 4,
  });

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const ContentControlListEntries = await ContentControl.
  DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロールに項目を追加します。
  await ContentControlListEntries.Add({
    Text: 'Text 1',
    Value: 'Value 1',
    Index: 1,
  });

  // ドロップダウンリスト コンテンツコントロールに別の項目を追加します。項目の Value パラメーターを指定しない場合、Value パラメーターは Text パラメーターと同じ値になります。
  await ContentControlListEntries.Add({
    Text: 'Text 2',
  });

  // ドロップダウンリスト コンテンツコントロールの作成から 3,000 ミリ秒後に、すべての項目を削除します。
  setTimeout(async () => {
    await ContentControlListEntries.Clear();
  }, 3000);
}

既存のドロップダウンリストコンテンツコントロールからすべての項目を削除する

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await ContentControls.Add({
    Type: 4,
  });

  // ドキュメント内のコンテンツコントロールの数 (テキスト コンテンツコントロールとドロップダウンリスト コンテンツコントロールを含む) を返します。
  // 挿入後にコンテンツコントロールの数が 2 である場合 (コンソールに出力されるカウント結果は 2)、新しいコンテンツコントロールのインデックスは 2 です。
  const Count = await WPSOpenApi.Application.ActiveDocument.ContentControls.Count;

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const ContentControlListEntries = await WPSOpenApi.Application.ActiveDocument.ContentControls.Item(Count).DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロールに項目を追加します。
  await ContentControlListEntries.Add({
    Text: 'Text 1',
    Value: 'Value 1',
    Index: 1,
  });

  // ドロップダウンリスト コンテンツコントロールの作成から 3,000 ミリ秒後に、すべての項目を削除します。
  setTimeout(async () => {
    await ContentControlListEntries.Clear();
  }, 3000);
}

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.GetSelectedItem()

ドロップダウンリストコンテンツコントロールで選択されている項目を返します。

重要

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

構文
expression.ActiveDocument.ContentControls.Item(Index).DropdownListEntries.GetSelectedItem()
expression: アプリケーションオブジェクト。

例

ドロップダウンリストコンテンツコントロールを挿入し、コンテンツコントロールで選択されている項目を返す

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await ContentControls.Add({
    Type: 4,
  });

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const ContentControlListEntries = await ContentControl.
  DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロールに項目を追加します。
  await ContentControlListEntries.Add({
    Text: 'Text 1',
    Value: 'Value 1',
    Index: 1,
  });

  // ドロップダウンリスト コンテンツコントロールに別の項目を追加します。項目の Value パラメーターを指定しない場合、Value パラメーターは Text パラメーターと同じ値になります。
  await ContentControlListEntries.Add({
    Text: 'Text 2',
  });

  // ドロップダウンリスト コンテンツコントロールの最初の項目を選択します。
  await ContentControlListEntries.Item(1).Select();

  // 項目に関する情報を返します。
  const SelectedItem = await DropdownListEntries.GetSelectedItem();
  console.log(SelectedItem);
}

既存のドロップダウンリストコンテンツコントロールで選択されている項目を返す

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await WPSOpenApi.Application.ActiveDocument.ContentControls.Add({
    Type: 4,
  });

  // ドキュメント内のコンテンツコントロールの数 (テキスト コンテンツコントロールとドロップダウンリスト コンテンツコントロールを含む) を返します。
  // 挿入後にコンテンツコントロールの数が 2 である場合 (コンソールに出力されるカウント結果は 2)、新しいコンテンツコントロールのインデックスは 2 です。
  const count = await WPSOpenApi.Application.ActiveDocument.ContentControls.Count;
  console.log(count); 

  // ドロップダウンリスト内のすべての項目を返します。
  const ContentControlListEntries = await WPSOpenApi.Application.ActiveDocument.ContentControls.Item(2).DropdownListEntries;

  // ドロップダウンリストの最初の項目を返します。
  const DropdownListEntry1 = await ContentControlListEntries.Item(1);

  // 最初の項目を選択します。
  await DropdownListEntry1.Select();

  // 項目に関する情報を返します。
  const SelectedItem = await DropdownListEntries.GetSelectedItem();
  console.log(SelectedItem);
}

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.UnSelect()

ドロップダウンリストコンテンツコントロール内の項目をクリアします。

重要

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

構文
expression.ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Clear()
expression: アプリケーションオブジェクト。

例

ドロップダウンリストコンテンツコントロールを挿入し、コンテンツコントロール内の項目をクリアする

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await ContentControls.Add({
    Type: 4,
  });

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const ContentControlListEntries = await ContentControl.
  DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロールに項目を追加します。
  await ContentControlListEntries.Add({
    Text: 'Text 1',
    Value: 'Value 1',
    Index: 1,
  });

  // ドロップダウンリスト コンテンツコントロールに別の項目を追加します。項目の Value パラメーターを指定しない場合、Value パラメーターは Text パラメーターと同じ値になります。
  await ContentControlListEntries.Add({
    Text: 'Text 2',
  });

  // ドロップダウンリスト コンテンツコントロールの最初の項目を選択します。
  await ContentControlListEntries.Item(1).Select();

  // 3,000 ミリ秒後に項目をクリアします。
  setTimeout(async () => {
    await ContentControlListEntries.UnSelect();
  }, 3000);
}

既存のドロップダウンリストコンテンツコントロール内の項目をクリアする

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await WPSOpenApi.Application.ActiveDocument.ContentControls.Add({
    Type: 4,
  });

  // ドキュメント内のコンテンツコントロールの数 (テキスト コンテンツコントロールとドロップダウンリスト コンテンツコントロールを含む) を返します。
  // 挿入後にコンテンツコントロールの数が 2 である場合 (コンソールに出力されるカウント結果は 2)、新しいコンテンツコントロールのインデックスは 2 です。
  const count = await WPSOpenApi.Application.ActiveDocument.ContentControls.Count;
  console.log(count);

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const DropdownListEntries = await WPSOpenApi.Application.ActiveDocument.ContentControls.Item(2).DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロールの最初の項目を返します。
  const DropdownListEntry1 = await DropdownListEntries.Item(1);

  // 最初の項目を選択します。
  await DropdownListEntry1.Select();

  // 3,000 ミリ秒後に項目をクリアします。
  setTimeout(async () => {
    await ContentControlListEntries.UnSelect();
  }, 3000);
}

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Item()

項目コレクション内の項目を返します。

重要

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

構文
expression.ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Item(Index)
expression: アプリケーションオブジェクト。
パラメーター
パラメーター
データ型
必須
説明
Index
Number
はい
返す項目のインデックス番号。

例

ドロップダウンリストコンテンツコントロールを挿入し、コンテンツコントロール内の項目を返す

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

  const app = instance.Application;
  
  // すべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // 1. ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await ContentControls.Add({
    Type: 4,
  });

  // 2. ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const ContentControlListEntries = await ContentControl.
  DropdownListEntries;

  // 3. コンテンツコントロールに項目を追加します。
  await ContentControlListEntries.Add({
    Text: 'Text 1',
    Value: 'Value 1',
    Index: 1,
  });

  // 3. コンテンツコントロールに別の項目を追加します。 Value パラメーターと Index パラメーターはオプションです。 Value パラメーターを指定しないでおくと、Value パラメーターは Text パラメーターと同じ値になります。 Index を空のままにすると、コンテンツコントロールは末尾に追加されます。
  await ContentControlListEntries.Add({
    Text: 'Text 2',
  });

  // 4. 最初の項目を返します。
  const ContentControlListEntry1 = await ContentControl.DropdownListEntries.Item(1);
}

既存のコンテンツコントロール内の項目を返す

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

  const app = instance.Application;
  
  // すべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // 1. ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await app.ActiveDocument.ContentControls.Add({
    Type: 4,
  });

  // 2. コンテンツコントロールに項目を追加します。
  await ContentControl.DropdownListEntries.Add({
    Text: 'Text 1',
    Value: 'Value 1',
    Index: 1,
  });

  // 2. コンテンツコントロールに別の項目を追加します。 Value パラメーターと Index パラメーターはオプションです。 Value パラメーターを指定しないでおくと、Value パラメーターは Text パラメーターと同じ値になります。 Index を空のままにすると、コンテンツコントロールは末尾に追加されます。
  await ContentControl.DropdownListEntries.Add({
    Text: 'Text 2',
  });

  // 3. ドキュメント内のコンテンツコントロールの数 (テキスト コンテンツコントロールとドロップダウン コンテンツコントロールを含む) を返します。
  const counts = await app.ActiveDocument.ContentControls.Count;
  console.log(counts); // ドキュメント内のコンテンツコントロールの数が 2 である場合 (コンソールに出力されるカウント結果は 2)、新しいコンテンツコントロールのインデックスは 2 です。

  // 4. 最初のドロップダウン コンテンツコントロール内の項目を返します。
  const DropdownListEntries = await app.ActiveDocument.ContentControls.Item(1).DropdownListEntries;

  // 5. ドロップダウンリスト コンテンツコントロールの最初の項目 (Text 1) を返します。
  const 
  DropdownListEntry1 = await DropdownListEntries.Item(1);
}

プロパティ

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Count

ドロップダウンリストコンテンツコントロール内の項目の総数を返します。

重要

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

構文
expression.ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Count
expression: アプリケーションオブジェクト。

例

ドロップダウンリストコンテンツコントロールを挿入し、コンテンツコントロール内の項目の総数を返す

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await ContentControls.Add({
    Type: 4,
  });

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const ContentControlListEntries = await ContentControl.
  DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロールに項目を追加します。
  await ContentControlListEntries.Add({
    Text: 'Text 1',
    Value: 'Value 1',
    Index: 1,
  });

  // ドロップダウンリスト コンテンツコントロールに項目を追加します。 Value パラメーターと Index パラメーターはオプションです。 Value パラメーターを指定しないでおくと、Value パラメーターは Text パラメーターと同じ値になります。 Index を空のままにすると、コンテンツコントロールは末尾に追加されます。
  await ContentControlListEntries.Add({
    Text: 'Text 2',
  });

  // ドロップダウンリスト コンテンツコントロール内の項目の総数を返します。
  const Count = await ContentControlListEntries.Count;
  console.log(Count);
}

既存のドロップダウンリストコンテンツコントロール内の項目の総数を返す

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await ContentControls.Add({
    Type: 4,
  });

  // ドキュメント内のコンテンツコントロールの数 (テキスト コンテンツコントロールとドロップダウンリスト コンテンツコントロールを含む) を返します。
  // 挿入後にコンテンツコントロールの数が 2 である場合 (コンソールに出力されるカウント結果は 2)、新しいコンテンツコントロールのインデックスは 2 です。
  const Count = await WPSOpenApi.Application.ActiveDocument.ContentControls.Count;

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const ContentControlListEntries = await WPSOpenApi.Application.ActiveDocument.ContentControls.Item(Count).DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロール内の項目の総数を返します。
  const Count = await ContentControlListEntries.Count;
  console.log(Count);
}

ContentControlListEntry

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Item()

ドロップダウンリストコンテンツコントロール内の項目を返します。

重要

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

構文
expression.ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Item(Index)
expression: アプリケーションオブジェクト。
パラメーター
パラメーター
データ型
必須
説明
Index
Number
はい
返す項目のインデックス番号。

例

ドロップダウンリストコンテンツコントロールを挿入し、コンテンツコントロール内の項目を返す

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await ContentControls.Add({
    Type: 4,
  });

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const ContentControlListEntries = await ContentControl.
  DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロールに項目を追加します。
  await ContentControlListEntries.Add({
    Text: 'Text 1',
    Value: 'Value 1',
    Index: 1,
  });

  // ドロップダウンリスト コンテンツコントロールに別の項目を追加します。 Value パラメーターと Index パラメーターはオプションです。 Value パラメーターを指定しないでおくと、Value パラメーターは Text パラメーターと同じ値になります。
  await ContentControlListEntries.Add({
    Text: 'Text 2',
  });

  // ドロップダウンリスト コンテンツコントロールの最初の項目を返します。
  const ContentControlListEntry1 = await ContentControlListEntries.Item(1);
}

既存のドロップダウンリストコンテンツコントロール内の項目を返す

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await WPSOpenApi.Application.ActiveDocument.ContentControls.Add({
    Type: 4,
  });

  // ドキュメント内のコンテンツコントロールの数 (テキスト コンテンツコントロールとドロップダウンリスト コンテンツコントロールを含む) を返します。
  // 挿入後にコンテンツコントロールの数が 2 である場合 (コンソールに出力されるカウント結果は 2)、新しいコンテンツコントロールのインデックスは 2 です。
  const count = await WPSOpenApi.Application.ActiveDocument.ContentControls.Count;
  console.log(count);

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const DropdownListEntries = await WPSOpenApi.Application.ActiveDocument.ContentControls.Item(2).DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロールの最初の項目を返します。
  const DropdownListEntry1 = await DropdownListEntries.Item(1);
}

メソッド

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Item(Index).Delete()

ドロップダウンリストまたはコンボボックスコンテンツコントロールから項目を削除します。

重要

JS-SDK V1.1.15 以降でのみ、この機能がサポートされています。
コンテンツコントロールから項目を削除するためにメソッドを呼び出す場合、コンテンツコントロールには少なくとも 1 つの項目が残ります。

構文
expression.ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Item(Index).Delete()
expression: アプリケーションオブジェクト。

例

ドロップダウンリストコンテンツコントロールを挿入し、コンテンツコントロールから項目を削除する

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await ContentControls.Add({
    Type: 4,
  });

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const ContentControlListEntries = await ContentControl.
  DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロールに項目を追加します。
  await ContentControlListEntries.Add({
    Text: 'Text 1',
    Value: 'Value 1',
    Index: 1,
  });

  // ドロップダウンリスト コンテンツコントロールに別の項目を追加します。項目の Value パラメーターを指定しない場合、Value パラメーターは Text パラメーターと同じ値になります。
  await ContentControlListEntries.Add({
    Text: 'Text 2',
  });

  // ドロップダウンリスト コンテンツコントロールの最初の項目を選択します。
  await ContentControlListEntries.Item(1).Select();

  // 項目を削除します。
  await ContentControlListEntries.Item(1).Delete();
}

既存のドロップダウンリストコンテンツコントロールから項目を削除する

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await WPSOpenApi.Application.ActiveDocument.ContentControls.Add({
    Type: 4,
  });

  // ドキュメント内のコンテンツコントロールの数 (テキスト コンテンツコントロールとドロップダウンリスト コンテンツコントロールを含む) を返します。
  // 挿入後にコンテンツコントロールの数が 2 である場合 (コンソールに出力されるカウント結果は 2)、新しいコンテンツコントロールのインデックスは 2 です。
  const count = await WPSOpenApi.Application.ActiveDocument.ContentControls.Count;
  console.log(count);

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const DropdownListEntries = await WPSOpenApi.Application.ActiveDocument.ContentControls.Item(2).DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロールの最初の項目を返します。
  const DropdownListEntry1 = await DropdownListEntries.Item(1);

  // 最初の項目を選択します。
  await DropdownListEntry1.Select();

  // 項目を削除します。
  await DropdownListEntry1.Delete();
}

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Item(Index).Select()

ドロップダウンリストまたはコンボボックスコンテンツコントロール内の項目を選択します。

重要

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

構文
expression.ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Item(Index).Select()
expression: アプリケーションオブジェクト。

例

ドロップダウンリストコンテンツコントロールを挿入し、コンテンツコントロール内の項目を選択する

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await ContentControls.Add({
    Type: 4,
  });

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const ContentControlListEntries = await ContentControl.
  DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロールに項目を追加します。
  await ContentControlListEntries.Add({
    Text: 'Text 1',
    Value: 'Value 1',
    Index: 1,
  });

  // ドロップダウンリスト コンテンツコントロールに別の項目を追加します。項目の Value パラメーターを指定しない場合、Value パラメーターは Text パラメーターと同じ値になります。
  await ContentControlListEntries.Add({
    Text: 'Text 2',
  });

  // ドロップダウンリスト コンテンツコントロールの最初の項目を選択します。
  await ContentControlListEntries.Item(1).Select();
}

既存のドロップダウンリストコンテンツコントロール内の項目を選択する

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await WPSOpenApi.Application.ActiveDocument.ContentControls.Add({
    Type: 4,
  });

  // ドキュメント内のコンテンツコントロールの数 (テキスト コンテンツコントロールとドロップダウンリスト コンテンツコントロールを含む) を返します。
  // 挿入後にコンテンツコントロールの数が 2 である場合 (コンソールに出力されるカウント結果は 2)、新しいコンテンツコントロールのインデックスは 2 です。
  const count = await WPSOpenApi.Application.ActiveDocument.ContentControls.Count;
  console.log(count);

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const DropdownListEntries = await WPSOpenApi.Application.ActiveDocument.ContentControls.Item(2).DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロールの最初の項目を返します。
  const DropdownListEntry1 = await DropdownListEntries.Item(1);

  // 最初の項目を選択します。
  await DropdownListEntry1.Select();
}

プロパティ

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Item(Index).Text

ドロップダウンリストまたはコンボボックスコンテンツコントロール内の項目の表示テキストを設定または返します。

重要

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

構文
expression.ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Item(Index).Text
expression: アプリケーションオブジェクト。

例

ドロップダウンリストコンテンツコントロールを挿入し、コンテンツコントロール内の項目の表示テキストを返す

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await ContentControls.Add({
    Type: 4,
  });

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const ContentControlListEntries = await ContentControl.
  DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロールに項目を追加します。
  await ContentControlListEntries.Add({
    Text: 'Text 1',
    Value: 'Value 1',
    Index: 1,
  });

  // ドロップダウンリスト コンテンツコントロールに別の項目を追加します。項目の Value パラメーターを指定しない場合、Value パラメーターは Text パラメーターと同じ値になります。
  await ContentControlListEntries.Add({
    Text: 'Text 2',
  });

  // ドロップダウンリスト コンテンツコントロールの最初の項目の表示テキストを返します。
  const Text = await ContentControlListEntries.Item(1).Text;
  console.log(Text);
}

既存のドロップダウンリストコンテンツコントロール内の項目の表示テキストを返す

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await WPSOpenApi.Application.ActiveDocument.ContentControls.Add({
    Type: 4,
  });

  // ドキュメント内のコンテンツコントロールの数 (テキスト コンテンツコントロールとドロップダウンリスト コンテンツコントロールを含む) を返します。
  // 挿入後にコンテンツコントロールの数が 2 である場合 (コンソールに出力されるカウント結果は 2)、新しいコンテンツコントロールのインデックスは 2 です。
  const count = await WPSOpenApi.Application.ActiveDocument.ContentControls.Count;
  console.log(count);

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const DropdownListEntries = await WPSOpenApi.Application.ActiveDocument.ContentControls.Item(2).DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロールの最初の項目を返します。
  const DropdownListEntry1 = await DropdownListEntries.Item(1);

  // 項目の表示テキストを返します。
  const Text = await DropdownListEntry1.Text;
  console.log(Text);
}

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Item(Index).Value

ドロップダウンリストまたはコンボボックスコンテンツコントロール内の項目の値を返します。

重要

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

構文
expression.ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Item(Index).Value
expression: アプリケーションオブジェクト。

例

ドロップダウンリストコンテンツコントロールを挿入し、ドロップダウンリストコンテンツコントロール内の項目の値を返す

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await ContentControls.Add({
    Type: 4,
  });

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const ContentControlListEntries = await ContentControl.
  DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロールに項目を追加します。
  await ContentControlListEntries.Add({
    Text: 'Text 1',
    Value: 'Value 1',
    Index: 1,
  });

  // ドロップダウンリスト コンテンツコントロールに別の項目を追加します。項目の Value パラメーターを指定しない場合、Value パラメーターは Text パラメーターと同じ値になります。
  await ContentControlListEntries.Add({
    Text: 'Text 2',
  });

  // ドロップダウンリスト コンテンツコントロールの最初の項目の値を返します。
   const Value = await ContentControlListEntries.Item(1).Value;
  console.log(Value);
}

既存のドロップダウンリストコンテンツコントロール内の項目の値を返す

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

  const app = instance.Application;
  
  // アクティブなドキュメント内のすべてのコンテンツコントロールを返します。
  const ContentControls = await app.ActiveDocument.ContentControls;

  // ドロップダウンリスト コンテンツコントロールを挿入します。
  const ContentControl = await WPSOpenApi.Application.ActiveDocument.ContentControls.Add({
    Type: 4,
  });

  // ドロップダウンリスト コンテンツコントロールに項目を追加します。
  await ContentControlListEntries.Add({
    Text: 'Text 1',
    Value: 'Value 1',
    Index: 1,
  });

  // ドロップダウンリスト コンテンツコントロールに別の項目を追加します。項目の Value パラメーターを指定しない場合、Value パラメーターは Text パラメーターと同じ値になります。
  await ContentControlListEntries.Add({
    Text: 'Text 2',
  });

  // ドキュメント内のコンテンツコントロールの数 (テキスト コンテンツコントロールとドロップダウンリスト コンテンツコントロールを含む) を返します。
  // 挿入後にコンテンツコントロールの数が 2 である場合 (コンソールに出力されるカウント結果は 2)、新しいコンテンツコントロールのインデックスは 2 です。
  const count = await WPSOpenApi.Application.ActiveDocument.ContentControls.Count;
  console.log(count);

  // ドロップダウンリスト コンテンツコントロール内のすべての項目を返します。
  const DropdownListEntries = await WPSOpenApi.Application.ActiveDocument.ContentControls.Item(2).DropdownListEntries;

  // ドロップダウンリスト コンテンツコントロールの最初の項目を返します。
  const DropdownListEntry1 = await DropdownListEntries.Item(1);

  // 項目の値を返します。
  const Value = await DropdownListEntry1.Value;
  console.log(Value);
}

ContentControls

ActiveDocument.ContentControls

メソッド

ActiveDocument.ContentControls.Add()

ActiveDocument.ContentControls.Item()

ActiveDocument.ContentControls.SetItemsContent()

プロパティ

ActiveDocument.ContentControls.Count

ContentControl

ActiveDocument.ContentControls.Item(Index)

ActiveDocument.ContentControls.Item(Index).SetPlaceholderText()

プロパティ

ActiveDocument.ContentControls.Item(Index).PlaceholderText

ActiveDocument.ContentControls.Item(Index).Range

ActiveDocument.ContentControls.Item(Index).Tag

ActiveDocument.ContentControls.Item(Index).Title

ContentControlListEntries

ActiveDocument.ContentControls.Item(Index).DropdownListEntries

メソッド

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Add()

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Clear()

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.GetSelectedItem()

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.UnSelect()

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Item()

プロパティ

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Count

ContentControlListEntry

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Item()

メソッド

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Item(Index).Delete()

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Item(Index).Select()

プロパティ

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Item(Index).Text

ActiveDocument.ContentControls.Item(Index).DropdownListEntries.Item(Index).Value