Word. Content Control class

例

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;

    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to load the properties on the first content control.
        contentControls.items[0].load(  'appearance,' +
                                        'cannotDelete,' +
                                        'cannotEdit,' +
                                        'color,' +
                                        'id,' +
                                        'placeHolderText,' +
                                        'removeWhenEdited,' +
                                        'title,' +
                                        'text,' +
                                        'type,' +
                                        'style,' +
                                        'tag,' +
                                        'font/size,' +
                                        'font/name,' +
                                        'font/color');

        // Synchronize the document state by executing the queued commands,
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Property values of the first content control:' +
            '   ----- appearance: ' + contentControls.items[0].appearance +
            '   ----- cannotDelete: ' + contentControls.items[0].cannotDelete +
            '   ----- cannotEdit: ' + contentControls.items[0].cannotEdit +
            '   ----- color: ' + contentControls.items[0].color +
            '   ----- id: ' + contentControls.items[0].id +
            '   ----- placeHolderText: ' + contentControls.items[0].placeholderText +
            '   ----- removeWhenEdited: ' + contentControls.items[0].removeWhenEdited +
            '   ----- title: ' + contentControls.items[0].title +
            '   ----- text: ' + contentControls.items[0].text +
            '   ----- type: ' + contentControls.items[0].type +
            '   ----- style: ' + contentControls.items[0].style +
            '   ----- tag: ' + contentControls.items[0].tag +
            '   ----- font size: ' + contentControls.items[0].font.size +
            '   ----- font name: ' + contentControls.items[0].font.name +
            '   ----- font color: ' + contentControls.items[0].font.color);
    }
});

プロパティ

appearance	コンテンツコントロールの外観を指定します。値には、'BoundingBox'、'Tags'、または 'Hidden' を指定できます。
cannotDelete	ユーザーがコンテンツコントロールを削除できるかどうかを示す値を指定します。 removeWhenEdited と同時に使用することはできません。
cannotEdit	ユーザーがコンテンツコントロールの内容を編集できるかどうかを示す値を指定します。
checkboxContentControl	コンテンツコントロールの種類が 'CheckBox' の場合は、チェックボックスに関連するデータを指定します。それ以外の場合は null です。
color	コンテンツコントロールの色を指定します。色は、'#RRGGBB' 形式で指定するか、色名を使用して指定します。
contentControls	コンテンツコントロールのコンテンツコントロールオブジェクトのコレクションを取得します。
context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
dropDownListContentControl	コンテンツコントロールの種類が 'DropDownList' の場合は、ドロップダウンリストに関連するデータを指定します。それ以外の場合は null です。
endnotes	コンテンツコントロール内の文末脚注のコレクションを取得します。
fields	コンテンツコントロール内のフィールドオブジェクトのコレクションを取得します。
font	コンテンツコントロールのテキストの書式設定を取得します。これを使用して、フォント名、サイズ、色、およびその他のプロパティを取得および設定します。
footnotes	コンテンツコントロール内の脚注のコレクションを取得します。
id	コンテンツコントロールの識別子を表す整数値を取得します。
inlinePictures	コンテンツコントロール内の InlinePicture オブジェクトのコレクションを取得します。コレクションにはフローティングイメージは含まれません。
lists	コンテンツコントロールに含まれるリストオブジェクトのコレクションを取得します。
paragraphs	コンテンツコントロール内の段落オブジェクトのコレクションを取得します。
parentBody	コンテンツコントロールの親の本文を取得します。
parentContentControl	コンテンツコントロールを含むコンテンツコントロールを取得します。 `ItemNotFound`親コンテンツコントロールがない場合は、エラーをスローします。
parentContentControlOrNullObject	コンテンツコントロールを含むコンテンツコントロールを取得します。親コンテンツコントロールがない場合、このメソッドはプロパティがに設定されたオブジェクトを`isNullObjecttrue`返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
parentTable	コンテンツコントロールを含むテーブルを取得します。テーブルに `ItemNotFound` 含まれていない場合は、エラーをスローします。
parentTableCell	コンテンツコントロールを含むテーブルセルを取得します。テーブルセルに `ItemNotFound` 含まれていない場合は、エラーをスローします。
parentTableCellOrNullObject	コンテンツコントロールを含むテーブルセルを取得します。テーブルセルに含まれていない場合、このメソッドはプロパティがに設定されたオブジェクトを`isNullObjecttrue`返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
parentTableOrNullObject	コンテンツコントロールを含むテーブルを取得します。テーブルに含まれていない場合、このメソッドはプロパティがに設定されたオブジェクトを`isNullObjecttrue`返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
placeholderText	コンテンツコントロールのプレースホルダーテキストを指定します。コンテンツコントロールが空の場合は、淡色のテキストが表示されます。注: このプロパティの設定操作は、web 上のWordではサポートされていません。
removeWhenEdited	コンテンツコントロールが編集後に削除されるかどうかを示す値を指定します。 cannotDelete と同時に使用することはできません。
style	コンテンツコントロールのスタイル名を指定します。カスタムスタイルとローカライズされたスタイルの名前には、このプロパティを使用します。ロケール間で移植可能な組み込みスタイルを使用するには、"styleBuiltIn" プロパティを参照してください。
styleBuiltIn	コンテンツコントロールの組み込みスタイル名を指定します。ロケール間で移植可能な組み込みスタイルの場合は、このプロパティを使用します。カスタムスタイルまたはローカライズされたスタイルの名前を使用するには、"style" プロパティを参照してください。
subtype	コンテンツコントロールのサブタイプを取得します。サブタイプは、リッチテキストコンテンツコントロールの場合は 'RichTextInline'、'RichTextParagraphs'、'RichTextTableCell'、リッチテキストコンテンツコントロールの場合は 'RichTextTableRow'、'RichTextTable'、プレーンテキストコンテンツコントロールの場合は 'PlainTextInline' と 'PlainTextParagraph'、チェックボックスコンテンツコントロールの場合は 'CheckBox' です。
tables	コンテンツコントロールに含まれるテーブルオブジェクトのコレクションを取得します。
tag	コンテンツコントロールを識別するタグを指定します。
text	コンテンツコントロールのテキストを取得します。
title	コンテンツコントロールのタイトルを指定します。
type	コンテンツコントロールの種類を取得します。現在サポートされているのは、リッチテキスト、プレーンテキスト、チェックボックスコンテンツコントロールのみです。

