次の方法で共有

JavaScript プレビュー API のWord

新しいWord JavaScript API は、最初に "プレビュー" で導入され、後で十分なテストが行われ、ユーザー フィードバックが取得された後に、特定の番号付き要件セットの一部になります。

重要

次のWordプレビュー API は、次のプラットフォームで使用できる場合があることに注意してください。

  • Word on Windows
  • Word on Mac

Word プレビュー API は現在、iPad ではサポートされていません。 ただし、いくつかの API は、web 上のWordでのみ使用できます。

注:

プレビュー API は変更されることがあります。運用環境での使用は意図されていません。 試用はテスト環境と開発環境に限定することをお勧めします。 運用環境やビジネス上重要なドキュメントでプレビュー API を使用しないでください。

プレビュー API を使用するには:

  • Office.js コンテンツ配信ネットワーク (CDN) から Office JavaScript API ライブラリのプレビュー バージョンを使用する必要があります。 TypeScript コンパイルおよび IntelliSense の 型定義ファイルは CDN で見つかり、DefinitelyTyped にあります。 これらの種類は、 npm install --save-dev @types/office-js-preview でインストールできます (以前にインストールした場合は、 @types/office-js の種類を必ず削除してください)。
  • 最新の Office ビルドにアクセスするには、 Microsoft 365 Insider プログラム に参加する必要がある場合があります。

API リスト

次の表に、現在プレビュー中のWord JavaScript API の一覧を示します。 すべてのWord JavaScript API (プレビュー API と以前にリリースされた API を含む) の完全な一覧については、すべてのWord JavaScript API を参照してください。

