Word.ContentControlOptions interface

パッケージ:

word

どのコンテンツ コントロールを返すかを定義するオプションを指定します。

注釈

API セット: WordAPI 1.5

使用元

• Word.本文: getContentControls
• Word.ContentControl: getContentControls
• Word.ドキュメント: getContentControls
• Word.DocumentCreated: getContentControls
• Word.段落: getContentControls
• Word.範囲: getContentControls

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-checkbox-content-control.yaml

// Toggles the isChecked property of the first checkbox content control found in the selection.
await Word.run(async (context) => {
  const selectedRange: Word.Range = context.document.getSelection();
  let selectedContentControl = selectedRange
    .getContentControls({
      types: [Word.ContentControlType.checkBox]
    })
    .getFirstOrNullObject();
  selectedContentControl.load("id,checkboxContentControl/isChecked");

  await context.sync();

  if (selectedContentControl.isNullObject) {
    const parentContentControl: Word.ContentControl = selectedRange.parentContentControl;
    parentContentControl.load("id,type,checkboxContentControl/isChecked");
    await context.sync();

    if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.checkBox) {
      console.warn("No checkbox content control is currently selected.");
      return;
    } else {
      selectedContentControl = parentContentControl;
    }
  }

  const isCheckedBefore = selectedContentControl.checkboxContentControl.isChecked;
  console.log("isChecked state before:", `id: ${selectedContentControl.id} ... isChecked: ${isCheckedBefore}`);
  selectedContentControl.checkboxContentControl.isChecked = !isCheckedBefore;
  selectedContentControl.load("id,checkboxContentControl/isChecked");
  await context.sync();

  console.log(
    "isChecked state after:",
    `id: ${selectedContentControl.id} ... isChecked: ${selectedContentControl.checkboxContentControl.isChecked}`
  );
});

プロパティ

types

コンテンツ コントロールの種類の配列。項目は、 richText、 plainText、 checkBox、 dropDownList、 comboBox、 buildingBlockGallery、 datePicker、 repeatingSection、 picture、または group である必要があります。

プロパティの詳細

types

コンテンツ コントロールの種類の配列。項目は、 richText、 plainText、 checkBox、 dropDownList、 comboBox、 buildingBlockGallery、 datePicker、 repeatingSection、 picture、または group である必要があります。

types: Word.ContentControlType[];

プロパティ値

Word.ContentControlType[]

注釈

API セット: WordAPI 1.5

注: plainText サポートは WordApi 1.5 で追加されました。 checkBox サポートは WordApi 1.7 で追加されました。 dropDownList comboBoxサポートは WordApi 1.9 で追加されました。 buildingBlockGallery 、datePicker、group、picture、repeatingSection のサポートは、WordApiDesktop 1.3 で追加されました。