メソッド

clear()	コンテンツコントロールの内容をクリアします。ユーザーは、消去された内容を元に戻す操作を実行できます。
delete(keepContent)	コンテンツコントロールとそのコンテンツを削除します。が true に設定されている場合 `keepContent` 、コンテンツは削除されません。
getComments()	コンテンツコントロールに関連付けられているコメントを取得します。
getContentControls(options)	このコンテンツコントロールで現在サポートされている子コンテンツコントロールを取得します。
getHtml()	コンテンツコントロールオブジェクトの HTML 表現を取得します。 Web ページまたは HTML ビューアーでレンダリングされた場合、書式設定は、ドキュメントの書式設定と完全に一致しませんが、近い形式になります。このメソッドは、異なるプラットフォーム (Windows、Mac、web 上のWordなど) 上の同じドキュメントに対してまったく同じ HTML を返しません。正確な忠実性、またはプラットフォーム間の整合性が必要な場合は、返された XML を使用 `ContentControl.getOoxml()` して HTML に変換します。
getOoxml()	コンテンツコントロールオブジェクトの Office Open XML (OOXML) 表記を取得します。
getRange(rangeLocation)	範囲として、コンテンツコントロール全体、あるいはコンテンツコントロールの開始点または終了点を取得します。
getReviewedText(changeTrackingVersion)	ChangeTrackingVersion の選択に基づいて、レビューされたテキストを取得します。
getReviewedText(changeTrackingVersionString)	ChangeTrackingVersion の選択に基づいて、レビューされたテキストを取得します。
getTextRanges(endingMarks, trimSpacing)	句読点やその他の終了記号を使用して、コンテンツコントロール内のテキスト範囲を取得します。
getTrackedChanges()	コンテンツコントロール内の TrackedChange オブジェクトのコレクションを取得します。
insertBreak(breakType, insertLocation)	メイン文書の指定した位置に、区切りを挿入します。このメソッドは、'RichTextTable'、'RichTextTableRow' および 'RichTextTableCell' コンテンツコントロールでは使用できません。
insertFileFromBase64(base64File, insertLocation)	指定した場所にあるコンテンツコントロールにドキュメントを挿入します。
insertHtml(html, insertLocation)	コンテンツコントロール内の指定された位置に HTML を挿入します。
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)	コンテンツコントロール内の指定された位置にインライン画像を挿入します。
insertOoxml(ooxml, insertLocation)	指定した場所にあるコンテンツコントロールに OOXML を挿入します。
insertParagraph(paragraphText, insertLocation)	指定した位置に、段落を挿入します。
insertTable(rowCount, columnCount, insertLocation, values)	指定した数の行と列を含むテーブルを、コンテンツコントロール内またはコンテンツコントロールの横に挿入します。
insertText(text, insertLocation)	コンテンツコントロール内の指定された位置にテキストを挿入します。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
resetState()	コンテンツコントロールの状態をリセットします。
search(searchText, searchOptions)	コンテンツコントロールオブジェクトのスコープで、指定した SearchOptions を使用して検索を実行します。検索結果は、範囲オブジェクトのコレクションです。
select(selectionMode)	コンテンツコントロールを選択します。その結果、Word は選択範囲にスクロールされます。
select(selectionModeString)	コンテンツコントロールを選択します。その結果、Word は選択範囲にスクロールされます。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
setState(contentControlState)	コンテンツコントロールの状態を設定します。
setState(contentControlStateString)	コンテンツコントロールの状態を設定します。
split(delimiters, multiParagraphs, trimDelimiters, trimSpacing)	区切り記号を使用して、コンテンツコントロールを子の範囲に分割します。
toJSON()	API オブジェクトがに渡されたときにより便利な出力を提供するために、JavaScript `toJSON()` メソッドを `JSON.stringify()`オーバーライドします。 (`JSON.stringify`さらに、渡されるオブジェクトのメソッドを呼び出`toJSON`します)。一方、元のWord。ContentControl オブジェクトは API オブジェクトです。メソッドは、元の`toJSON`オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として`Word.Interfaces.ContentControlData`型指定) を返します。
track()	ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。この呼び出しは、context.trackedObjects.add(thisObject)の短縮形です。このオブジェクトを呼び出しで `.sync` 使用していて、".run" バッチのシーケンシャル実行の外部で使用していて、プロパティを設定するとき、またはオブジェクトのメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに追跡対象のオブジェクトコレクションにオブジェクトを追加する必要があります。このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
untrack()	前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。この呼び出しは、context.trackedObjects.remove(thisObject)の短縮形です。追跡対象オブジェクトが多いとホストアプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。メモリ解放が有効になる前にを呼び出す `context.sync()` 必要があります。

イベント