クラス フィールド 説明
Body onCommentAdded 新しいコメントが追加されたときに発生します。
onCommentChanged コメントまたはその応答が変更されたときに発生します。
onCommentDeleted コメントが削除されたときに発生します。
onCommentDeselected コメントの選択が解除されたときに発生します。
onCommentSelected コメントが選択されたときに発生します。
type 本文の種類を取得します。
BookmarkCollection add(name: string, range: Word.範囲) 範囲に追加されたブックマークを表す Bookmark オブジェクトを返します。
getItem(index: number) コレクション内のインデックスによって Bookmark オブジェクトを取得します。
BorderUniversalCollection getItem(index: number) コレクション内のインデックスによって Border オブジェクトを取得します。
CommentDetail id このコメントの ID を表します。
replyIds このコメントに対する応答の ID を表します。
CommentEventArgs changeType commentChanged イベントの発生方法を表します。
commentDetails 関連するコメントの ID と応答 ID を含む CommentDetail 配列を取得します。
source イベントのソースを指定します。
type イベントの種類を指定します。
ConflictCollection getItem(index: number) コレクション内のインデックスによって Conflict オブジェクトを取得します。
ContentControl onCommentAdded 新しいコメントが追加されたときに発生します。
onCommentChanged コメントまたはその応答が変更されたときに発生します。
onCommentDeselected コメントの選択が解除されたときに発生します。
onCommentSelected コメントが選択されたときに発生します。
resetState() コンテンツ コントロールの状態をリセットします。
setState(contentControlState: Word。ContentControlState) コンテンツ コントロールの状態を設定します。
CustomXmlAddValidationErrorOptions clearedOnUpdate 指定した場合は、エラーをWordからクリアするかどうかを指定します。XML が修正および更新されたときの CustomXmlValidationErrorCollection。
errorText 指定した場合は、説明的なエラー テキストを指定します。
CustomXmlNodeCollection getItem(index: number) コレクション内の指定した項目を表す CustomXmlNode オブジェクトを返します。
CustomXmlPart errors XML 検証エラーへのアクセスを提供する CustomXmlValidationErrorCollection オブジェクトを取得します。
CustomXmlPrefixMappingCollection getItem(index: number) コレクション内の指定した項目を表す CustomXmlPrefixMapping オブジェクトを返します。
CustomXmlValidationError delete() この CustomXmlValidationError オブジェクトを削除します。
errorCode CustomXmlValidationError オブジェクトの検証エラーを表す整数を取得します。
name CustomXmlValidationError オブジェクト内のエラーの名前を取得します。
ノード 存在する場合は、この CustomXmlValidationError オブジェクトに関連付けられているノードを取得します。
text CustomXmlValidationError オブジェクト内のテキストを取得します。
type CustomXmlValidationError オブジェクトから生成されたエラーの種類を取得します。
CustomXmlValidationErrorCollection add(node: Word。CustomXmlNode、errorName: string、options?: Word。CustomXmlAddValidationErrorOptions) XML 検証エラーを含む CustomXmlValidationError オブジェクトを CustomXmlValidationErrorCollection オブジェクトに追加します。
getCount() コレクション内の項目の数を返します。
getItem(index: number) コレクション内の指定した項目を表す CustomXmlValidationError オブジェクトを返します。
items このコレクション内に読み込まれた子アイテムを取得します。
ドキュメント checkIn(options?: Word。DocumentCheckInOptions) ローカル コンピューターからサーバーにドキュメントをチェックインし、ローカルで編集できないようにローカル ドキュメントを読み取り専用に設定します。
checkInWithVersion(options?: Word。DocumentCheckInWithVersionOptions) ローカル コンピューターからサーバーにドキュメントを保存し、ローカルで編集できないように、ローカル ドキュメントを読み取り専用に設定します。
checkSpelling(options?: Word。DocumentCheckSpellingOptions) 文書のスペル チェックを開始します。
computeStatistics(statistic: Word。StatisticType、includeFootnotesAndEndnotes?: boolean) ドキュメントの内容に基づいて統計を返します。
countNumberedItems(options?: Word。DocumentCountNumberedItemsOptions) 文書内の箇条書き項目または番号付き項目と LISTNUM フィールドの数を返します。
endReview(options?: Word。DocumentEndReviewOptions) レビューのために送信されたファイルのレビューを終了します。
exportAsFixedFormat(outputFileName: string, exportFormat: Word.ExportFormat、オプション?: Word。DocumentExportAsFixedFormatOptions) ドキュメントを PDF または XPS 形式で保存します。
exportAsFixedFormat2(outputFileName: string, exportFormat: Word.ExportFormat、オプション?: Word。DocumentExportAsFixedFormat2Options) ドキュメントを PDF または XPS 形式で保存します。
exportAsFixedFormat3(outputFileName: string, exportFormat: Word.ExportFormat、オプション?: Word。DocumentExportAsFixedFormat3Options) タグ付けを改善して、ドキュメントを PDF または XPS 形式で保存します。
followHyperlink(options?: Word。DocumentFollowHyperlinkOptions) キャッシュに格納されたファイルを表示します。
getRange(options?: Word。DocumentRangeOptions) 指定した開始文字位置と終了文字位置を使用して、 Range オブジェクトを返します。
goTo(options?: Word。GoToOptions) ページ、ブックマーク、フィールドなど、指定した項目の開始位置を表す Range オブジェクトを返します。
merge(fileName: string, options?: Word.DocumentMergeOptions) 1 つの文書の変更履歴をほかの文書に結合します。
printOut(options?: Word。DocumentPrintOutOptions) ドキュメントのすべてまたは一部を印刷します。
protect(type: Word。ProtectionType、オプション?: Word。DocumentProtectOptions) 未承認の変更からドキュメントを保護します。
replyWithChanges(options?: Word。DocumentReplyWithChangesOptions) レビューのために送信されたドキュメントの作成者に電子メール メッセージを送信し、校閲者がドキュメントのレビューを完了したことを通知します。
sendFaxOverInternet(options?: Word。DocumentSendFaxOverInternetOptions) 指定した 1 つ以上の受信者にドキュメントを FAX 送信する FAX サービス プロバイダーにドキュメントを送信します。
sendForReview(options?: Word。DocumentSendForReviewOptions) 指定した受信者による確認のために、電子メール メッセージでドキュメントを送信します。
DocumentCheckInOptions comment 指定した場合は、チェック操作のコメントを指定します。
makePublic 指定した場合は、チェック後にドキュメントをパブリックにするかどうかを指定します。
Savechanges 指定した場合は、チェックイン前に変更を保存するかどうかを指定します。
DocumentCheckInWithVersionOptions comment 指定した場合は、チェック操作のコメントを指定します。
makePublic 指定した場合は、チェック後にドキュメントをパブリックにするかどうかを指定します。
Savechanges 指定した場合は、チェックイン前に変更を保存するかどうかを指定します。
versionType 指定した場合は、チェックインのバージョンの種類を指定します。
DocumentCheckSpellingOptions alwaysSuggest 指定した場合は、常にスペル修正を提案するかどうかを指定します。
customDictionary10 指定した場合は、スペル チェックに使用する追加のユーザー辞書を指定します。
customDictionary2 指定した場合は、スペル チェックに使用する追加のユーザー辞書を指定します。
customDictionary3 指定した場合は、スペル チェックに使用する追加のユーザー辞書を指定します。
customDictionary4 指定した場合は、スペル チェックに使用する追加のユーザー辞書を指定します。
customDictionary5 指定した場合は、スペル チェックに使用する追加のユーザー辞書を指定します。
customDictionary6 指定した場合は、スペル チェックに使用する追加のユーザー辞書を指定します。
customDictionary7 指定した場合は、スペル チェックに使用する追加のユーザー辞書を指定します。
customDictionary8 指定した場合は、スペル チェックに使用する追加のユーザー辞書を指定します。
customDictionary9 指定した場合は、スペル チェックに使用する追加のユーザー辞書を指定します。
customDictionary 指定した場合は、スペル チェックに使用するユーザー辞書を指定します。
ignoreUppercase 指定した場合は、スペル チェック中に大文字の単語を無視するかどうかを指定します。
DocumentCountNumberedItemsOptions level 指定した場合は、カウントする番号のレベルを指定します。
numberType 指定した場合は、カウントする番号付き項目の種類を指定します。
DocumentEndReviewOptions includeAttachment 指定した場合は、ドキュメントを添付ファイルとして含めるかどうかを指定します。
recipients 指定した場合は、レビューを終了するときに通知する受信者を指定します。
showMessage 指定した場合は、送信前にメッセージを表示するかどうかを指定します。
subject 指定した場合は、通知メールの件名を指定します。
DocumentExportAsFixedFormat2Options bitmapMissingFonts 指定した場合は、不足しているフォントをビットマップにするかどうかを指定します。
createBookmarks 指定した場合は、ブックマーク作成モードを指定します。
documentStructureTags 指定した場合は、ドキュメント構造タグを含めるかどうかを指定します。
fixedFormatExtClassPtr 指定した場合は、拡張クラス ポインターを指定します。
from 指定した場合は、開始ページ番号を指定します。
includeDocProps 指定した場合は、ドキュメント プロパティを含めるかどうかを指定します。
item 指定した場合は、エクスポートする項目を指定します。
keepInformationRightsManagement 指定した場合は、Information Rights Management (IRM) 設定を保持するかどうかを指定します。
openAfterExport 指定した場合は、エクスポート後にファイルを開くかどうかを指定します。
optimizeFor 指定した場合は、エクスポートの最適化ターゲットを指定します。
optimizeForImageQuality 指定した場合は、エクスポートされたファイルの画質を最適化するかどうかを指定します。
range 指定した場合は、エクスポートする範囲を指定します。
to 指定した場合は、終了ページ番号を指定します。
useIso19005_1 指定した場合は、ISO 19005-1 コンプライアンスを使用するかどうかを指定します。
DocumentExportAsFixedFormat3Options bitmapMissingFonts 指定した場合は、不足しているフォントをビットマップにするかどうかを指定します。
createBookmarks 指定した場合は、ブックマーク作成モードを指定します。
documentStructureTags 指定した場合は、ドキュメント構造タグを含めるかどうかを指定します。
fixedFormatExtClassPtr 指定した場合は、拡張クラス ポインターを指定します。
from 指定した場合は、開始ページ番号を指定します。
improveExportTagging 指定した場合は、アクセシビリティを向上させるためにエクスポートタグ付けを改善するために を指定します。
includeDocProps 指定した場合は、ドキュメント プロパティを含めるかどうかを指定します。
item 指定した場合は、エクスポートする項目を指定します。
keepInformationRightsManagement 指定した場合は、Information Rights Management (IRM) 設定を保持するかどうかを指定します。
openAfterExport 指定した場合は、エクスポート後にファイルを開くかどうかを指定します。
optimizeFor 指定した場合は、エクスポートの最適化ターゲットを指定します。
optimizeForImageQuality 指定した場合は、エクスポートされたファイルの画質を最適化するかどうかを指定します。
range 指定した場合は、エクスポートする範囲を指定します。
to 指定した場合は、終了ページ番号を指定します。
useIso19005_1 指定した場合は、ISO 19005-1 コンプライアンスを使用するかどうかを指定します。
DocumentExportAsFixedFormatOptions bitmapMissingFonts 指定した場合は、不足しているフォントをビットマップにするかどうかを指定します。
createBookmarks 指定した場合は、ブックマーク作成モードを指定します。
documentStructureTags 指定した場合は、ドキュメント構造タグを含めるかどうかを指定します。
fixedFormatExtensionClassPointer 指定した場合は、拡張クラス ポインターを指定します。
from 指定した場合は、開始ページ番号を指定します。
includeDocProps 指定した場合は、ドキュメント プロパティを含めるかどうかを指定します。
item 指定した場合は、エクスポートする項目を指定します。
keepInformationRightsManagement 指定した場合は、Information Rights Management (IRM) 設定を保持するかどうかを指定します。
openAfterExport 指定した場合は、エクスポート後にファイルを開くかどうかを指定します。
optimizeFor 指定した場合は、エクスポートの最適化ターゲットを指定します。
range 指定した場合は、エクスポートする範囲を指定します。
to 指定した場合は、終了ページ番号を指定します。
useIso19005_1 指定した場合は、ISO 19005-1 コンプライアンスを使用するかどうかを指定します。
DocumentFollowHyperlinkOptions addHistory 指定した場合は、閲覧履歴にリンクを追加するかどうかを指定します。
address 指定した場合は、後に続くハイパーリンク アドレスを指定します。
extraInfo 指定した場合は、要求に渡す追加情報を指定します。
headerInfo 指定した場合は、HTTP 要求のヘッダー情報を指定します。
httpMethod 指定した場合は、要求に使用する HTTP メソッドを指定します。
Newwindow 指定した場合は、リンクを新しいウィンドウで開くかどうかを指定します。
subAddress 指定した場合は、ドキュメント内のサブアドレスを指定します。
DocumentMergeOptions addToRecentFiles 指定した場合は、マージされたドキュメントを最近のファイルに追加するかどうかを指定します。
detectFormatChanges 指定した場合は、マージ中に書式の変更を検出するかどうかを指定します。
mergeTarget 指定した場合は、マージ操作のターゲットを指定します。
useFormattingFrom 指定した場合は、マージで使用する書式設定のソースを指定します。
DocumentPrintOutOptions activePrinterMacGX 指定した場合は、プリンター名を指定します。
追加 指定した場合は、既存のファイルに追加するかどうかを指定します。
背景 指定した場合は、バックグラウンドで印刷するかどうかを指定します。
照合 指定した場合は、ページを照合するかどうかを指定します。
コピー 指定した場合は、印刷するコピーの数を指定します。
from 指定した場合は、開始ページ番号を指定します。
item 指定した場合は、印刷する項目を指定します。
manualDuplexPrint 指定した場合は、手動で両面印刷するかどうかを指定します。
outputFileName 指定した場合は、出力ファイルの名前を指定します。
pageType 指定した場合は、ページの順序を指定します。
pages 指定した場合は、印刷する特定のページを指定します。
printToFile 指定した場合は、ファイルに印刷するかどうかを指定します。
printZoomColumn 指定した場合は、ズーム列の設定を指定します。
printZoomPaperHeight 指定した場合は、twip で印刷する用紙の高さを指定します (20 twips = 1 ポイント、72 ポイント = 1 インチ)。
printZoomPaperWidth 指定した場合は、twip で印刷する用紙の幅を指定します (20 twips = 1 ポイント、72 ポイント = 1 インチ)。
printZoomRow 指定した場合は、ズーム行の設定を指定します。
range 指定した場合は、印刷する範囲を指定します。
to 指定した場合は、終了ページ番号を指定します。
DocumentProtectOptions enforceStyleLock 指定した場合は、スタイル ロック制限を適用するかどうかを指定します。
noReset 指定した場合は、ドキュメントを保護するときにフォーム フィールドをリセットするかどうかを指定します。
password 指定した場合は、ドキュメント保護に適用するパスワードを指定します。
useInformationRightsManagement 指定した場合は、Information Rights Management (IRM) を使用するかどうかを指定します。
DocumentRangeOptions end 指定した場合は、終了文字の位置を指定します。
start 指定した場合は、開始文字の位置を指定します。
DocumentReplyWithChangesOptions includeAttachment 指定した場合は、ドキュメントを添付ファイルとして含めるかどうかを指定します。
recipients 指定した場合は、応答の受信者を指定します。
showMessage 指定した場合は、送信前にメッセージを表示するかどうかを指定します。
subject 指定した場合は、返信メールの件名を指定します。
DocumentSendFaxOverInternetOptions recipients 指定した場合は、FAX の受信者を指定します。
showMessage 指定した場合は、送信前にメッセージを表示するかどうかを指定します。
subject 指定した場合は、FAX の件名を指定します。
DocumentSendForReviewOptions includeAttachment 指定した場合は、ドキュメントを添付ファイルとして含めるかどうかを指定します。
recipients 指定した場合は、レビュー要求の受信者を指定します。
showMessage 指定した場合は、送信前にメッセージを表示するかどうかを指定します。
subject 指定した場合は、レビュー メールの件名を指定します。
GoToOptions count 指定した場合は、ドキュメント内の項目の数を指定します。
direction 指定した場合は、範囲または選択範囲の移動方向を指定します。
item 指定した場合は、範囲または選択範囲が移動される項目の種類を指定します。
name 指定した場合、item プロパティが Word に設定されている場合は、名前を指定します。GoToItem 型bookmark、comment、field、またはobject。
IndexCollection getItem(index: number) コレクション内のインデックスによって Index オブジェクトを取得します。
ListTemplateAddOptions name 指定した場合は、追加するリスト テンプレートの名前を指定します。
outlineNumbered 指定した場合は、アウトライン番号を新しいリスト テンプレートに適用するかどうかを指定します。
ListTemplateCollection add(options?: Word。ListTemplateAddOptions) 新しい ListTemplate オブジェクトを追加します。
getItem(index: number) コレクション内のインデックスによって ListTemplate オブジェクトを取得します。
ListTemplateGalleryCollection getItem(index: number) コレクション内のインデックスによって ListTemplateGallery オブジェクトを取得します。
Paragraph onCommentAdded 新しいコメントが追加されたときに発生します。
onCommentChanged コメントまたはその応答が変更されたときに発生します。
onCommentDeleted コメントが削除されたときに発生します。
onCommentDeselected コメントの選択が解除されたときに発生します。
onCommentSelected コメントが選択されたときに発生します。
Range onCommentAdded 新しいコメントが追加されたときに発生します。
onCommentChanged コメントまたはその応答が変更されたときに発生します。
onCommentDeselected コメントの選択が解除されたときに発生します。
onCommentSelected コメントが選択されたときに発生します。
underline 範囲に適用される下線の種類を指定します。
RangeScopedCollection getItem(index: number) コレクション内のインデックスによって Range オブジェクトを取得します。
RepeatingSectionContentControl xmlMapping ドキュメントのデータ ストア内の XML データへのコンテンツ コントロールのマッピングを表す XmlMapping オブジェクトを返します。
ReviewerCollection getItem(index: number) コレクション内の指定した項目を表す Reviewer オブジェクトを返します。
RevisionCollection getItem(index: number) コレクション内の指定した項目を表す Revision オブジェクトを返します。
Selection convertToTable(options?: Word。SelectionConvertToTableOptions) 範囲内のテキストをテーブルに変換します。
goTo(options?: Word。GoToOptions) optionsで指定された領域を表すRange オブジェクトを返し、カーソルを指定した項目の直前の文字位置に移動します。
SelectionConvertToTableOptions applyBorders 指定した場合は、指定した形式のテーブルに罫線を適用するかどうかを指定します。
applyColor 指定した場合は、指定した形式のテーブルに色の書式設定を適用するかどうかを指定します。
applyFirstColumn 指定した場合は、指定した形式の最初の列に特別な書式を適用するかどうかを指定します。
applyFont 指定した場合は、指定した形式のテーブルにフォントの書式設定を適用するかどうかを指定します。
applyHeadingRows 指定した場合は、最初の行を指定された形式のヘッダー行として書式設定するかどうかを指定します。
applyLastColumn 指定した場合は、指定した形式の最後の列に特別な書式を適用するかどうかを指定します。
applyLastRow 指定した場合は、指定した形式の最後の行に特別な書式を適用するかどうかを指定します。
applyShading 指定した場合は、指定した形式のテーブルに網かけを適用するかどうかを指定します。
autoFit 指定した場合は、内容に合わせてテーブルのサイズを自動的に変更するかどうかを指定します。
autoFitBehavior 指定した場合は、テーブルの自動フィット動作を指定します。
defaultTableBehavior 指定した場合は、Microsoft Wordがコンテンツに合わせてテーブル内のセルのサイズを自動的に変更するかどうかを指定します。
format 指定した場合は、テーブルに適用するプリセット形式を指定します。
initialColumnWidth 指定した場合は、テーブル内の各列の初期幅をポイント単位で指定します。
numColumns 指定した場合は、テーブル内の列の数を指定します。
numRows 指定した場合は、テーブル内の行数を指定します。
区切り 記号 指定した場合は、テキストをセルに分割するために使用する文字を指定します。
SourceCollection getItem(index: number) コレクション内のインデックスによって Source を取得します。
スタイル description スタイルの説明を取得します。
TabStopCollection getItem(index: number) コレクション内のインデックスによって TabStop オブジェクトを取得します。
Window state ドキュメント ウィンドウまたはタスク ウィンドウの状態を指定します。
Xmlnode type ノードの種類を取得します。
value この XML ノードの値を指定します。
XmlNodeCollection getItem(index: number) コレクション内のインデックスによって XmlNode オブジェクトを取得します。

関連項目

  • Last updated on