onCommentAdded	新しいコメントが追加されたときに発生します。
onCommentChanged	コメントまたはその応答が変更されたときに発生します。
onCommentDeselected	コメントの選択が解除されたときに発生します。
onCommentSelected	コメントが選択されたときに発生します。
onDataChanged	コンテンツコントロール内のデータが変更されたときに発生します。新しいテキストを取得するには、ハンドラーでこのコンテンツコントロールを読み込みます。古いテキストを取得するには、読み込みしないでください。
onDeleted	コンテンツコントロールが削除されたときに発生します。このコンテンツコントロールをハンドラーに読み込まないと、元のプロパティを取得できなくなります。
onEntered	コンテンツコントロールが入力されたときに発生します。
onExited	コンテンツコントロールが終了すると、たとえば、カーソルがコンテンツコントロールから離れたときに発生します。
onSelectionChanged	コンテンツコントロール内の選択が変更されたときに発生します。

プロパティの詳細

appearance

コンテンツコントロールの外観を指定します。値には、'BoundingBox'、'Tags'、または 'Hidden' を指定できます。

appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";

プロパティ値

Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"

注釈

cannotDelete

ユーザーがコンテンツコントロールを削除できるかどうかを示す値を指定します。 removeWhenEdited と同時に使用することはできません。

cannotDelete: boolean;

プロパティ値

boolean

注釈

cannotEdit

ユーザーがコンテンツコントロールの内容を編集できるかどうかを示す値を指定します。

cannotEdit: boolean;

プロパティ値

boolean

注釈

checkboxContentControl

コンテンツコントロールの種類が 'CheckBox' の場合は、チェックボックスに関連するデータを指定します。それ以外の場合は null です。

readonly checkboxContentControl: Word.CheckboxContentControl;

プロパティ値

Word.CheckboxContentControl

注釈

[ API セット: WordApi 1.7 ]

color

コンテンツコントロールの色を指定します。色は、'#RRGGBB' 形式で指定するか、色名を使用して指定します。

color: string;

プロパティ値

string

注釈

contentControls

コンテンツコントロールのコンテンツコントロールオブジェクトのコレクションを取得します。

readonly contentControls: Word.ContentControlCollection;

プロパティ値

Word.ContentControlCollection

注釈

context

オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Word.RequestContext

dropDownListContentControl

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

コンテンツコントロールの種類が 'DropDownList' の場合は、ドロップダウンリストに関連するデータを指定します。それ以外の場合は null です。

readonly dropDownListContentControl: Word.DropDownListContentControl;

プロパティ値

Word.DropDownListContentControl

注釈

endnotes

コンテンツコントロール内の文末脚注のコレクションを取得します。

readonly endnotes: Word.NoteItemCollection;

プロパティ値

Word.NoteItemCollection

注釈

fields

コンテンツコントロール内のフィールドオブジェクトのコレクションを取得します。

readonly fields: Word.FieldCollection;

プロパティ値

Word.FieldCollection

注釈

font

コンテンツコントロールのテキストの書式設定を取得します。これを使用して、フォント名、サイズ、色、およびその他のプロパティを取得および設定します。

readonly font: Word.Font;

プロパティ値

Word.Font

注釈

footnotes

コンテンツコントロール内の脚注のコレクションを取得します。

readonly footnotes: Word.NoteItemCollection;

プロパティ値

Word.NoteItemCollection

注釈

id

コンテンツコントロールの識別子を表す整数値を取得します。

readonly id: number;

プロパティ値

number

注釈

inlinePictures

コンテンツコントロール内の InlinePicture オブジェクトのコレクションを取得します。コレクションにはフローティングイメージは含まれません。

readonly inlinePictures: Word.InlinePictureCollection;

プロパティ値

Word.InlinePictureCollection

注釈

lists

コンテンツコントロールに含まれるリストオブジェクトのコレクションを取得します。

readonly lists: Word.ListCollection;

プロパティ値

Word.ListCollection

注釈

paragraphs

コンテンツコントロール内の段落オブジェクトのコレクションを取得します。

readonly paragraphs: Word.ParagraphCollection;

プロパティ値

Word.ParagraphCollection

注釈

重要: 要件セット 1.1 と 1.2 の場合、このコンテンツコントロールに完全に含まれるテーブル内の段落は返されません。要件セット 1.3 から、そのようなテーブル内の段落も返されます。

parentBody

コンテンツコントロールの親の本文を取得します。

readonly parentBody: Word.Body;

プロパティ値

Word.Body

注釈

parentContentControl

コンテンツコントロールを含むコンテンツコントロールを取得します。 ItemNotFound親コンテンツコントロールがない場合は、エラーをスローします。

readonly parentContentControl: Word.ContentControl;

プロパティ値

Word.ContentControl

注釈

parentContentControlOrNullObject

コンテンツコントロールを含むコンテンツコントロールを取得します。親コンテンツコントロールがない場合、このメソッドはプロパティがに設定されたオブジェクトをisNullObjecttrue返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

readonly parentContentControlOrNullObject: Word.ContentControl;

プロパティ値

Word.ContentControl

注釈

parentTable

コンテンツコントロールを含むテーブルを取得します。テーブルに ItemNotFound 含まれていない場合は、エラーをスローします。

readonly parentTable: Word.Table;

プロパティ値

Word.Table

注釈

parentTableCell

コンテンツコントロールを含むテーブルセルを取得します。テーブルセルに ItemNotFound 含まれていない場合は、エラーをスローします。

readonly parentTableCell: Word.TableCell;

プロパティ値

Word.TableCell

注釈

parentTableCellOrNullObject

コンテンツコントロールを含むテーブルセルを取得します。テーブルセルに含まれていない場合、このメソッドはプロパティがに設定されたオブジェクトをisNullObjecttrue返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

readonly parentTableCellOrNullObject: Word.TableCell;

プロパティ値

Word.TableCell

注釈

parentTableOrNullObject

コンテンツコントロールを含むテーブルを取得します。テーブルに含まれていない場合、このメソッドはプロパティがに設定されたオブジェクトをisNullObjecttrue返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

readonly parentTableOrNullObject: Word.Table;

プロパティ値

Word.Table

注釈

placeholderText

コンテンツコントロールのプレースホルダーテキストを指定します。コンテンツコントロールが空の場合は、淡色のテキストが表示されます。

注: このプロパティの設定操作は、web 上のWordではサポートされていません。

placeholderText: string;

プロパティ値

string

注釈

removeWhenEdited

コンテンツコントロールが編集後に削除されるかどうかを示す値を指定します。 cannotDelete と同時に使用することはできません。

removeWhenEdited: boolean;

プロパティ値

boolean

注釈

style

コンテンツコントロールのスタイル名を指定します。カスタムスタイルとローカライズされたスタイルの名前には、このプロパティを使用します。ロケール間で移植可能な組み込みスタイルを使用するには、"styleBuiltIn" プロパティを参照してください。

style: string;

プロパティ値

string

注釈

styleBuiltIn

コンテンツコントロールの組み込みスタイル名を指定します。ロケール間で移植可能な組み込みスタイルの場合は、このプロパティを使用します。カスタムスタイルまたはローカライズされたスタイルの名前を使用するには、"style" プロパティを参照してください。

styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";

プロパティ値

注釈

subtype

コンテンツコントロールのサブタイプを取得します。サブタイプは、リッチテキストコンテンツコントロールの場合は 'RichTextInline'、'RichTextParagraphs'、'RichTextTableCell'、リッチテキストコンテンツコントロールの場合は 'RichTextTableRow'、'RichTextTable'、プレーンテキストコンテンツコントロールの場合は 'PlainTextInline' と 'PlainTextParagraph'、チェックボックスコンテンツコントロールの場合は 'CheckBox' です。

readonly subtype: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText";

プロパティ値

注釈

tables

コンテンツコントロールに含まれるテーブルオブジェクトのコレクションを取得します。

readonly tables: Word.TableCollection;

プロパティ値

Word.TableCollection

注釈

tag

コンテンツコントロールを識別するタグを指定します。

tag: string;

プロパティ値

string

注釈

例

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

// Traverses each paragraph of the document and wraps a content control on each with either a even or odd tags.
await Word.run(async (context) => {
  let paragraphs = context.document.body.paragraphs;
  paragraphs.load("$none"); // Don't need any properties; just wrap each paragraph with a content control.

  await context.sync();

  for (let i = 0; i < paragraphs.items.length; i++) {
    let contentControl = paragraphs.items[i].insertContentControl();
    // For even, tag "even".
    if (i % 2 === 0) {
      contentControl.tag = "even";
    } else {
      contentControl.tag = "odd";
    }
  }
  console.log("Content controls inserted: " + paragraphs.items.length);

  await context.sync();
});

text

コンテンツコントロールのテキストを取得します。

readonly text: string;

プロパティ値

string

注釈

title

コンテンツコントロールのタイトルを指定します。

title: string;

プロパティ値

string

注釈

type

コンテンツコントロールの種類を取得します。現在サポートされているのは、リッチテキスト、プレーンテキスト、チェックボックスコンテンツコントロールのみです。

readonly type: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText";

プロパティ値

注釈

メソッドの詳細

clear()

コンテンツコントロールの内容をクリアします。ユーザーは、消去された内容を元に戻す操作を実行できます。

clear(): void;

戻り値

void

注釈

例

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the content controls collection.
    contentControls.load('text');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
        
    if (contentControls.items.length === 0) {
        console.log("There isn't a content control in this document.");
    } else {
        // Queue a command to clear the contents of the first content control.
        contentControls.items[0].clear();

        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Content control cleared of contents.');
    }
});

delete(keepContent)

コンテンツコントロールとそのコンテンツを削除します。が true に設定されている場合 keepContent 、コンテンツは削除されません。

delete(keepContent: boolean): void;

パラメーター

keepContent: boolean

必須です。コンテンツコントロールを使用してコンテンツを削除する必要があるかどうかを示します。が true に設定されている場合 keepContent 、コンテンツは削除されません。

戻り値

void

注釈

例

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the content controls collection.
    contentControls.load('text');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
        
    if (contentControls.items.length === 0) {
        console.log("There isn't a content control in this document.");
    } else {            
        // Queue a command to delete the first content control. 
        // The contents will remain in the document.
        contentControls.items[0].delete(true);

        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Content control cleared of contents.'); 
    }
});

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

await Word.run(async (context) => {
  const contentControls = context.document.contentControls.getByTag("forTesting");
  contentControls.load("items");
  await context.sync();

  if (contentControls.items.length === 0) {
    console.log("There are no content controls in this document.");
  } else {
    console.log("Control to be deleted:");
    console.log(contentControls.items[0]);
    contentControls.items[0].delete(false);
    await context.sync();
  }
});

getComments()

コンテンツコントロールに関連付けられているコメントを取得します。

getComments(): Word.CommentCollection;

戻り値

Word.CommentCollection

注釈

getContentControls(options)

このコンテンツコントロールで現在サポートされている子コンテンツコントロールを取得します。

getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;

パラメーター

options: Word.ContentControlOptions

省略可能です。返されるコンテンツコントロールを定義するオプション。

戻り値

Word.ContentControlCollection

注釈

重要: options パラメーターに特定の型が指定されている場合、サポートされている型のコンテンツコントロールのみが返されます。ジェネリック Wordのメソッドを使用すると、例外がスローされることに注意してください。特定の種類に関連しない ContentControl。時間によっては、追加の種類のコンテンツコントロールがサポートされる場合があります。そのため、アドインは特定の種類のコンテンツコントロールを要求して処理する必要があります。

getHtml()

コンテンツコントロールオブジェクトの HTML 表現を取得します。 Web ページまたは HTML ビューアーでレンダリングされた場合、書式設定は、ドキュメントの書式設定と完全に一致しませんが、近い形式になります。このメソッドは、異なるプラットフォーム (Windows、Mac、web 上のWordなど) 上の同じドキュメントに対してまったく同じ HTML を返しません。正確な忠実性、またはプラットフォーム間の整合性が必要な場合は、返された XML を使用 ContentControl.getOoxml() して HTML に変換します。

getHtml(): OfficeExtension.ClientResult<string>;

戻り値

注釈

例

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection that contains a specific tag.
    const contentControlsWithTag = context.document.contentControls.getByTag('Customer-Address');
    
    // Queue a command to load the tag property for all of content controls.
    contentControlsWithTag.load('tag');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControlsWithTag.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to get the HTML contents of the first content control.
        const html = contentControlsWithTag.items[0].getHtml();
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Content control HTML: ' + html.value);
    }
});

getOoxml()

コンテンツコントロールオブジェクトの Office Open XML (OOXML) 表記を取得します。

getOoxml(): OfficeExtension.ClientResult<string>;

戻り値

注釈

例

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to get the OOXML contents of the first content control.
        const ooxml = contentControls.items[0].getOoxml();
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Content control OOXML: ' + ooxml.value);
    }
});

getRange(rangeLocation)

範囲として、コンテンツコントロール全体、あるいはコンテンツコントロールの開始点または終了点を取得します。

getRange(rangeLocation?: Word.RangeLocation | "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;

パラメーター

rangeLocation: Word.RangeLocation | "Whole" | "Start" | "End" | "Before" | "After" | "Content"

省略可能です。範囲の場所は、'Whole'、'Start'、'End'、'Before'、'After'、または 'Content' である必要があります。

戻り値

Word.Range

注釈

getReviewedText(changeTrackingVersion)

ChangeTrackingVersion の選択に基づいて、レビューされたテキストを取得します。

getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;

パラメーター

changeTrackingVersion: Word.ChangeTrackingVersion

省略可能です。値は 'Original' または 'Current' である必要があります。既定値は 'Current' です。

戻り値

注釈

getReviewedText(changeTrackingVersionString)

ChangeTrackingVersion の選択に基づいて、レビューされたテキストを取得します。

getReviewedText(changeTrackingVersionString?: "Original" | "Current"): OfficeExtension.ClientResult<string>;

パラメーター

changeTrackingVersionString: "Original" | "Current"

省略可能です。値は 'Original' または 'Current' である必要があります。既定値は 'Current' です。

戻り値

注釈

getTextRanges(endingMarks, trimSpacing)

句読点やその他の終了記号を使用して、コンテンツコントロール内のテキスト範囲を取得します。

getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection;

パラメーター

endingMarks: string[]

必須です。句読点や他の終了記号を文字列の配列として指定します。

trimSpacing: boolean

省略可能です。範囲コレクションで返される範囲の先頭と末尾から間隔文字 (スペース、タブ、列区切り、段落の終了記号) をトリミングするかどうかを示します。既定値は false で、範囲の先頭と末尾の間隔文字が範囲コレクションに含まれることを示します。

戻り値

Word.RangeCollection

注釈

getTrackedChanges()

コンテンツコントロール内の TrackedChange オブジェクトのコレクションを取得します。

getTrackedChanges(): Word.TrackedChangeCollection;

戻り値

Word.TrackedChangeCollection

注釈

[ API セット: WordApi 1.6 ]

insertBreak(breakType, insertLocation)

メイン文書の指定した位置に、区切りを挿入します。このメソッドは、'RichTextTable'、'RichTextTableRow' および 'RichTextTableCell' コンテンツコントロールでは使用できません。

insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): void;

パラメーター

breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line"

必須です。中断の種類。

insertLocation: start | end | before | after | "Start" | "End" | "Before" | "After"

必須です。値は、'Start'、'End'、'Before'、または 'After' である必要があります。

戻り値

void

注釈

例

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of content controls.
    contentControls.load('id');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    // We now will have access to the content control collection.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to insert a page break after the first content control.
        contentControls.items[0].insertBreak(Word.BreakType.page, Word.InsertLocation.after);
        
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Inserted a page break after the first content control.');    
    }
});

insertFileFromBase64(base64File, insertLocation)

指定した場所にあるコンテンツコントロールにドキュメントを挿入します。

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

パラメーター

base64File: string

必須です。 .docx ファイルの Base64 でエンコードされたコンテンツ。

insertLocation: replace | start | end | "Replace" | "Start" | "End"

必須です。値は、'Replace'、'Start'、または 'End' である必要があります。 'Replace' は、'RichTextTable' および 'RichTextTableRow' コンテンツコントロールでは使用できません。

戻り値

Word.Range

注釈

注: 挿入するドキュメントに ActiveX コントロールが含まれている場合 (フォームフィールドの可能性があります)、挿入はサポートされません。このようなフォームフィールドを、シナリオに適したコンテンツコントロールまたはその他のオプションに置き換えることを検討してください。

insertHtml(html, insertLocation)

コンテンツコントロール内の指定された位置に HTML を挿入します。

insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

パラメーター

html: string

必須です。コンテンツコントロールに挿入する HTML。

insertLocation: replace | start | end | "Replace" | "Start" | "End"

戻り値

Word.Range

注釈

例

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to put HTML into the contents of the first content control.
        contentControls.items[0].insertHtml(
            '<strong>HTML content inserted into the content control.</strong>',
            'Start');
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Inserted HTML in the first content control.');
    }
});

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

コンテンツコントロール内の指定された位置にインライン画像を挿入します。

insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;

パラメーター

base64EncodedImage: string

必須です。コンテンツコントロールに挿入する Base64 でエンコードされたイメージ。

insertLocation: replace | start | end | "Replace" | "Start" | "End"

戻り値

Word.InlinePicture

注釈

[ API セット: WordApi 1.2 ]

insertOoxml(ooxml, insertLocation)

指定した場所にあるコンテンツコントロールに OOXML を挿入します。

insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

パラメーター

ooxml: string

必須です。コンテンツコントロールに挿入する OOXML。

insertLocation: replace | start | end | "Replace" | "Start" | "End"

戻り値

Word.Range

注釈

例

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to put OOXML into the contents of the first content control.
        contentControls.items[0].insertOoxml("<pkg:package xmlns:pkg='http://schemas.microsoft.com/office/2006/xmlPackage'><pkg:part pkg:name='/_rels/.rels' pkg:contentType='application/vnd.openxmlformats-package.relationships+xml' pkg:padding='512'><pkg:xmlData><Relationships xmlns='http://schemas.openxmlformats.org/package/2006/relationships'><Relationship Id='rId1' Type='http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument' Target='word/document.xml'/></Relationships></pkg:xmlData></pkg:part><pkg:part pkg:name='/word/document.xml' pkg:contentType='application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml'><pkg:xmlData><w:document xmlns:w='http://schemas.openxmlformats.org/wordprocessingml/2006/main' ><w:body><w:p><w:pPr><w:spacing w:before='360' w:after='0' w:line='480' w:lineRule='auto'/><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr></w:pPr><w:r><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr><w:t>This text has formatting directly applied to achieve its font size, color, line spacing, and paragraph spacing.</w:t></w:r></w:p></w:body></w:document></pkg:xmlData></pkg:part></pkg:package>", "End");
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Inserted OOXML in the first content control.');
    }
});  

// Read "Create better add-ins for Word with Office Open XML" for guidance on working with OOXML.
// https://learn.microsoft.com/office/dev/add-ins/word/create-better-add-ins-for-word-with-office-open-xml

insertParagraph(paragraphText, insertLocation)

指定した位置に、段落を挿入します。

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph;

パラメーター

paragraphText: string

必須です。挿入する段落テキスト。

insertLocation: start | end | before | after | "Start" | "End" | "Before" | "After"

必須です。値は、'Start'、'End'、'Before'、または 'After' である必要があります。 'Before' と 'After' は、'RichTextTable'、'RichTextTableRow' および 'RichTextTableCell' コンテンツコントロールでは使用できません。

戻り値

Word.Paragraph

注釈

例

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to insert a paragraph after the first content control.
        contentControls.items[0].insertParagraph('Text of the inserted paragraph.', 'After');
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Inserted a paragraph after the first content control.');
    }
});

insertTable(rowCount, columnCount, insertLocation, values)

指定した数の行と列を含むテーブルを、コンテンツコントロール内またはコンテンツコントロールの横に挿入します。

insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After", values?: string[][]): Word.Table;

パラメーター

rowCount: number

必須です。表の行数。

columnCount: number

必須です。表の列数。

insertLocation: start | end | before | after | "Start" | "End" | "Before" | "After"

values: string[][]

省略可能な 2 次元配列。対応する文字列が配列で指定されている場合、セルに設定されます。

戻り値

Word.Table

注釈

insertText(text, insertLocation)

コンテンツコントロール内の指定された位置にテキストを挿入します。

insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

パラメーター

text: string

必須です。コンテンツコントロールに挿入するテキスト。

insertLocation: replace | start | end | "Replace" | "Start" | "End"

戻り値

Word.Range

注釈

例

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to replace text in the first content control.
        contentControls.items[0].insertText('Replaced text in the first content control.', 'Replace');
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Replaced text in the first content control.');
    }
});  

// The Silly stories add-in sample shows how to use the insertText method.
// https://aka.ms/sillystorywordaddin

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Word.Interfaces.ContentControlLoadOptions): Word.ContentControl;

パラメーター

options: Word.Interfaces.ContentControlLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

Word.ContentControl

例

// Load all of the content control properties
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    } else {
        // Queue a command to load the properties on the first content control.
        contentControls.items[0].load(  'appearance,' +
                                        'cannotDelete,' +
                                        'cannotEdit,' +
                                        'id,' +
                                        'placeHolderText,' +
                                        'removeWhenEdited,' +
                                        'title,' +
                                        'text,' +
                                        'type,' +
                                        'style,' +
                                        'tag,' +
                                        'font/size,' +
                                        'font/name,' +
                                        'font/color');             
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Property values of the first content control:' + 
            '   ----- appearance: ' + contentControls.items[0].appearance + 
            '   ----- cannotDelete: ' + contentControls.items[0].cannotDelete +
            '   ----- cannotEdit: ' + contentControls.items[0].cannotEdit +
            '   ----- color: ' + contentControls.items[0].color +
            '   ----- id: ' + contentControls.items[0].id +
            '   ----- placeHolderText: ' + contentControls.items[0].placeholderText +
            '   ----- removeWhenEdited: ' + contentControls.items[0].removeWhenEdited +
            '   ----- title: ' + contentControls.items[0].title +
            '   ----- text: ' + contentControls.items[0].text +
            '   ----- type: ' + contentControls.items[0].type +
            '   ----- style: ' + contentControls.items[0].style +
            '   ----- tag: ' + contentControls.items[0].tag +
            '   ----- font size: ' + contentControls.items[0].font.size +
            '   ----- font name: ' + contentControls.items[0].font.name +
            '   ----- font color: ' + contentControls.items[0].font.color);
    }
});

load(propertyNames)

load(propertyNames?: string | string[]): Word.ContentControl;

パラメーター

propertyNames: string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Word.ContentControl

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.ContentControl;

パラメーター

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select は、読み込むプロパティを指定するコンマ区切り文字列で propertyNamesAndPaths.expand 、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。

戻り値

Word.ContentControl

resetState()

注意

コンテンツコントロールの状態をリセットします。

resetState(): void;

戻り値

void

注釈

search(searchText, searchOptions)

コンテンツコントロールオブジェクトのスコープで、指定した SearchOptions を使用して検索を実行します。検索結果は、範囲オブジェクトのコレクションです。

search(searchText: string, searchOptions?: Word.SearchOptions | {
            ignorePunct?: boolean;
            ignoreSpace?: boolean;
            matchCase?: boolean;
            matchPrefix?: boolean;
            matchSuffix?: boolean;
            matchWholeWord?: boolean;
            matchWildcards?: boolean;
        }): Word.RangeCollection;

パラメーター

searchText: string

必須です。検索テキスト。

searchOptions: Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }

省略可能です。検索のオプション。

戻り値

Word.RangeCollection

注釈

例

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to select the first content control.
        contentControls.items[0].select();
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Selected the first content control.');
    }
});

select(selectionMode)

コンテンツコントロールを選択します。その結果、Word は選択範囲にスクロールされます。

select(selectionMode?: Word.SelectionMode): void;

パラメーター

selectionMode: Word.SelectionMode

省略可能です。選択モードは、'Select'、'Start'、または 'End' である必要があります。 'Select' が既定値です。

戻り値

void

注釈

select(selectionModeString)

コンテンツコントロールを選択します。その結果、Word は選択範囲にスクロールされます。

select(selectionModeString?: "Select" | "Start" | "End"): void;

パラメーター

selectionModeString: "Select" | "Start" | "End"

省略可能です。選択モードは、'Select'、'Start'、または 'End' である必要があります。 'Select' が既定値です。

戻り値

void

注釈

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.ContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties: Word.Interfaces.ContentControlUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options: OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

例

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

// Adds title and colors to odd and even content controls and changes their appearance.
await Word.run(async (context) => {
  // Get the complete sentence (as range) associated with the insertion point.
  let evenContentControls = context.document.contentControls.getByTag("even");
  let oddContentControls = context.document.contentControls.getByTag("odd");
  evenContentControls.load("length");
  oddContentControls.load("length");

  await context.sync();

  for (let i = 0; i < evenContentControls.items.length; i++) {
    // Change a few properties and append a paragraph
    evenContentControls.items[i].set({
      color: "red",
      title: "Odd ContentControl #" + (i + 1),
      appearance: Word.ContentControlAppearance.tags
    });
    evenContentControls.items[i].insertParagraph("This is an odd content control", "End");
  }

  for (let j = 0; j < oddContentControls.items.length; j++) {
    // Change a few properties and append a paragraph
    oddContentControls.items[j].set({
      color: "green",
      title: "Even ContentControl #" + (j + 1),
      appearance: "Tags"
    });
    oddContentControls.items[j].insertHtml("This is an <b>even</b> content control", "End");
  }

  await context.sync();
});

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Word.ContentControl): void;

パラメーター

properties: Word.ContentControl

戻り値

void

setState(contentControlState)

注意

コンテンツコントロールの状態を設定します。

setState(contentControlState: Word.ContentControlState): void;

パラメーター

contentControlState: Word.ContentControlState

設定する状態。

戻り値

void

注釈

setState(contentControlStateString)

注意

コンテンツコントロールの状態を設定します。

setState(contentControlStateString: "Error" | "Warning"): void;

パラメーター

contentControlStateString: "Error" | "Warning"

設定する状態。

戻り値

void

注釈

split(delimiters, multiParagraphs, trimDelimiters, trimSpacing)

区切り記号を使用して、コンテンツコントロールを子の範囲に分割します。

split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection;

パラメーター

delimiters: string[]

必須です。文字列の配列としての区切り記号。

multiParagraphs: boolean

オプション。返された子範囲が複数の段落をカバーできるかどうかを示します。既定値は false で、段落の境界が区切り記号としても使用されることを示します。

trimDelimiters: boolean

オプション。範囲コレクション内の範囲から区切り記号をトリミングするかどうかを示します。既定値は false で、範囲コレクションで返される範囲に区切り記号が含まれていることを示します。

trimSpacing: boolean

戻り値

Word.RangeCollection

注釈

OfficeExtension.EventHandlers<Word.CommentEventArgs>

toJSON()

API オブジェクトがに渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡されるオブジェクトのメソッドを呼び出toJSONします)。一方、元のWord。ContentControl オブジェクトは API オブジェクトです。メソッドは、元のtoJSONオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (としてWord.Interfaces.ContentControlData型指定) を返します。

toJSON(): Word.Interfaces.ContentControlData;

戻り値

Word.Interfaces.ContentControlData

track()

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。この呼び出しは、context.trackedObjects.add(thisObject)の短縮形です。このオブジェクトを呼び出しで .sync 使用していて、".run" バッチのシーケンシャル実行の外部で使用していて、プロパティを設定するとき、またはオブジェクトのメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに追跡対象のオブジェクトコレクションにオブジェクトを追加する必要があります。このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。

track(): Word.ContentControl;

戻り値

Word.ContentControl

untrack()

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。この呼び出しは、context.trackedObjects.remove(thisObject)の短縮形です。追跡対象オブジェクトが多いとホストアプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。メモリ解放が有効になる前にを呼び出す context.sync() 必要があります。

untrack(): Word.ContentControl;

戻り値

Word.ContentControl

イベントの詳細

onCommentAdded

注意

新しいコメントが追加されたときに発生します。

readonly onCommentAdded: OfficeExtension.EventHandlers<Word.CommentEventArgs>;

イベントの種類

注釈

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onCommentChanged

注意

コメントまたはその応答が変更されたときに発生します。

readonly onCommentChanged: OfficeExtension.EventHandlers<Word.CommentEventArgs>;

イベントの種類

注釈

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onCommentDeselected

注意

コメントの選択が解除されたときに発生します。

readonly onCommentDeselected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;

イベントの種類

注釈

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onCommentSelected

注意

コメントが選択されたときに発生します。

readonly onCommentSelected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;

イベントの種類

注釈

OfficeExtension.EventHandlers<Word.ContentControlDataChangedEventArgs>

onDataChanged

コンテンツコントロール内のデータが変更されたときに発生します。新しいテキストを取得するには、ハンドラーでこのコンテンツコントロールを読み込みます。古いテキストを取得するには、読み込みしないでください。

readonly onDataChanged: OfficeExtension.EventHandlers<Word.ContentControlDataChangedEventArgs>;

イベントの種類

注釈

OfficeExtension.EventHandlers<Word.ContentControlDeletedEventArgs>

例

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

await Word.run(async (context) => {
  const contentControls = context.document.contentControls;
  contentControls.load("items");
  await context.sync();

  // Register the onDataChanged event handler on each content control.
  if (contentControls.items.length === 0) {
    console.log("There aren't any content controls in this document so can't register event handlers.");
  } else {
    for (let i = 0; i < contentControls.items.length; i++) {
      eventContexts[i] = contentControls.items[i].onDataChanged.add(contentControlDataChanged);
      contentControls.items[i].track();
    }

    await context.sync();

    console.log("Added event handlers for when data is changed in content controls.");
  }
});

...

async function contentControlDataChanged(event: Word.ContentControlDataChangedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.eventType} event detected. IDs of content controls where data was changed:`);
    console.log(event.ids);
  });
}

onDeleted

コンテンツコントロールが削除されたときに発生します。このコンテンツコントロールをハンドラーに読み込まないと、元のプロパティを取得できなくなります。

readonly onDeleted: OfficeExtension.EventHandlers<Word.ContentControlDeletedEventArgs>;

イベントの種類

注釈

OfficeExtension.EventHandlers<Word.ContentControlEnteredEventArgs>

例

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

await Word.run(async (context) => {
  const contentControls = context.document.contentControls;
  contentControls.load("items");
  await context.sync();

  // Register the onDeleted event handler on each content control.
  if (contentControls.items.length === 0) {
    console.log("There aren't any content controls in this document so can't register event handlers.");
  } else {
    for (let i = 0; i < contentControls.items.length; i++) {
      eventContexts[i] = contentControls.items[i].onDeleted.add(contentControlDeleted);
      contentControls.items[i].track();
    }

    await context.sync();

    console.log("Added event handlers for when content controls are deleted.");
  }
});

...

async function contentControlDeleted(event: Word.ContentControlDeletedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.eventType} event detected. IDs of content controls that were deleted:`);
    console.log(event.ids);
  });
}

onEntered

コンテンツコントロールが入力されたときに発生します。

readonly onEntered: OfficeExtension.EventHandlers<Word.ContentControlEnteredEventArgs>;

イベントの種類

注釈

OfficeExtension.EventHandlers<Word.ContentControlExitedEventArgs>

例

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

await Word.run(async (context) => {
  const contentControls = context.document.contentControls;
  contentControls.load("items");
  await context.sync();

  // Register the onEntered event handler on each content control.
  if (contentControls.items.length === 0) {
    console.log("There aren't any content controls in this document so can't register event handlers.");
  } else {
    for (let i = 0; i < contentControls.items.length; i++) {
      eventContexts[i] = contentControls.items[i].onEntered.add(contentControlEntered);
      contentControls.items[i].track();
    }

    await context.sync();

    console.log("Added event handlers for when the cursor is placed in content controls.");
  }
});

...

async function contentControlEntered(event: Word.ContentControlEnteredEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.eventType} event detected. ID of content control that was entered: ${event.ids[0]}`);
  });
}

onExited

コンテンツコントロールが終了すると、たとえば、カーソルがコンテンツコントロールから離れたときに発生します。

readonly onExited: OfficeExtension.EventHandlers<Word.ContentControlExitedEventArgs>;

イベントの種類

注釈

OfficeExtension.EventHandlers<Word.ContentControlSelectionChangedEventArgs>

例

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

await Word.run(async (context) => {
  const contentControls = context.document.contentControls;
  contentControls.load("items");
  await context.sync();

  // Register the onExited event handler on each content control.
  if (contentControls.items.length === 0) {
    console.log("There aren't any content controls in this document so can't register event handlers.");
  } else {
    for (let i = 0; i < contentControls.items.length; i++) {
      eventContexts[i] = contentControls.items[i].onExited.add(contentControlExited);
      contentControls.items[i].track();
    }

    await context.sync();

    console.log("Added event handlers for when the cursor is removed from within content controls.");
  }
});

...

async function contentControlExited(event: Word.ContentControlExitedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.eventType} event detected. ID of content control that was exited: ${event.ids[0]}`);
  });
}

onSelectionChanged

コンテンツコントロール内の選択が変更されたときに発生します。

readonly onSelectionChanged: OfficeExtension.EventHandlers<Word.ContentControlSelectionChangedEventArgs>;

イベントの種類

注釈