次の方法で共有


Word.Document class

Document オブジェクトは最上位のオブジェクトです。 Document オブジェクトには、ドキュメントの内容を含む 1 つ以上のセクション、コンテンツ コントロール、および本文が含まれています。

Extends

注釈

[ API セット: WordApi 1.1 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-change-tracking.yaml

// Gets the current change tracking mode.
await Word.run(async (context) => {
  const document: Word.Document = context.document;
  document.load("changeTrackingMode");
  await context.sync();

  if (document.changeTrackingMode === Word.ChangeTrackingMode.trackMineOnly) {
    console.log("Only my changes are being tracked.");
  } else if (document.changeTrackingMode === Word.ChangeTrackingMode.trackAll) {
    console.log("Everyone's changes are being tracked.");
  } else {
    console.log("No changes are being tracked.");
  }
});

プロパティ

activeTheme

アクティブなテーマと書式設定オプションの名前を取得します。

activeThemeDisplayName

アクティブなテーマの表示名を取得します。

activeWindow

ドキュメントのアクティブ ウィンドウを取得します。

areFilePropertiesPasswordEncrypted

Wordでパスワードで保護されたドキュメントのファイル プロパティを暗号化するかどうかを取得します。

areGrammaticalErrorsShown

文書内の波状の緑色の線で文法上のエラーをマークするかどうかを指定します。

areMathDefaultsUsed

新しい数式を作成するときに既定の数式設定を使用するかどうかを指定します。

areNewerFeaturesDisabled

指定したバージョンの後に導入された機能を無効にするかどうかを指定します。

areSpellingErrorsShown

Microsoft Wordドキュメント内のスペル ミスを強調するかどうかを指定します。

areStylesUpdatedOnOpen

ドキュメントを開くたびに、添付テンプレートのスタイルと一致するように、このドキュメント内のスタイルを更新するかどうかを指定します。

areTrueTypeFontsEmbedded

保存時に Microsoft Wordが TrueType フォントをドキュメントに埋め込むかどうかを指定します。

attachedTemplate

ドキュメントにアタッチされているテンプレートを表す Template オブジェクトを指定します。

autoHyphenation

ドキュメントに対して自動ハイフネーションを有効にするかどうかを指定します。

autoSaveOn

ドキュメント内の編集内容を自動的に保存するかどうかを指定します。

background

ドキュメントの背景画像を表す Shape オブジェクトを取得します。

bibliography

ドキュメントに含まれる文献目録参照を表す Bibliography オブジェクトを返します。

body

メイン ドキュメントの Body オブジェクトを取得します。 本文は、ヘッダー、フッター、脚注、テキスト ボックスなどを除外するテキストです。

bookmarks

ドキュメント内のすべてのブックマークを表す BookmarkCollection オブジェクトを返します。

builtInDocumentProperties

ドキュメントのすべての組み込みドキュメント プロパティを表す DocumentProperties オブジェクトを取得します。

changeTrackingMode

ChangeTracking モードを指定します。

characters

ドキュメント内のすべての文字を表す RangeScopedCollection オブジェクトを取得します。

coauthoring

ドキュメント内の共同編集を管理するための Coauthoring オブジェクトを取得します。

codeName

ドキュメントのコード名を取得します。

comments

ドキュメント内のすべてのコメントを表す CommentCollection オブジェクトを取得します。

compatibilityMode

ドキュメントを開くときに使用Word互換モードを取得します。

consecutiveHyphensLimit

ハイフンで終わる連続する行の最大数を指定します。

content

メイン ドキュメント ストーリーを表す Range オブジェクトを取得します。

contentControls

ドキュメント内の ContentControl オブジェクトのコレクションを取得します。 これには、ドキュメントの本文、ヘッダー、フッター、テキスト ボックスなどのコンテンツ コントロールが含まれます。

context

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

currentRsid

ドキュメント内の変更Word割り当てる乱数を取得します。

customDocumentProperties

ドキュメントのすべてのカスタム ドキュメント プロパティを表す DocumentProperties コレクションを取得します。

customXmlParts

ドキュメント内のカスタム XML パーツを取得します。

defaultTabStop

ドキュメント内の既定のタブ位置の間隔 (ポイント単位) を指定します。

defaultTargetFrame

ハイパーリンクを使用して Web ページを表示するためのブラウザー フレームを指定します。

documentLibraryVersions

バージョン管理が有効で、サーバー上のドキュメント ライブラリに格納されている共有ドキュメントのバージョンのコレクションを表す DocumentLibraryVersionCollection オブジェクトを返します。

doNotEmbedSystemFonts

一般的なシステム フォントWord埋め込むべきではないかどうかを指定します。

encryptionProvider

ドキュメントの暗号化時に Microsoft Word使用するアルゴリズム暗号化プロバイダーの名前を指定します。

farEastLineBreakLanguage

改行に使用する東アジア言語を指定します。

farEastLineBreakLevel

改行コントロール レベルを指定します。

fields

ドキュメント内のすべてのフィールドを表す FieldCollection オブジェクトを取得します。

formattingIsNextLevelShown

前の見出しを使用するときにWordに次の見出しレベルを表示するかどうかを指定します。

formattingIsUserStyleNameShown

ユーザー定義スタイルを表示するかどうかを指定します。

frames

ドキュメント内のすべてのフレームを表す FrameCollection オブジェクトを返します。

fullName

パスを含むドキュメントの名前を取得します。

grammaticalErrors

文書内の文法チェックに失敗した文を表すRangeCollection オブジェクトを取得します。

gridDistanceHorizontal

文書内のオートシェイプまたは東アジア文字を描画、移動、およびサイズ変更するときに、Microsoft Wordが使用する非表示の枠線間の水平方向のスペースを指定します。

gridDistanceVertical

文書内のオートシェイプまたは東アジア文字を描画、移動、サイズ変更するときに Microsoft Wordが使用する非表示の枠線間の垂直スペースを指定します。

gridIsOriginFromMargin

ページの左上隅から文字グリッドを開始するかどうかを指定します。

gridOriginHorizontal

非表示グリッドの水平原点を指定します。

gridOriginVertical

非表示グリッドの垂直原点を指定します。

gridSpaceBetweenHorizontalLines

印刷レイアウト ビューの水平方向の文字グリッド線の間隔を指定します。

gridSpaceBetweenVerticalLines

印刷レイアウト ビューの垂直文字グリッド線の間隔を指定します。

hasPassword

ドキュメントを開くためにパスワードが必要かどうかを取得します。

hasVbProject

ドキュメントに Microsoft Visual Basic for Applications プロジェクトが添付されているかどうかを取得します。

hyperlinks

ドキュメント内のすべてのハイパーリンクを表す HyperlinkCollection オブジェクトを返します。

hyphenateCaps

すべての大文字の単語をハイフネーションできるかどうかを指定します。

hyphenationZone

ハイフネーション ゾーンの幅をポイント単位で指定します。

indexes

ドキュメント内のすべてのインデックスを表す IndexCollection オブジェクトを返します。

isAutoFormatOverrideOn

自動書式設定オプションが書式設定の制限をオーバーライドするかどうかを指定します。

isChartDataPointTracked

作業中の文書のグラフでセル参照データ ポイント追跡を使用するかどうかを指定します。

isCompatible

type プロパティで指定された互換性オプションを有効にするかどうかを指定します。

isFinal

ドキュメントが最終的かどうかを指定します。

isFontsSubsetSaved

Microsoft Word埋め込み TrueType フォントのサブセットをドキュメントと共に保存するかどうかを指定します。

isFormsDataPrinted

Microsoft Wordが、対応するオンライン フォームに入力されたデータのみを、印刷済みのフォームに印刷するかどうかを指定します。

isFormsDataSaved

Microsoft Wordフォームに入力されたデータを、データベースで使用するタブ区切りレコードとして保存するかどうかを指定します。

isGrammarChecked

文書で文法チェックが実行されているかどうかを指定します。

isInAutoSave

Application.DocumentBeforeSave イベントの最新の起動が、ドキュメントによる自動保存の結果か、ユーザーによる手動保存の結果かを取得します。

isInFormsDesign

ドキュメントがフォーム デザイン モードであるかどうかを取得します。

isKerningByAlgorithm

半角ラテン文字と句読点をWordするかどうかを指定します。

isLinguisticDataEmbedded

音声データと手書きデータを埋め込むかどうかを指定します。

isMasterDocument

このドキュメントがマスター ドキュメントであるかどうかを取得します。

isOptimizedForWord97

Wordがドキュメントを Word 97 用に最適化するかどうかを指定します。

isPostScriptPrintedOverText

PostScript プリンターを使用するときに、文書内の PRINT フィールド 命令 (PostScript コマンドなど) をテキストとグラフィックの上に印刷するかどうかを指定します。

isQuickStyleSetLocked

ユーザーがクイック スタイル セットを変更できるかどうかを指定します。

isReadOnly

ドキュメントに対する変更を元のドキュメントに保存できないかどうかを取得します。

isReadOnlyRecommended

ユーザーがドキュメントを開いたときに Microsoft Wordメッセージ ボックスを表示するかどうかを指定し、ドキュメントを読み取り専用として開くことを提案します。

isSnappedToGrid

オートシェイプ文字または東アジア文字を非表示のグリッドに自動的に配置するかどうかを指定します。

isSnappedToShapes

オートシェイプ文字または東アジア文字を、他の図形を通して非表示のグリッド線と一致するかどうかを指定します。

isSpellingChecked

文書全体でスペル チェックを行うかどうかを指定します。

isStyleEnforced

保護されたドキュメントで書式設定の制限を適用するかどうかを指定します。

isSubdocument

このドキュメントがマスター ドキュメントのサブ文書であるかどうかを取得します。

isThemeLocked

ユーザーがドキュメント テーマを変更できるかどうかを指定します。

isUserControl

ユーザーがドキュメントを作成または開いたかどうかを指定します。

isVbaSigned

VBA プロジェクトがデジタル署名されているかどうかを取得します。

isWriteReserved

ドキュメントが書き込みパスワードで保護されているかどうかを取得します。

justificationMode

文字間隔の調整を指定します。

kind

Microsoft Wordがドキュメントを自動的に書式設定するときに使用する書式の種類を指定します。

languageDetected

Microsoft Wordがドキュメント テキストの言語を検出したかどうかを指定します。

listParagraphs

ドキュメント内のすべての段落番号を表す ParagraphCollection オブジェクトを取得します。

lists

ドキュメント内のすべての書式設定されたリストを含む ListCollection オブジェクトを取得します。

listTemplates

ドキュメント内のすべてのリスト テンプレートを表す ListTemplateCollection オブジェクトを返します。

noLineBreakAfter

その後、Wordが行を区切らない kinsoku 文字を指定します。

noLineBreakBefore

Wordが改行しない前の kinsoku 文字を指定します。

openEncoding

ドキュメントを開くために使用するエンコードを取得します。

originalDocumentTitle

法的ブラックライン比較後の元のドキュメントのタイトルを取得します。

pageSetup

ドキュメントに関連付けられている PageSetup オブジェクトを返します。

paragraphs

ドキュメント内のすべての段落を表す ParagraphCollection オブジェクトを取得します。

password

ドキュメントを開くために指定する必要があるパスワードを設定します。

passwordEncryptionAlgorithm

パスワード暗号化に使用されるアルゴリズムを取得します。

passwordEncryptionKeyLength

パスワード暗号化に使用されるキーの長さを取得します。

passwordEncryptionProvider

パスワード暗号化プロバイダーの名前を取得します。

path

ドキュメントのディスクまたは Web パスを取得します (ドキュメント名は除外されます)。

printRevisions

文書にリビジョン マークを印刷するかどうかを指定します。

properties

ドキュメントのプロパティを取得します。

protectionType

ドキュメントの保護の種類を取得します。

readabilityStatistics

ドキュメントの読みやすさ統計を表す ReadabilityStatisticCollection オブジェクトを取得します。

readingLayoutSizeX

固定された場合の読み取りレイアウト ビューのページ幅を指定します。

readingLayoutSizeY

固定時の読み取りレイアウト ビューのページの高さを指定します。

readingModeIsLayoutFrozen

読み取りレイアウト ビューのページを手書きマークアップ用に固定するかどうかを指定します。

removePersonalInformationOnSave

保存時にユーザー情報Word削除するかどうかを指定します。

revisedDocumentTitle

法律と黒線の比較の後に変更されたドキュメントのタイトルを取得します。

revisions

ドキュメント内の変更履歴を表すリビジョンのコレクションを取得します。

saved

ドキュメント内の変更が保存されているかどうかを示します。 trueの値は、ドキュメントが保存されてから変更されなかったことを示します。

saveEncoding

ドキュメントを保存するときに使用するエンコードを指定します。

saveFormat

ドキュメントのファイル形式を取得します。

sections

ドキュメント内の Section オブジェクトのコレクションを取得します。

selection

ドキュメント内の現在の選択範囲を表す Selection オブジェクトを返します。

sentences

ドキュメント内のすべての文を表す RangeScopedCollection オブジェクトを取得します。

settings

ドキュメント内のアドインの設定を取得します。

spellingErrors

文書のスペル ミスとして識別される単語を表す RangeCollection オブジェクトを取得します。

storyRanges

ドキュメント内のすべてのストーリーを表す RangeCollection オブジェクトを取得します。

styles

ドキュメントの StyleCollection を取得します。

tableOfAuthoritiesCategories

ドキュメント内の使用可能な権限カテゴリのテーブルを表す TableOfAuthoritiesCategoryCollection オブジェクトを返します。

tables

ドキュメント内のすべてのテーブルを表す TableCollection オブジェクトを取得します。

tablesOfAuthorities

ドキュメント内のすべての権限テーブルを表す TableOfAuthoritiesCollection オブジェクトを返します。

tablesOfContents

ドキュメント内のすべての目次を表す TableOfContentsCollection オブジェクトを返します。

tablesOfFigures

ドキュメント内のすべての図形テーブルを表す TableOfFiguresCollection オブジェクトを返します。

textEncoding

エンコードされたテキストとして保存するエンコードを指定します。

textLineEnding

テキスト ファイルWord改行と段落区切りをマークする方法を指定します。

trackedChangesAreDateAndTimeRemoved

追跡された変更の日付と時刻のメタデータを削除または格納するかどうかを指定します。

trackFormatting

変更の追跡がオンのときに書式設定の変更を追跡するかどうかを指定します。

trackMoves

変更履歴がオンのときに移動したテキストをマークするかどうかを指定します。

trackRevisions

ドキュメント内の変更を追跡するかどうかを指定します。

type

ドキュメントの種類 (テンプレートまたはドキュメント) を取得します。

webSettings

Web ページ関連の属性の WebSettings オブジェクトを取得します。

windows

ドキュメントの Word.Window オブジェクトのコレクションを取得します。

words

ドキュメント内の各単語を表す RangeScopedCollection オブジェクトを取得します。

writePassword

ドキュメントへの変更を保存するためのパスワードを設定します。

xmlAreAdvancedErrorsShown

組み込みのWordメッセージまたは MSXML (Microsoft XML) からエラー メッセージを生成するかどうかを指定します。

xmlIsXsltUsedWhenSaving

拡張スタイルシート言語変換 (XSLT) を使用してドキュメントを保存するかどうかを指定します。

xmlSaveThroughXslt

ドキュメントを保存するときに適用する XSLT のパスとファイル名を指定します。

メソッド

acceptAllRevisions()

ドキュメント内で追跡されたすべての変更を受け入れます。

acceptAllRevisionsShown()

画面に表示されるドキュメント内のすべてのリビジョンを受け入れます。

activate()

作業中の文書になるようにドキュメントをアクティブにします。

addStyle(name, type)

名前と種類によってスタイルをドキュメントに追加します。

addStyle(name, type)

名前と種類によってスタイルをドキュメントに追加します。

addToFavorites()

ドキュメントまたはハイパーリンクへのショートカットを作成し、[ お気に入り ] フォルダーに追加します。

applyQuickStyleSet(style)

指定したクイック スタイルを文書に適用します。

applyQuickStyleSet(style)

指定したクイック スタイルを文書に適用します。

applyTheme(name)

指定したテーマをこのドキュメントに適用します。

autoFormat()

ドキュメントの書式を自動的に設定します。

canCheckin()

Microsoft Wordがドキュメント内をサーバーにチェックできる場合は、trueを返します。

checkConsistencyJapanese()

日本語の文書内のすべての文字列を検索し、同じ単語に対して文字の使い方が一貫していないインスタンスを表示します。

checkGrammar()

文書のスペル チェックと文章校正チェックを開始します。

checkIn(options)

ローカル コンピューターからサーバーにドキュメントをチェックインし、ローカルで編集できないようにローカル ドキュメントを読み取り専用に設定します。

checkInWithVersion(options)

ローカル コンピューターからサーバーにドキュメントを保存し、ローカルで編集できないように、ローカル ドキュメントを読み取り専用に設定します。

checkSpelling(options)

文書のスペル チェックを開始します。

close(closeBehavior)

現在のドキュメントを閉じます。

注: この API は、web 上のWordではサポートされていません。

close(closeBehavior)

現在のドキュメントを閉じます。

注: この API は、web 上のWordではサポートされていません。

closePrintPreview()

ドキュメントを印刷プレビューから前のビューに切り替えます。

compare(filePath, documentCompareOptions)

指定された文書と別の文書を比較して、変更箇所を示す変更履歴を表示します。

compareFromBase64(base64File, documentCompareOptions)

指定された文書と別の文書を比較して、変更箇所を示す変更履歴を表示します。

computeStatistics(statistic, includeFootnotesAndEndnotes)

ドキュメントの内容に基づいて統計を返します。

computeStatistics(statistic, includeFootnotesAndEndnotes)

ドキュメントの内容に基づいて統計を返します。

convert()

ファイルを最新の形式に変換し、すべての機能を有効にします。

convertAutoHyphens()

自動ハイフンを手動ハイフンに変換します。

convertNumbersToText(numberType)

ドキュメント内のリスト番号と LISTNUM フィールド をテキストに変更します。

convertNumbersToText(numberType)

ドキュメント内のリスト番号と LISTNUM フィールド をテキストに変更します。

convertVietnameseDocument(codePageOrigin)

既定値以外のコード ページを使用して、ベトナム語の文書を Unicode に再変換します。

copyStylesFromTemplate(StyleTemplate)

指定したテンプレートからドキュメントにスタイルをコピーします。

countNumberedItems(options)

文書内の箇条書き項目または番号付き項目と LISTNUM フィールド の数を返します。

deleteAllComments()

ドキュメントからすべてのコメントを削除します。

deleteAllCommentsShown()

画面に表示されている文書内のすべてのリビジョンを削除します。

deleteAllInkAnnotations()

ドキュメント内のすべての手書きインク注釈を削除します。

deleteBookmark(name)

ブックマークが存在する場合は、ドキュメントから削除します。

detectLanguage()

ドキュメント テキストを分析して言語を決定します。

endReview(options)

レビューのために送信されたファイルのレビューを終了します。

exportAsFixedFormat(outputFileName, exportFormat, options)

ドキュメントを PDF または XPS 形式で保存します。

exportAsFixedFormat(outputFileName, exportFormat, options)

ドキュメントを PDF または XPS 形式で保存します。

exportAsFixedFormat2(outputFileName, exportFormat, options)

ドキュメントを PDF または XPS 形式で保存します。

exportAsFixedFormat2(outputFileName, exportFormat, options)

ドキュメントを PDF または XPS 形式で保存します。

exportAsFixedFormat3(outputFileName, exportFormat, options)

タグ付けを改善して、ドキュメントを PDF または XPS 形式で保存します。

exportAsFixedFormat3(outputFileName, exportFormat, options)

タグ付けを改善して、ドキュメントを PDF または XPS 形式で保存します。

fitToPages()

ドキュメント ページ数が 1 ずつ減少するように、テキストのフォント サイズを十分に小さくします。

followHyperlink(options)

キャッシュに格納された文書を表示します。 文書がキャッシュに格納されていない場合は、ハイパーリンク先にある目的の文書をダウンロードし、適切なアプリケーションで表示します。

freezeLayout()

Web ビューでのドキュメントのレイアウトを修正します。

getAnnotationById(id)

ID で注釈を取得します。 注釈が見つからない場合は、 ItemNotFound エラーをスローします。

getBookmarkRange(name)

ブックマークの範囲を取得します。 ブックマークが存在しない場合は、 ItemNotFound エラーをスローします。

getBookmarkRangeOrNullObject(name)

ブックマークの範囲を取得します。 ブックマークが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getContentControls(options)

ドキュメントで現在サポートされているコンテンツ コントロールを取得します。

getCrossReferenceItems(referenceType)

指定した相互参照の種類に基づいた相互参照の対象となる項目の配列を返します。

getCrossReferenceItems(referenceType)

指定した相互参照の種類に基づいた相互参照の対象となる項目の配列を返します。

getEndnoteBody()

文書の文末脚注を 1 つの本文で取得します。

getFootnoteBody()

文書の脚注を 1 つの本文で取得します。

getParagraphByUniqueLocalId(id)

一意のローカル ID で段落を取得します。 コレクションが空の場合は、 ItemNotFound エラーをスローします。

getRange(options)

指定した開始文字位置と終了文字位置を使用して、 Range オブジェクトを返します。

getSelection()

ドキュメントの現在の選択範囲を取得します。 複数の選択はサポートされていません。

getStyles()

ドキュメントのスタイル セット全体を表す StyleCollection オブジェクトを取得します。

goTo(options)

ページ、ブックマーク、フィールドなど、指定した項目の開始位置を表す Range オブジェクトを返します。

importStylesFromJson(stylesJson, importedStylesConflictBehavior)

JSON 形式の文字列からスタイルをインポートします。

importStylesFromJson(stylesJson, importedStylesConflictBehavior)

JSON 形式の文字列からスタイルをインポートします。

insertFileFromBase64(base64File, insertLocation, insertFileOptions)

追加のプロパティを使用して、特定の場所にあるターゲット ドキュメントにドキュメントを挿入します。 ヘッダー、フッター、透かし、およびその他のセクション プロパティは、既定でコピーされます。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

lockServerFile()

サーバー上のファイルをロックし、他の人が編集できないようにします。

makeCompatibilityDefault()

互換性オプションを設定します。

manualHyphenation()

任意指定のハイフネーションを開始し、1 行ずつ行います。

merge(fileName, options)

1 つの文書の変更履歴をほかの文書に結合します。

post()

Microsoft Exchange のパブリック フォルダーにドキュメントを投稿します。

presentIt()

Word ドキュメントが読み込まれた状態でPowerPointを開きます。

printOut(options)

ドキュメントのすべてまたは一部を印刷します。

printPreview()

表示モードを印刷プレビューに切り替えます。

protect(type, options)

未承認の変更からドキュメントを保護します。

protect(type, options)

未承認の変更からドキュメントを保護します。

redo(times)

元に戻された最後のアクションをやり直します ( undo メソッドを元に戻します)。

rejectAllRevisions()

ドキュメント内で追跡されたすべての変更を拒否します。

rejectAllRevisionsShown()

画面に表示されるドキュメント内のすべてのリビジョンを拒否します。

reload()

ハイパーリンク先の文書をダウンロードし、キャッシュに格納された文書を再度読み込みます。

reloadAs(encoding)

ドキュメント エンコードを使用して、HTML ドキュメントに基づいてドキュメントを再読み込みします。

reloadAs(encoding)

ドキュメント エンコードを使用して、HTML ドキュメントに基づいてドキュメントを再読み込みします。

removeDocumentInformation(removeDocInfoType)

機密情報、プロパティ、コメント、およびその他のメタデータをドキュメントから削除します。

removeDocumentInformation(removeDocInfoType)

機密情報、プロパティ、コメント、およびその他のメタデータをドキュメントから削除します。

removeLockedStyles()

文書で書式設定の制限が適用されている場合に、ロックされたスタイルのドキュメントを消去します。

removeNumbers(numberType)

文書から数値または箇条書きを削除します。

removeNumbers(numberType)

文書から数値または箇条書きを削除します。

removeTheme()

現在の文書で使用されているテーマを解除します。

repaginate()

文書全体で改ページ位置を自動調整します。

replyWithChanges(options)

レビューのために送信されたドキュメントの作成者に電子メール メッセージを送信し、校閲者がドキュメントのレビューを完了したことを通知します。

resetFormFields()

ドキュメント内のすべてのフォーム フィールドをクリアし、もう一度入力するフォームを準備します。

returnToLastReadPosition()

最後に保存した読み取り位置にドキュメントを返します。

runAutoMacro(autoMacro)

ドキュメントに格納されている自動マクロを実行します。 指定した自動実行マクロが存在しない場合は、何も行われません。

runAutoMacro(autoMacro)

ドキュメントに格納されている自動マクロを実行します。 指定した自動実行マクロが存在しない場合は、何も行われません。

save(saveBehavior, fileName)

ドキュメントを保存します。

save(saveBehavior, fileName)

ドキュメントを保存します。

saveAsQuickStyleSet(fileName)

現在使用しているクイック スタイルのグループを保存します。

search(searchText, searchOptions)

指定した検索オプションを使用して、ドキュメント全体のスコープで検索を実行します。 検索結果は、 Range オブジェクトのコレクションです。

select()

ドキュメントの内容を選択します。

selectContentControlsByTag(tag)

指定したタグを持つすべてのコンテンツ コントロールを返します。

selectContentControlsByTitle(title)

指定したタイトルを持つドキュメント内のすべてのコンテンツ コントロールを表す ContentControlCollection オブジェクトを返します。

selectLinkedControls(node)

特定のカスタム XML ノードにリンクされているドキュメント内のすべてのコンテンツ コントロールを表す ContentControlCollection オブジェクトを返します。

selectNodes(xPath, options)

XPath パラメーターに一致するすべてのノードをドキュメントに表示する順序で表す XmlNodeCollection オブジェクトを返します。

selectSingleNode(xPath, options)

ドキュメント内の XPath パラメーターに一致する最初のノードを表す XmlNode オブジェクトを返します。

selectUnlinkedControls(stream)

XML ノードにリンクされていないドキュメント内のすべてのコンテンツ コントロールを表す ContentControlCollection オブジェクトを返します。

sendFax(address, subject)

ユーザーの操作を行わずに、文書を FAX として送信します。

sendFaxOverInternet(options)

指定した 1 つ以上の受信者にドキュメントを FAX 送信する FAX サービス プロバイダーにドキュメントを送信します。

sendForReview(options)

指定した受信者による確認のために、電子メール メッセージでドキュメントを送信します。

sendMail()

Microsoft Exchange を介してドキュメントを送信するためのメッセージ ウィンドウを開きます。

set(properties, options)

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

set(properties)

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

setDefaultTableStyle(style, setInTemplate)

ドキュメント内の新しく作成されたテーブルに使用するテーブル スタイルを指定します。

setPasswordEncryptionOptions(passwordEncryptionProvider, passwordEncryptionAlgorithm, passwordEncryptionKeyLength, passwordEncryptFileProperties)

パスワードが設定されている文書の暗号化に使用されるオプションを設定します。

toggleFormsDesign()

フォームのデザイン モードのオンとオフを切り替えます。

toJSON()

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

track()

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

transformDocument(path, dataOnly)

指定した拡張スタイルシート言語変換 (XSLT) ファイルをこのドキュメントに適用し、ドキュメントを結果に置き換えます。

undo(times)

[元に戻す] で表示される、直前に行った操作または一連の操作を元に戻します。

undoClear()

ドキュメントで元に戻すことができるアクションの一覧をクリアします。

unprotect(password)

ドキュメントから保護を削除します。

untrack()

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

updateStyles()

添付されたテンプレートのすべてのスタイルを文書にコピーします。文書のスタイルの名前がテンプレートのスタイルの名前と同じ場合は、上書きします。

viewCode()

ドキュメントで選択した Microsoft ActiveX コントロールのコード ウィンドウを表示します。

viewPropertyBrowser()

ドキュメントで選択した Microsoft ActiveX コントロールのプロパティ ウィンドウを表示します。

webPagePreview()

Web ページとして保存されている場合と同様に、現在のドキュメントのプレビューを表示します。

イベント

onAnnotationClicked

ユーザーが注釈をクリック (または Alt + Down を使用して選択) したときに発生します。

onAnnotationHovered

ユーザーが注釈の上にカーソルを合わせると発生します。

onAnnotationInserted

ユーザーが 1 つ以上の注釈を追加するときに発生します。

onAnnotationPopupAction

ユーザーが注釈ポップアップ メニューでアクションを実行したときに発生します。

onAnnotationRemoved

ユーザーが 1 つ以上の注釈を削除するときに発生します。

onContentControlAdded

コンテンツ コントロールが追加されたときに発生します。 ハンドラーで context.sync() を実行して、新しいコンテンツ コントロールのプロパティを取得します。

onParagraphAdded

ユーザーが新しい段落を追加するときに発生します。

onParagraphChanged

ユーザーが段落を変更したときに発生します。

onParagraphDeleted

ユーザーが段落を削除したときに発生します。

プロパティの詳細

activeTheme

アクティブなテーマと書式設定オプションの名前を取得します。

readonly activeTheme: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.4 ]

activeThemeDisplayName

アクティブなテーマの表示名を取得します。

readonly activeThemeDisplayName: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.4 ]

activeWindow

ドキュメントのアクティブ ウィンドウを取得します。

readonly activeWindow: Word.Window;

プロパティ値

注釈

[ API set: WordApiDesktop 1.2 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml

await Word.run(async (context) => {
  // Gets the first paragraph of each page.
  console.log("Getting first paragraph of each page...");

  // Get the active window.
  const activeWindow: Word.Window = context.document.activeWindow;
  activeWindow.load();

  // Get the active pane.
  const activePane: Word.Pane = activeWindow.activePane;
  activePane.load();

  // Get all pages.
  const pages: Word.PageCollection = activePane.pages;
  pages.load();

  await context.sync();

  // Get page index and paragraphs of each page.
  const pagesIndexes = [];
  const pagesNumberOfParagraphs = [];
  const pagesFirstParagraphText = [];
  for (let i = 0; i < pages.items.length; i++) {
    const page = pages.items[i];
    page.load("index");
    pagesIndexes.push(page);

    const paragraphs = page.getRange().paragraphs;
    paragraphs.load("items/length");
    pagesNumberOfParagraphs.push(paragraphs);

    const firstParagraph = paragraphs.getFirst();
    firstParagraph.load("text");
    pagesFirstParagraphText.push(firstParagraph);
  }

  await context.sync();

  for (let i = 0; i < pagesIndexes.length; i++) {
    console.log(`Page index: ${pagesIndexes[i].index}`);
    console.log(`Number of paragraphs: ${pagesNumberOfParagraphs[i].items.length}`);
    console.log("First paragraph's text:", pagesFirstParagraphText[i].text);
  }
});

areFilePropertiesPasswordEncrypted

Wordでパスワードで保護されたドキュメントのファイル プロパティを暗号化するかどうかを取得します。

readonly areFilePropertiesPasswordEncrypted: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

areGrammaticalErrorsShown

文書内の波状の緑色の線で文法上のエラーをマークするかどうかを指定します。

areGrammaticalErrorsShown: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

areMathDefaultsUsed

新しい数式を作成するときに既定の数式設定を使用するかどうかを指定します。

areMathDefaultsUsed: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

areNewerFeaturesDisabled

指定したバージョンの後に導入された機能を無効にするかどうかを指定します。

areNewerFeaturesDisabled: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

areSpellingErrorsShown

Microsoft Wordドキュメント内のスペル ミスを強調するかどうかを指定します。

areSpellingErrorsShown: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

areStylesUpdatedOnOpen

ドキュメントを開くたびに、添付テンプレートのスタイルと一致するように、このドキュメント内のスタイルを更新するかどうかを指定します。

areStylesUpdatedOnOpen: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

areTrueTypeFontsEmbedded

保存時に Microsoft Wordが TrueType フォントをドキュメントに埋め込むかどうかを指定します。

areTrueTypeFontsEmbedded: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

attachedTemplate

ドキュメントにアタッチされているテンプレートを表す Template オブジェクトを指定します。

attachedTemplate: Word.Template;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

autoHyphenation

ドキュメントに対して自動ハイフネーションを有効にするかどうかを指定します。

autoHyphenation: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.3 ]

autoSaveOn

ドキュメント内の編集内容を自動的に保存するかどうかを指定します。

autoSaveOn: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.3 ]

background

ドキュメントの背景画像を表す Shape オブジェクトを取得します。

readonly background: Word.Shape;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

bibliography

ドキュメントに含まれる文献目録参照を表す Bibliography オブジェクトを返します。

readonly bibliography: Word.Bibliography;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

body

メイン ドキュメントの Body オブジェクトを取得します。 本文は、ヘッダー、フッター、脚注、テキスト ボックスなどを除外するテキストです。

readonly body: Word.Body;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

bookmarks

ドキュメント内のすべてのブックマークを表す BookmarkCollection オブジェクトを返します。

readonly bookmarks: Word.BookmarkCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

builtInDocumentProperties

ドキュメントのすべての組み込みドキュメント プロパティを表す DocumentProperties オブジェクトを取得します。

readonly builtInDocumentProperties: Word.DocumentProperties;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

changeTrackingMode

ChangeTracking モードを指定します。

changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";

プロパティ値

Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"

注釈

[ API セット: WordApi 1.4 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-change-tracking.yaml

// Gets the current change tracking mode.
await Word.run(async (context) => {
  const document: Word.Document = context.document;
  document.load("changeTrackingMode");
  await context.sync();

  if (document.changeTrackingMode === Word.ChangeTrackingMode.trackMineOnly) {
    console.log("Only my changes are being tracked.");
  } else if (document.changeTrackingMode === Word.ChangeTrackingMode.trackAll) {
    console.log("Everyone's changes are being tracked.");
  } else {
    console.log("No changes are being tracked.");
  }
});

characters

ドキュメント内のすべての文字を表す RangeScopedCollection オブジェクトを取得します。

readonly characters: Word.RangeScopedCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

coauthoring

ドキュメント内の共同編集を管理するための Coauthoring オブジェクトを取得します。

readonly coauthoring: Word.Coauthoring;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

codeName

ドキュメントのコード名を取得します。

readonly codeName: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.4 ]

comments

ドキュメント内のすべてのコメントを表す CommentCollection オブジェクトを取得します。

readonly comments: Word.CommentCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

compatibilityMode

ドキュメントを開くときに使用Word互換モードを取得します。

readonly compatibilityMode: Word.CompatibilityMode | "Word2003" | "Word2007" | "Word2010" | "Word2013" | "Current";

プロパティ値

Word.CompatibilityMode | "Word2003" | "Word2007" | "Word2010" | "Word2013" | "Current"

注釈

[ API set: WordApiDesktop 1.4 ]

consecutiveHyphensLimit

ハイフンで終わる連続する行の最大数を指定します。

consecutiveHyphensLimit: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.3 ]

content

メイン ドキュメント ストーリーを表す Range オブジェクトを取得します。

readonly content: Word.Range;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

contentControls

ドキュメント内の ContentControl オブジェクトのコレクションを取得します。 これには、ドキュメントの本文、ヘッダー、フッター、テキスト ボックスなどのコンテンツ コントロールが含まれます。

readonly contentControls: Word.ContentControlCollection;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

context

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

context: RequestContext;

プロパティ値

currentRsid

ドキュメント内の変更Word割り当てる乱数を取得します。

readonly currentRsid: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.4 ]

customDocumentProperties

ドキュメントのすべてのカスタム ドキュメント プロパティを表す DocumentProperties コレクションを取得します。

readonly customDocumentProperties: Word.DocumentProperties;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

customXmlParts

ドキュメント内のカスタム XML パーツを取得します。

readonly customXmlParts: Word.CustomXmlPartCollection;

プロパティ値

注釈

[ API セット: WordApi 1.4 ]

defaultTabStop

ドキュメント内の既定のタブ位置の間隔 (ポイント単位) を指定します。

defaultTabStop: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.4 ]

defaultTargetFrame

ハイパーリンクを使用して Web ページを表示するためのブラウザー フレームを指定します。

defaultTargetFrame: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.4 ]

documentLibraryVersions

バージョン管理が有効で、サーバー上のドキュメント ライブラリに格納されている共有ドキュメントのバージョンのコレクションを表す DocumentLibraryVersionCollection オブジェクトを返します。

readonly documentLibraryVersions: Word.DocumentLibraryVersionCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

doNotEmbedSystemFonts

一般的なシステム フォントWord埋め込むべきではないかどうかを指定します。

doNotEmbedSystemFonts: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

encryptionProvider

ドキュメントの暗号化時に Microsoft Word使用するアルゴリズム暗号化プロバイダーの名前を指定します。

encryptionProvider: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.4 ]

farEastLineBreakLanguage

改行に使用する東アジア言語を指定します。

farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese";

プロパティ値

Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"

注釈

[ API set: WordApiDesktop 1.4 ]

farEastLineBreakLevel

改行コントロール レベルを指定します。

farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom";

プロパティ値

Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"

注釈

[ API set: WordApiDesktop 1.4 ]

fields

ドキュメント内のすべてのフィールドを表す FieldCollection オブジェクトを取得します。

readonly fields: Word.FieldCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

formattingIsNextLevelShown

前の見出しを使用するときにWordに次の見出しレベルを表示するかどうかを指定します。

formattingIsNextLevelShown: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

formattingIsUserStyleNameShown

ユーザー定義スタイルを表示するかどうかを指定します。

formattingIsUserStyleNameShown: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

frames

ドキュメント内のすべてのフレームを表す FrameCollection オブジェクトを返します。

readonly frames: Word.FrameCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

fullName

パスを含むドキュメントの名前を取得します。

readonly fullName: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.4 ]

grammaticalErrors

文書内の文法チェックに失敗した文を表すRangeCollection オブジェクトを取得します。

readonly grammaticalErrors: Word.RangeCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

gridDistanceHorizontal

文書内のオートシェイプまたは東アジア文字を描画、移動、およびサイズ変更するときに、Microsoft Wordが使用する非表示の枠線間の水平方向のスペースを指定します。

gridDistanceHorizontal: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.4 ]

gridDistanceVertical

文書内のオートシェイプまたは東アジア文字を描画、移動、サイズ変更するときに Microsoft Wordが使用する非表示の枠線間の垂直スペースを指定します。

gridDistanceVertical: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.4 ]

gridIsOriginFromMargin

ページの左上隅から文字グリッドを開始するかどうかを指定します。

gridIsOriginFromMargin: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

gridOriginHorizontal

非表示グリッドの水平原点を指定します。

gridOriginHorizontal: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.4 ]

gridOriginVertical

非表示グリッドの垂直原点を指定します。

gridOriginVertical: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.4 ]

gridSpaceBetweenHorizontalLines

印刷レイアウト ビューの水平方向の文字グリッド線の間隔を指定します。

gridSpaceBetweenHorizontalLines: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.4 ]

gridSpaceBetweenVerticalLines

印刷レイアウト ビューの垂直文字グリッド線の間隔を指定します。

gridSpaceBetweenVerticalLines: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.4 ]

hasPassword

ドキュメントを開くためにパスワードが必要かどうかを取得します。

readonly hasPassword: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

hasVbProject

ドキュメントに Microsoft Visual Basic for Applications プロジェクトが添付されているかどうかを取得します。

readonly hasVbProject: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

ドキュメント内のすべてのハイパーリンクを表す HyperlinkCollection オブジェクトを返します。

readonly hyperlinks: Word.HyperlinkCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

hyphenateCaps

すべての大文字の単語をハイフネーションできるかどうかを指定します。

hyphenateCaps: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.3 ]

hyphenationZone

ハイフネーション ゾーンの幅をポイント単位で指定します。

hyphenationZone: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.4 ]

indexes

ドキュメント内のすべてのインデックスを表す IndexCollection オブジェクトを返します。

readonly indexes: Word.IndexCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

isAutoFormatOverrideOn

自動書式設定オプションが書式設定の制限をオーバーライドするかどうかを指定します。

isAutoFormatOverrideOn: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isChartDataPointTracked

作業中の文書のグラフでセル参照データ ポイント追跡を使用するかどうかを指定します。

isChartDataPointTracked: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isCompatible

type プロパティで指定された互換性オプションを有効にするかどうかを指定します。

isCompatible: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isFinal

ドキュメントが最終的かどうかを指定します。

isFinal: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isFontsSubsetSaved

Microsoft Word埋め込み TrueType フォントのサブセットをドキュメントと共に保存するかどうかを指定します。

isFontsSubsetSaved: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isFormsDataPrinted

Microsoft Wordが、対応するオンライン フォームに入力されたデータのみを、印刷済みのフォームに印刷するかどうかを指定します。

isFormsDataPrinted: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isFormsDataSaved

Microsoft Wordフォームに入力されたデータを、データベースで使用するタブ区切りレコードとして保存するかどうかを指定します。

isFormsDataSaved: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isGrammarChecked

文書で文法チェックが実行されているかどうかを指定します。

isGrammarChecked: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isInAutoSave

Application.DocumentBeforeSave イベントの最新の起動が、ドキュメントによる自動保存の結果か、ユーザーによる手動保存の結果かを取得します。

readonly isInAutoSave: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isInFormsDesign

ドキュメントがフォーム デザイン モードであるかどうかを取得します。

readonly isInFormsDesign: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isKerningByAlgorithm

半角ラテン文字と句読点をWordするかどうかを指定します。

isKerningByAlgorithm: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isLinguisticDataEmbedded

音声データと手書きデータを埋め込むかどうかを指定します。

isLinguisticDataEmbedded: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isMasterDocument

このドキュメントがマスター ドキュメントであるかどうかを取得します。

readonly isMasterDocument: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isOptimizedForWord97

Wordがドキュメントを Word 97 用に最適化するかどうかを指定します。

isOptimizedForWord97: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isPostScriptPrintedOverText

PostScript プリンターを使用するときに、文書内の PRINT フィールド 命令 (PostScript コマンドなど) をテキストとグラフィックの上に印刷するかどうかを指定します。

isPostScriptPrintedOverText: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isQuickStyleSetLocked

ユーザーがクイック スタイル セットを変更できるかどうかを指定します。

isQuickStyleSetLocked: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isReadOnly

ドキュメントに対する変更を元のドキュメントに保存できないかどうかを取得します。

readonly isReadOnly: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isReadOnlyRecommended

ユーザーがドキュメントを開いたときに Microsoft Wordメッセージ ボックスを表示するかどうかを指定し、ドキュメントを読み取り専用として開くことを提案します。

isReadOnlyRecommended: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isSnappedToGrid

オートシェイプ文字または東アジア文字を非表示のグリッドに自動的に配置するかどうかを指定します。

isSnappedToGrid: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isSnappedToShapes

オートシェイプ文字または東アジア文字を、他の図形を通して非表示のグリッド線と一致するかどうかを指定します。

isSnappedToShapes: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isSpellingChecked

文書全体でスペル チェックを行うかどうかを指定します。

isSpellingChecked: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isStyleEnforced

保護されたドキュメントで書式設定の制限を適用するかどうかを指定します。

isStyleEnforced: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isSubdocument

このドキュメントがマスター ドキュメントのサブ文書であるかどうかを取得します。

readonly isSubdocument: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isThemeLocked

ユーザーがドキュメント テーマを変更できるかどうかを指定します。

isThemeLocked: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isUserControl

ユーザーがドキュメントを作成または開いたかどうかを指定します。

isUserControl: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isVbaSigned

VBA プロジェクトがデジタル署名されているかどうかを取得します。

readonly isVbaSigned: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

isWriteReserved

ドキュメントが書き込みパスワードで保護されているかどうかを取得します。

readonly isWriteReserved: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

justificationMode

文字間隔の調整を指定します。

justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana";

プロパティ値

Word.JustificationMode | "Expand" | "Compress" | "CompressKana"

注釈

[ API set: WordApiDesktop 1.4 ]

kind

Microsoft Wordがドキュメントを自動的に書式設定するときに使用する書式の種類を指定します。

kind: Word.DocumentKind | "NotSpecified" | "Letter" | "Email";

プロパティ値

Word.DocumentKind | "NotSpecified" | "Letter" | "Email"

注釈

[ API set: WordApiDesktop 1.4 ]

languageDetected

Microsoft Wordがドキュメント テキストの言語を検出したかどうかを指定します。

languageDetected: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.3 ]

listParagraphs

ドキュメント内のすべての段落番号を表す ParagraphCollection オブジェクトを取得します。

readonly listParagraphs: Word.ParagraphCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

lists

ドキュメント内のすべての書式設定されたリストを含む ListCollection オブジェクトを取得します。

readonly lists: Word.ListCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

listTemplates

ドキュメント内のすべてのリスト テンプレートを表す ListTemplateCollection オブジェクトを返します。

readonly listTemplates: Word.ListTemplateCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

noLineBreakAfter

その後、Wordが行を区切らない kinsoku 文字を指定します。

noLineBreakAfter: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.4 ]

noLineBreakBefore

Wordが改行しない前の kinsoku 文字を指定します。

noLineBreakBefore: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.4 ]

openEncoding

ドキュメントを開くために使用するエンコードを取得します。

readonly openEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

プロパティ値

Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"

注釈

[ API set: WordApiDesktop 1.4 ]

originalDocumentTitle

法的ブラックライン比較後の元のドキュメントのタイトルを取得します。

readonly originalDocumentTitle: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.4 ]

pageSetup

ドキュメントに関連付けられている PageSetup オブジェクトを返します。

readonly pageSetup: Word.PageSetup;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

paragraphs

ドキュメント内のすべての段落を表す ParagraphCollection オブジェクトを取得します。

readonly paragraphs: Word.ParagraphCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

password

ドキュメントを開くために指定する必要があるパスワードを設定します。

password: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.4 ]

passwordEncryptionAlgorithm

パスワード暗号化に使用されるアルゴリズムを取得します。

readonly passwordEncryptionAlgorithm: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.4 ]

passwordEncryptionKeyLength

パスワード暗号化に使用されるキーの長さを取得します。

readonly passwordEncryptionKeyLength: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.4 ]

passwordEncryptionProvider

パスワード暗号化プロバイダーの名前を取得します。

readonly passwordEncryptionProvider: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.4 ]

path

ドキュメントのディスクまたは Web パスを取得します (ドキュメント名は除外されます)。

readonly path: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.4 ]

printRevisions

文書にリビジョン マークを印刷するかどうかを指定します。

printRevisions: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

properties

ドキュメントのプロパティを取得します。

readonly properties: Word.DocumentProperties;

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/get-built-in-properties.yaml

await Word.run(async (context) => {
    const builtInProperties: Word.DocumentProperties = context.document.properties;
    builtInProperties.load("*"); // Let's get all!

    await context.sync();
    console.log(JSON.stringify(builtInProperties, null, 4));
});

protectionType

ドキュメントの保護の種類を取得します。

readonly protectionType: Word.ProtectionType | "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading";

プロパティ値

Word.ProtectionType | "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading"

注釈

[ API set: WordApiDesktop 1.4 ]

readabilityStatistics

ドキュメントの読みやすさ統計を表す ReadabilityStatisticCollection オブジェクトを取得します。

readonly readabilityStatistics: Word.ReadabilityStatisticCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

readingLayoutSizeX

固定された場合の読み取りレイアウト ビューのページ幅を指定します。

readingLayoutSizeX: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.4 ]

readingLayoutSizeY

固定時の読み取りレイアウト ビューのページの高さを指定します。

readingLayoutSizeY: number;

プロパティ値

number

注釈

[ API set: WordApiDesktop 1.4 ]

readingModeIsLayoutFrozen

読み取りレイアウト ビューのページを手書きマークアップ用に固定するかどうかを指定します。

readingModeIsLayoutFrozen: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

removePersonalInformationOnSave

保存時にユーザー情報Word削除するかどうかを指定します。

removePersonalInformationOnSave: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

revisedDocumentTitle

法律と黒線の比較の後に変更されたドキュメントのタイトルを取得します。

readonly revisedDocumentTitle: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.4 ]

revisions

ドキュメント内の変更履歴を表すリビジョンのコレクションを取得します。

readonly revisions: Word.RevisionCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

saved

ドキュメント内の変更が保存されているかどうかを示します。 trueの値は、ドキュメントが保存されてから変更されなかったことを示します。

readonly saved: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

saveEncoding

ドキュメントを保存するときに使用するエンコードを指定します。

saveEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

プロパティ値

Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"

注釈

[ API set: WordApiDesktop 1.4 ]

saveFormat

ドキュメントのファイル形式を取得します。

readonly saveFormat: Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument";

プロパティ値

Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument"

注釈

[ API set: WordApiDesktop 1.4 ]

sections

ドキュメント内の Section オブジェクトのコレクションを取得します。

readonly sections: Word.SectionCollection;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

selection

ドキュメント内の現在の選択範囲を表す Selection オブジェクトを返します。

readonly selection: Word.Selection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

sentences

ドキュメント内のすべての文を表す RangeScopedCollection オブジェクトを取得します。

readonly sentences: Word.RangeScopedCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

settings

ドキュメント内のアドインの設定を取得します。

readonly settings: Word.SettingCollection;

プロパティ値

注釈

[ API セット: WordApi 1.4 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-settings.yaml

// Gets all custom settings this add-in set on this document.
await Word.run(async (context) => {
  const settings: Word.SettingCollection = context.document.settings;
  settings.load("items");
  await context.sync();

  if (settings.items.length == 0) {
    console.log("There are no settings.");
  } else {
    console.log("All settings:");
    for (let i = 0; i < settings.items.length; i++) {
      console.log(settings.items[i]);
    }
  }
});

spellingErrors

文書のスペル ミスとして識別される単語を表す RangeCollection オブジェクトを取得します。

readonly spellingErrors: Word.RangeCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

storyRanges

ドキュメント内のすべてのストーリーを表す RangeCollection オブジェクトを取得します。

readonly storyRanges: Word.RangeCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

styles

ドキュメントの StyleCollection を取得します。

readonly styles: Word.StyleCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

tableOfAuthoritiesCategories

ドキュメント内の使用可能な権限カテゴリのテーブルを表す TableOfAuthoritiesCategoryCollection オブジェクトを返します。

readonly tableOfAuthoritiesCategories: Word.TableOfAuthoritiesCategoryCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

tables

ドキュメント内のすべてのテーブルを表す TableCollection オブジェクトを取得します。

readonly tables: Word.TableCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

tablesOfAuthorities

ドキュメント内のすべての権限テーブルを表す TableOfAuthoritiesCollection オブジェクトを返します。

readonly tablesOfAuthorities: Word.TableOfAuthoritiesCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

tablesOfContents

ドキュメント内のすべての目次を表す TableOfContentsCollection オブジェクトを返します。

readonly tablesOfContents: Word.TableOfContentsCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

tablesOfFigures

ドキュメント内のすべての図形テーブルを表す TableOfFiguresCollection オブジェクトを返します。

readonly tablesOfFigures: Word.TableOfFiguresCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

textEncoding

エンコードされたテキストとして保存するエンコードを指定します。

textEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

プロパティ値

Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"

注釈

[ API set: WordApiDesktop 1.4 ]

textLineEnding

テキスト ファイルWord改行と段落区切りをマークする方法を指定します。

textLineEnding: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps";

プロパティ値

Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps"

注釈

[ API set: WordApiDesktop 1.4 ]

trackedChangesAreDateAndTimeRemoved

追跡された変更の日付と時刻のメタデータを削除または格納するかどうかを指定します。

trackedChangesAreDateAndTimeRemoved: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

trackFormatting

変更の追跡がオンのときに書式設定の変更を追跡するかどうかを指定します。

trackFormatting: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

trackMoves

変更履歴がオンのときに移動したテキストをマークするかどうかを指定します。

trackMoves: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

trackRevisions

ドキュメント内の変更を追跡するかどうかを指定します。

trackRevisions: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

type

ドキュメントの種類 (テンプレートまたはドキュメント) を取得します。

readonly type: Word.DocumentType | "Document" | "Template" | "Frameset";

プロパティ値

Word.DocumentType | "Document" | "Template" | "Frameset"

注釈

[ API set: WordApiDesktop 1.4 ]

webSettings

Web ページ関連の属性の WebSettings オブジェクトを取得します。

readonly webSettings: Word.WebSettings;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

windows

ドキュメントの Word.Window オブジェクトのコレクションを取得します。

readonly windows: Word.WindowCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.2 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml

await Word.run(async (context) => {
  // Gets the document windows.
  const windows: Word.WindowCollection = context.document.windows;
  windows.load("windows/items/length");

  await context.sync();

  console.log(`Number of windows for this document: ${windows.items.length}`);
});

words

ドキュメント内の各単語を表す RangeScopedCollection オブジェクトを取得します。

readonly words: Word.RangeScopedCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.4 ]

writePassword

ドキュメントへの変更を保存するためのパスワードを設定します。

writePassword: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.4 ]

xmlAreAdvancedErrorsShown

組み込みのWordメッセージまたは MSXML (Microsoft XML) からエラー メッセージを生成するかどうかを指定します。

xmlAreAdvancedErrorsShown: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

xmlIsXsltUsedWhenSaving

拡張スタイルシート言語変換 (XSLT) を使用してドキュメントを保存するかどうかを指定します。

xmlIsXsltUsedWhenSaving: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.4 ]

xmlSaveThroughXslt

ドキュメントを保存するときに適用する XSLT のパスとファイル名を指定します。

xmlSaveThroughXslt: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.4 ]

メソッドの詳細

acceptAllRevisions()

ドキュメント内で追跡されたすべての変更を受け入れます。

acceptAllRevisions(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

acceptAllRevisionsShown()

画面に表示されるドキュメント内のすべてのリビジョンを受け入れます。

acceptAllRevisionsShown(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

activate()

作業中の文書になるようにドキュメントをアクティブにします。

activate(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

addStyle(name, type)

名前と種類によってスタイルをドキュメントに追加します。

addStyle(name: string, type: Word.StyleType): Word.Style;

パラメーター

name

string

スタイル名を表す文字列。

type
Word.StyleType

文字、リスト、段落、またはテーブルを含むスタイルの種類。

戻り値

注釈

[ API セット: WordApi 1.5 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml

// Adds a new style.
await Word.run(async (context) => {
  const newStyleName = (document.getElementById("new-style-name") as HTMLInputElement).value;
  if (newStyleName == "") {
    console.warn("Enter a style name to add.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(newStyleName);
  style.load();
  await context.sync();

  if (!style.isNullObject) {
    console.warn(
      `There's an existing style with the same name '${newStyleName}'! Please provide another style name.`
    );
    return;
  }

  const newStyleType = ((document.getElementById("new-style-type") as HTMLSelectElement).value as unknown) as Word.StyleType;
  context.document.addStyle(newStyleName, newStyleType);
  await context.sync();

  console.log(newStyleName + " has been added to the style list.");
});

addStyle(name, type)

名前と種類によってスタイルをドキュメントに追加します。

addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style;

パラメーター

name

string

スタイル名を表す文字列。

type

"Character" | "List" | "Paragraph" | "Table"

文字、リスト、段落、またはテーブルを含むスタイルの種類。

戻り値

注釈

[ API セット: WordApi 1.5 ]

addToFavorites()

ドキュメントまたはハイパーリンクへのショートカットを作成し、[ お気に入り ] フォルダーに追加します。

addToFavorites(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

applyQuickStyleSet(style)

指定したクイック スタイルを文書に適用します。

applyQuickStyleSet(style: Word.ApplyQuickStyleSet): void;

パラメーター

style
Word.ApplyQuickStyleSet

適用するスタイル セット。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

applyQuickStyleSet(style)

指定したクイック スタイルを文書に適用します。

applyQuickStyleSet(style: "SessionStart" | "Template"): void;

パラメーター

style

"SessionStart" | "Template"

適用するスタイル セット。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

applyTheme(name)

指定したテーマをこのドキュメントに適用します。

applyTheme(name: string): void;

パラメーター

name

string

テーマの名前。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

autoFormat()

ドキュメントの書式を自動的に設定します。

autoFormat(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

canCheckin()

Microsoft Wordがドキュメント内をサーバーにチェックできる場合は、trueを返します。

canCheckin(): OfficeExtension.ClientResult<boolean>;

戻り値

true ドキュメントをチェックインできる場合。それ以外の場合は、 false

注釈

[ API set: WordApiDesktop 1.4 ]

checkConsistencyJapanese()

日本語の文書内のすべての文字列を検索し、同じ単語に対して文字の使い方が一貫していないインスタンスを表示します。

checkConsistencyJapanese(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

checkGrammar()

文書のスペル チェックと文章校正チェックを開始します。

checkGrammar(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

checkIn(options)

注意

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

ローカル コンピューターからサーバーにドキュメントをチェックインし、ローカルで編集できないようにローカル ドキュメントを読み取り専用に設定します。

checkIn(options?: Word.DocumentCheckInOptions): void;

パラメーター

options
Word.DocumentCheckInOptions

省略可能。 ドキュメントをチェックインするための構成オプション。

戻り値

void

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

checkInWithVersion(options)

注意

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

ローカル コンピューターからサーバーにドキュメントを保存し、ローカルで編集できないように、ローカル ドキュメントを読み取り専用に設定します。

checkInWithVersion(options?: Word.DocumentCheckInWithVersionOptions): void;

パラメーター

options
Word.DocumentCheckInWithVersionOptions

省略可能。 バージョン管理を使用してドキュメントをチェックインするための構成オプション。

戻り値

void

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

checkSpelling(options)

注意

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

文書のスペル チェックを開始します。

checkSpelling(options?: Word.DocumentCheckSpellingOptions): void;

パラメーター

options
Word.DocumentCheckSpellingOptions

省略可能。 スペル チェック操作の構成オプション。

戻り値

void

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

close(closeBehavior)

現在のドキュメントを閉じます。

注: この API は、web 上のWordではサポートされていません。

close(closeBehavior?: Word.CloseBehavior): void;

パラメーター

closeBehavior
Word.CloseBehavior

省略可能。 閉じる動作は、 save または skipSaveする必要があります。 既定値は saveです。

戻り値

void

注釈

[ API セット: WordApi 1.5 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/save-close.yaml

// Closes the document with default behavior
// for current state of the document.
await Word.run(async (context) => {
  context.document.close();
});

close(closeBehavior)

現在のドキュメントを閉じます。

注: この API は、web 上のWordではサポートされていません。

close(closeBehavior?: "Save" | "SkipSave"): void;

パラメーター

closeBehavior

"Save" | "SkipSave"

省略可能。 閉じる動作は、 save または skipSaveする必要があります。 既定値は saveです。

戻り値

void

注釈

[ API セット: WordApi 1.5 ]

closePrintPreview()

ドキュメントを印刷プレビューから前のビューに切り替えます。

closePrintPreview(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

compare(filePath, documentCompareOptions)

指定された文書と別の文書を比較して、変更箇所を示す変更履歴を表示します。

compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void;

パラメーター

filePath

string

指定したドキュメントを比較するドキュメントのパス。

documentCompareOptions
Word.DocumentCompareOptions

省略可能。 ドキュメントの比較の動作を指定する追加のオプション。

戻り値

void

注釈

[ API セット: WordApiDesktop 1.1 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/compare-documents.yaml

// Compares the current document with a specified external document.
await Word.run(async (context) => {
  // Absolute path of an online or local document.
  const filePath = (document.getElementById("filePath") as HTMLInputElement).value;
  // Options that configure the compare operation.
  const options: Word.DocumentCompareOptions = {
    compareTarget: Word.CompareTarget.compareTargetCurrent,
    detectFormatChanges: false
    // Other options you choose...
    };
  context.document.compare(filePath, options);

  await context.sync();

  console.log("Differences shown in the current document.");
});

compareFromBase64(base64File, documentCompareOptions)

指定された文書と別の文書を比較して、変更箇所を示す変更履歴を表示します。

compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void;

パラメーター

base64File

string

指定したドキュメントを比較するドキュメントの Base64 でエンコードされたコンテンツ。

documentCompareOptions
Word.DocumentCompareOptions

省略可能。 ドキュメントを比較するための動作を指定する追加のオプション。 compareTarget オプションは、この API ではcompareTargetSelectedできないことに注意してください。

戻り値

void

注釈

[ API set: WordApiDesktop 1.2 ]

computeStatistics(statistic, includeFootnotesAndEndnotes)

注意

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

ドキュメントの内容に基づいて統計を返します。

computeStatistics(statistic: Word.StatisticType, includeFootnotesAndEndnotes?: boolean): OfficeExtension.ClientResult<number>;

パラメーター

statistic
Word.StatisticType

返す統計の種類。

includeFootnotesAndEndnotes

boolean

省略可能。 脚注と脚注を含めるかどうか。 既定値は falseです。

戻り値

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

computeStatistics(statistic, includeFootnotesAndEndnotes)

注意

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

ドキュメントの内容に基づいて統計を返します。

computeStatistics(statistic: "Words" | "Lines" | "Pages" | "Characters" | "Paragraphs" | "CharactersWithSpaces" | "FarEastCharacters", includeFootnotesAndEndnotes?: boolean): OfficeExtension.ClientResult<number>;

パラメーター

statistic

"Words" | "Lines" | "Pages" | "Characters" | "Paragraphs" | "CharactersWithSpaces" | "FarEastCharacters"

返す統計の種類。

includeFootnotesAndEndnotes

boolean

省略可能。 脚注と脚注を含めるかどうか。 既定値は falseです。

戻り値

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

convert()

ファイルを最新の形式に変換し、すべての機能を有効にします。

convert(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

convertAutoHyphens()

自動ハイフンを手動ハイフンに変換します。

convertAutoHyphens(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

convertNumbersToText(numberType)

ドキュメント内のリスト番号と LISTNUM フィールド をテキストに変更します。

convertNumbersToText(numberType?: Word.NumberType): void;

パラメーター

numberType
Word.NumberType

省略可能。 変換する番号付けの種類。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

convertNumbersToText(numberType)

ドキュメント内のリスト番号と LISTNUM フィールド をテキストに変更します。

convertNumbersToText(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): void;

パラメーター

numberType

"Paragraph" | "ListNum" | "AllNumbers"

省略可能。 変換する番号付けの種類。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

convertVietnameseDocument(codePageOrigin)

既定値以外のコード ページを使用して、ベトナム語の文書を Unicode に再変換します。

convertVietnameseDocument(codePageOrigin: number): void;

パラメーター

codePageOrigin

number

使用するコード ページ。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

copyStylesFromTemplate(StyleTemplate)

指定したテンプレートからドキュメントにスタイルをコピーします。

copyStylesFromTemplate(StyleTemplate: string): void;

パラメーター

StyleTemplate

string

スタイルをコピーするテンプレート。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

countNumberedItems(options)

注意

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

文書内の箇条書き項目または番号付き項目と LISTNUM フィールド の数を返します。

countNumberedItems(options?: Word.DocumentCountNumberedItemsOptions): OfficeExtension.ClientResult<number>;

パラメーター

options
Word.DocumentCountNumberedItemsOptions

省略可能。 番号付き項目をカウントするための構成オプション。

戻り値

番号付き項目の数。

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

deleteAllComments()

ドキュメントからすべてのコメントを削除します。

deleteAllComments(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

deleteAllCommentsShown()

画面に表示されている文書内のすべてのリビジョンを削除します。

deleteAllCommentsShown(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

deleteAllInkAnnotations()

ドキュメント内のすべての手書きインク注釈を削除します。

deleteAllInkAnnotations(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

deleteBookmark(name)

ブックマークが存在する場合は、ドキュメントから削除します。

deleteBookmark(name: string): void;

パラメーター

name

string

大文字と小文字を区別しないブックマーク名。

戻り値

void

注釈

[ API セット: WordApi 1.4 ]

detectLanguage()

ドキュメント テキストを分析して言語を決定します。

detectLanguage(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.3 ]

endReview(options)

注意

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

レビューのために送信されたファイルのレビューを終了します。

endReview(options?: Word.DocumentEndReviewOptions): void;

パラメーター

options
Word.DocumentEndReviewOptions

省略可能。 レビュー プロセスを終了するための構成オプション。

戻り値

void

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

exportAsFixedFormat(outputFileName, exportFormat, options)

注意

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

ドキュメントを PDF または XPS 形式で保存します。

exportAsFixedFormat(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormatOptions): void;

パラメーター

outputFileName

string

出力ファイルの名前。

exportFormat
Word.ExportFormat

エクスポート形式。

options
Word.DocumentExportAsFixedFormatOptions

省略可能。 エクスポート操作の構成オプション。

戻り値

void

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

exportAsFixedFormat(outputFileName, exportFormat, options)

注意

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

ドキュメントを PDF または XPS 形式で保存します。

exportAsFixedFormat(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormatOptions): void;

パラメーター

outputFileName

string

出力ファイルの名前。

exportFormat

"Pdf" | "Xps"

エクスポート形式。

options
Word.DocumentExportAsFixedFormatOptions

省略可能。 エクスポート操作の構成オプション。

戻り値

void

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

exportAsFixedFormat2(outputFileName, exportFormat, options)

注意

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

ドキュメントを PDF または XPS 形式で保存します。

exportAsFixedFormat2(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat2Options): void;

パラメーター

outputFileName

string

出力ファイル名。

exportFormat
Word.ExportFormat

エクスポートする形式 (PDF/XPS)。

options
Word.DocumentExportAsFixedFormat2Options

省略可能。 エクスポート操作の構成オプション。

戻り値

void

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

exportAsFixedFormat2(outputFileName, exportFormat, options)

注意

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

ドキュメントを PDF または XPS 形式で保存します。

exportAsFixedFormat2(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormat2Options): void;

パラメーター

outputFileName

string

出力ファイル名。

exportFormat

"Pdf" | "Xps"

エクスポートする形式 (PDF/XPS)。

options
Word.DocumentExportAsFixedFormat2Options

省略可能。 エクスポート操作の構成オプション。

戻り値

void

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

exportAsFixedFormat3(outputFileName, exportFormat, options)

注意

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

タグ付けを改善して、ドキュメントを PDF または XPS 形式で保存します。

exportAsFixedFormat3(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat3Options): void;

パラメーター

outputFileName

string

出力ファイル名。

exportFormat
Word.ExportFormat

エクスポートする形式 (PDF/XPS)。

options
Word.DocumentExportAsFixedFormat3Options

省略可能。 エクスポート操作の構成オプション。

戻り値

void

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

exportAsFixedFormat3(outputFileName, exportFormat, options)

注意

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

タグ付けを改善して、ドキュメントを PDF または XPS 形式で保存します。

exportAsFixedFormat3(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormat3Options): void;

パラメーター

outputFileName

string

出力ファイル名。

exportFormat

"Pdf" | "Xps"

エクスポートする形式 (PDF/XPS)。

options
Word.DocumentExportAsFixedFormat3Options

省略可能。 エクスポート操作の構成オプション。

戻り値

void

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

fitToPages()

ドキュメント ページ数が 1 ずつ減少するように、テキストのフォント サイズを十分に小さくします。

fitToPages(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

注意

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

キャッシュに格納された文書を表示します。 文書がキャッシュに格納されていない場合は、ハイパーリンク先にある目的の文書をダウンロードし、適切なアプリケーションで表示します。

followHyperlink(options?: Word.DocumentFollowHyperlinkOptions): void;

パラメーター

options
Word.DocumentFollowHyperlinkOptions

省略可能。 ハイパーリンクに従う構成オプション。

戻り値

void

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

freezeLayout()

Web ビューでのドキュメントのレイアウトを修正します。

freezeLayout(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

getAnnotationById(id)

ID で注釈を取得します。 注釈が見つからない場合は、 ItemNotFound エラーをスローします。

getAnnotationById(id: string): Word.Annotation;

パラメーター

id

string

取得する注釈の ID。

戻り値

注釈

[ API セット: WordApi 1.7 ]

getBookmarkRange(name)

ブックマークの範囲を取得します。 ブックマークが存在しない場合は、 ItemNotFound エラーをスローします。

getBookmarkRange(name: string): Word.Range;

パラメーター

name

string

大文字と小文字を区別しないブックマーク名。

戻り値

注釈

[ API セット: WordApi 1.4 ]

getBookmarkRangeOrNullObject(name)

ブックマークの範囲を取得します。 ブックマークが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getBookmarkRangeOrNullObject(name: string): Word.Range;

パラメーター

name

string

大文字と小文字を区別しないブックマーク名。

戻り値

注釈

[ API セット: WordApi 1.4 ]

getContentControls(options)

ドキュメントで現在サポートされているコンテンツ コントロールを取得します。

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

パラメーター

options
Word.ContentControlOptions

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

戻り値

注釈

[ API セット: WordApi 1.5 ]

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

// 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 on all checkbox content controls.
await Word.run(async (context) => {
  let contentControls = context.document.getContentControls({
    types: [Word.ContentControlType.checkBox]
  });
  contentControls.load("items");

  await context.sync();

  const length = contentControls.items.length;
  console.log(`Number of checkbox content controls: ${length}`);

  if (length <= 0) {
    return;
  }

  const checkboxContentControls = [];
  for (let i = 0; i < length; i++) {
    let contentControl = contentControls.items[i];
    contentControl.load("id,checkboxContentControl/isChecked");
    checkboxContentControls.push(contentControl);
  }

  await context.sync();

  console.log("isChecked state before:");
  const updatedCheckboxContentControls = [];
  for (let i = 0; i < checkboxContentControls.length; i++) {
    const currentCheckboxContentControl = checkboxContentControls[i];
    const isCheckedBefore = currentCheckboxContentControl.checkboxContentControl.isChecked;
    console.log(`id: ${currentCheckboxContentControl.id} ... isChecked: ${isCheckedBefore}`);

    currentCheckboxContentControl.checkboxContentControl.isChecked = !isCheckedBefore;
    currentCheckboxContentControl.load("id,checkboxContentControl/isChecked");
    updatedCheckboxContentControls.push(currentCheckboxContentControl);
  }

  await context.sync();

  console.log("isChecked state after:");
  for (let i = 0; i < updatedCheckboxContentControls.length; i++) {
    const currentCheckboxContentControl = updatedCheckboxContentControls[i];
    console.log(
      `id: ${currentCheckboxContentControl.id} ... isChecked: ${currentCheckboxContentControl.checkboxContentControl.isChecked}`
    );
  }
});

getCrossReferenceItems(referenceType)

指定した相互参照の種類に基づいた相互参照の対象となる項目の配列を返します。

getCrossReferenceItems(referenceType: Word.ReferenceType): OfficeExtension.ClientResult<string[]>;

パラメーター

referenceType
Word.ReferenceType

参照の種類。

戻り値

注釈

[ API set: WordApiDesktop 1.4 ]

getCrossReferenceItems(referenceType)

指定した相互参照の種類に基づいた相互参照の対象となる項目の配列を返します。

getCrossReferenceItems(referenceType: "NumberedItem" | "Heading" | "Bookmark" | "Footnote" | "Endnote"): OfficeExtension.ClientResult<string[]>;

パラメーター

referenceType

"NumberedItem" | "Heading" | "Bookmark" | "Footnote" | "Endnote"

参照の種類。

戻り値

注釈

[ API set: WordApiDesktop 1.4 ]

getEndnoteBody()

文書の文末脚注を 1 つの本文で取得します。

getEndnoteBody(): Word.Body;

戻り値

注釈

[ API セット: WordApi 1.5 ]

getFootnoteBody()

文書の脚注を 1 つの本文で取得します。

getFootnoteBody(): Word.Body;

戻り値

注釈

[ API セット: WordApi 1.5 ]

getParagraphByUniqueLocalId(id)

一意のローカル ID で段落を取得します。 コレクションが空の場合は、 ItemNotFound エラーをスローします。

getParagraphByUniqueLocalId(id: string): Word.Paragraph;

パラメーター

id

string

標準の 8-4-4-4-12 GUID 形式の一意のローカル ID(中かっこなし)。 ID は、セッションと共同編集者によって異なる点に注意してください。

戻り値

注釈

[ API セット: WordApi 1.6 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onadded-event.yaml

await Word.run(async (context) => {
  const paragraphId = (document.getElementById("paragraph-id") as HTMLInputElement).value;
  const paragraph: Word.Paragraph = context.document.getParagraphByUniqueLocalId(paragraphId);
  paragraph.load();
  await paragraph.context.sync();

  console.log(paragraph);
});

getRange(options)

注意

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

指定した開始文字位置と終了文字位置を使用して、 Range オブジェクトを返します。

getRange(options?: Word.DocumentRangeOptions): Word.Range;

パラメーター

options
Word.DocumentRangeOptions

省略可能。 範囲パラメーターを指定するための構成オプション。

戻り値

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

getSelection()

ドキュメントの現在の選択範囲を取得します。 複数の選択はサポートされていません。

getSelection(): Word.Range;

戻り値

注釈

[ API セット: WordApi 1.1 ]

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    const textSample = 'This is an example of the insert text method. This is a method ' + 
        'which allows users to insert text into a selection. It can insert text into a ' +
        'relative location or it can overwrite the current selection. Since the ' +
        'getSelection method returns a range object, look up the range object documentation ' +
        'for everything you can do with a selection.';
    
    // Create a range proxy object for the current selection.
    const range = context.document.getSelection();
    
    // Queue a command to insert text at the end of the selection.
    range.insertText(textSample, Word.InsertLocation.end);
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Inserted the text at the end of the selection.');
});  

getStyles()

ドキュメントのスタイル セット全体を表す StyleCollection オブジェクトを取得します。

getStyles(): Word.StyleCollection;

戻り値

注釈

[ API セット: WordApi 1.5 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml

// Gets the number of available styles stored with the document.
await Word.run(async (context) => {
  const styles: Word.StyleCollection = context.document.getStyles();
  const count = styles.getCount();
  await context.sync();

  console.log(`Number of styles: ${count.value}`);
});

goTo(options)

注意

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

ページ、ブックマーク、フィールドなど、指定した項目の開始位置を表す Range オブジェクトを返します。

goTo(options?: Word.GoToOptions): Word.Range;

パラメーター

options
Word.GoToOptions

省略可能。 goTo パラメーターを指定するための構成オプション。

戻り値

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

importStylesFromJson(stylesJson, importedStylesConflictBehavior)

JSON 形式の文字列からスタイルをインポートします。

importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult<string[]>;

パラメーター

stylesJson

string

スタイルを表す JSON 形式の文字列。

importedStylesConflictBehavior
Word.ImportedStylesConflictBehavior

省略可能。 現在の文書内の既存のスタイルと同じ名前のインポートされたスタイルを処理する方法を指定します。 既定値は ignoreです。

戻り値

注釈

[ API セット: WordApi 1.6 ]

注: importedStylesConflictBehavior パラメーターは WordApiDesktop 1.1 で導入されました。

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-custom-style.yaml

// Imports styles from JSON.
await Word.run(async (context) => {
  const str =
    '{"styles":[{"baseStyle":"Default Paragraph Font","builtIn":false,"inUse":true,"linked":false,"nameLocal":"NewCharStyle","priority":2,"quickStyle":true,"type":"Character","unhideWhenUsed":false,"visibility":false,"paragraphFormat":null,"font":{"name":"DengXian Light","size":16.0,"bold":true,"italic":false,"color":"#F1A983","underline":"None","subscript":false,"superscript":true,"strikeThrough":true,"doubleStrikeThrough":false,"highlightColor":null,"hidden":false},"shading":{"backgroundPatternColor":"#FF0000"}},{"baseStyle":"Normal","builtIn":false,"inUse":true,"linked":false,"nextParagraphStyle":"NewParaStyle","nameLocal":"NewParaStyle","priority":1,"quickStyle":true,"type":"Paragraph","unhideWhenUsed":false,"visibility":false,"paragraphFormat":{"alignment":"Centered","firstLineIndent":0.0,"keepTogether":false,"keepWithNext":false,"leftIndent":72.0,"lineSpacing":18.0,"lineUnitAfter":0.0,"lineUnitBefore":0.0,"mirrorIndents":false,"outlineLevel":"OutlineLevelBodyText","rightIndent":72.0,"spaceAfter":30.0,"spaceBefore":30.0,"widowControl":true},"font":{"name":"DengXian","size":14.0,"bold":true,"italic":true,"color":"#8DD873","underline":"Single","subscript":false,"superscript":false,"strikeThrough":false,"doubleStrikeThrough":true,"highlightColor":null,"hidden":false},"shading":{"backgroundPatternColor":"#00FF00"}},{"baseStyle":"Table Normal","builtIn":false,"inUse":true,"linked":false,"nextParagraphStyle":"NewTableStyle","nameLocal":"NewTableStyle","priority":100,"type":"Table","unhideWhenUsed":false,"visibility":false,"paragraphFormat":{"alignment":"Left","firstLineIndent":0.0,"keepTogether":false,"keepWithNext":false,"leftIndent":0.0,"lineSpacing":12.0,"lineUnitAfter":0.0,"lineUnitBefore":0.0,"mirrorIndents":false,"outlineLevel":"OutlineLevelBodyText","rightIndent":0.0,"spaceAfter":0.0,"spaceBefore":0.0,"widowControl":true},"font":{"name":"DengXian","size":20.0,"bold":false,"italic":true,"color":"#D86DCB","underline":"None","subscript":false,"superscript":false,"strikeThrough":false,"doubleStrikeThrough":false,"highlightColor":null,"hidden":false},"tableStyle":{"allowBreakAcrossPage":true,"alignment":"Left","bottomCellMargin":0.0,"leftCellMargin":0.08,"rightCellMargin":0.08,"topCellMargin":0.0,"cellSpacing":0.0},"shading":{"backgroundPatternColor":"#60CAF3"}}]}';
  const styles = context.document.importStylesFromJson(str);

  // If you'd like to set how conflicting styles are handled, use the importedStylesConflictBehavior parameter that was introduced in the Desktop 1.1 requirement set. "Ignore" is the default.
  ////const styles = context.document.importStylesFromJson(str, Word.ImportedStylesConflictBehavior.Ignore);

  await context.sync();
  console.log("Styles imported from JSON:", styles);
});

importStylesFromJson(stylesJson, importedStylesConflictBehavior)

JSON 形式の文字列からスタイルをインポートします。

importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: "Ignore" | "Overwrite" | "CreateNew"): OfficeExtension.ClientResult<string[]>;

パラメーター

stylesJson

string

スタイルを表す JSON 形式の文字列。

importedStylesConflictBehavior

"Ignore" | "Overwrite" | "CreateNew"

省略可能。 現在の文書内の既存のスタイルと同じ名前のインポートされたスタイルを処理する方法を指定します。 既定値は ignoreです。

戻り値

注釈

[ API セット: WordApi 1.6 ]

注: importedStylesConflictBehavior パラメーターは WordApiDesktop 1.1 で導入されました。

insertFileFromBase64(base64File, insertLocation, insertFileOptions)

追加のプロパティを使用して、特定の場所にあるターゲット ドキュメントにドキュメントを挿入します。 ヘッダー、フッター、透かし、およびその他のセクション プロパティは、既定でコピーされます。

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

パラメーター

base64File

string

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

insertLocation

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

値は、 replacestart、または endである必要があります。

insertFileOptions
Word.InsertFileOptions

省略可能。 コピー先ドキュメントにインポートする必要がある追加のプロパティ。

戻り値

注釈

[ API セット: WordApi 1.5 ]

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

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/insert-external-document.yaml

// Inserts content (applying selected settings) from another document passed in as a Base64-encoded string.
await Word.run(async (context) => {
  // Use the Base64-encoded string representation of the selected .docx file.
  context.document.insertFileFromBase64(externalDocument, "Replace", {
    importTheme: true,
    importStyles: true,
    importParagraphSpacing: true,
    importPageColor: true,
    importChangeTrackingMode: true,
    importCustomProperties: true,
    importCustomXmlParts: true,
    importDifferentOddEvenPages: true
  });
  await context.sync();
});

load(options)

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

load(options?: Word.Interfaces.DocumentLoadOptions): Word.Document;

パラメーター

options
Word.Interfaces.DocumentLoadOptions

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

戻り値

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the document.
    const thisDocument = context.document;
    
    // Queue a command to load content control properties.
    thisDocument.load('contentControls/id, contentControls/text, contentControls/tag');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (thisDocument.contentControls.items.length !== 0) {
        for (let i = 0; i < thisDocument.contentControls.items.length; i++) {
            console.log(thisDocument.contentControls.items[i].id);
            console.log(thisDocument.contentControls.items[i].text);
            console.log(thisDocument.contentControls.items[i].tag);
        }
    } else {
        console.log('No content controls in this document.');
    }
});

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

戻り値

lockServerFile()

サーバー上のファイルをロックし、他の人が編集できないようにします。

lockServerFile(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

makeCompatibilityDefault()

互換性オプションを設定します。

makeCompatibilityDefault(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

manualHyphenation()

任意指定のハイフネーションを開始し、1 行ずつ行います。

manualHyphenation(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.3 ]

merge(fileName, options)

注意

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

1 つの文書の変更履歴をほかの文書に結合します。

merge(fileName: string, options?: Word.DocumentMergeOptions): void;

パラメーター

fileName

string

マージするファイルの名前。

options
Word.DocumentMergeOptions

省略可能。 マージ操作の構成オプション。

戻り値

void

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

post()

Microsoft Exchange のパブリック フォルダーにドキュメントを投稿します。

post(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

presentIt()

Word ドキュメントが読み込まれた状態でPowerPointを開きます。

presentIt(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

printOut(options)

注意

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

ドキュメントのすべてまたは一部を印刷します。

printOut(options?: Word.DocumentPrintOutOptions): void;

パラメーター

options
Word.DocumentPrintOutOptions

省略可能。 印刷操作の構成オプション。

戻り値

void

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

printPreview()

表示モードを印刷プレビューに切り替えます。

printPreview(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

protect(type, options)

注意

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

未承認の変更からドキュメントを保護します。

protect(type: Word.ProtectionType, options?: Word.DocumentProtectOptions): void;

パラメーター

type
Word.ProtectionType

保護の種類。

options
Word.DocumentProtectOptions

省略可能。 ドキュメント保護の構成オプション。

戻り値

void

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

protect(type, options)

注意

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

未承認の変更からドキュメントを保護します。

protect(type: "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading", options?: Word.DocumentProtectOptions): void;

パラメーター

type

"NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading"

保護の種類。

options
Word.DocumentProtectOptions

省略可能。 ドキュメント保護の構成オプション。

戻り値

void

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

redo(times)

元に戻された最後のアクションをやり直します ( undo メソッドを元に戻します)。

redo(times?: number): OfficeExtension.ClientResult<boolean>;

パラメーター

times

number

省略可能。 やり直すアクションの数。

戻り値

true アクションが正常にやり直された場合。それ以外の場合は、 false

注釈

[ API set: WordApiDesktop 1.4 ]

rejectAllRevisions()

ドキュメント内で追跡されたすべての変更を拒否します。

rejectAllRevisions(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

rejectAllRevisionsShown()

画面に表示されるドキュメント内のすべてのリビジョンを拒否します。

rejectAllRevisionsShown(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

reload()

ハイパーリンク先の文書をダウンロードし、キャッシュに格納された文書を再度読み込みます。

reload(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

reloadAs(encoding)

ドキュメント エンコードを使用して、HTML ドキュメントに基づいてドキュメントを再読み込みします。

reloadAs(encoding: Word.DocumentEncoding): void;

パラメーター

encoding
Word.DocumentEncoding

使用するエンコード。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

reloadAs(encoding)

ドキュメント エンコードを使用して、HTML ドキュメントに基づいてドキュメントを再読み込みします。

reloadAs(encoding: "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"): void;

パラメーター

encoding

"Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"

使用するエンコード。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

removeDocumentInformation(removeDocInfoType)

機密情報、プロパティ、コメント、およびその他のメタデータをドキュメントから削除します。

removeDocumentInformation(removeDocInfoType: Word.RemoveDocInfoType): void;

パラメーター

removeDocInfoType
Word.RemoveDocInfoType

削除するドキュメント情報の種類。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

removeDocumentInformation(removeDocInfoType)

機密情報、プロパティ、コメント、およびその他のメタデータをドキュメントから削除します。

removeDocumentInformation(removeDocInfoType: "Comments" | "Revisions" | "Versions" | "RemovePersonalInformation" | "EmailHeader" | "RoutingSlip" | "SendForReview" | "DocumentProperties" | "Template" | "DocumentWorkspace" | "InkAnnotations" | "DocumentServerProperties" | "DocumentManagementPolicy" | "ContentType" | "TaskpaneWebExtensions" | "AtMentions" | "DocumentTasks" | "DocumentIntelligence" | "CommentReactions" | "All"): void;

パラメーター

removeDocInfoType

"Comments" | "Revisions" | "Versions" | "RemovePersonalInformation" | "EmailHeader" | "RoutingSlip" | "SendForReview" | "DocumentProperties" | "Template" | "DocumentWorkspace" | "InkAnnotations" | "DocumentServerProperties" | "DocumentManagementPolicy" | "ContentType" | "TaskpaneWebExtensions" | "AtMentions" | "DocumentTasks" | "DocumentIntelligence" | "CommentReactions" | "All"

削除するドキュメント情報の種類。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

removeLockedStyles()

文書で書式設定の制限が適用されている場合に、ロックされたスタイルのドキュメントを消去します。

removeLockedStyles(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

removeNumbers(numberType)

文書から数値または箇条書きを削除します。

removeNumbers(numberType?: Word.NumberType): void;

パラメーター

numberType
Word.NumberType

省略可能。 削除する番号の種類。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

removeNumbers(numberType)

文書から数値または箇条書きを削除します。

removeNumbers(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): void;

パラメーター

numberType

"Paragraph" | "ListNum" | "AllNumbers"

省略可能。 削除する番号の種類。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

removeTheme()

現在の文書で使用されているテーマを解除します。

removeTheme(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

repaginate()

文書全体で改ページ位置を自動調整します。

repaginate(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

replyWithChanges(options)

注意

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

レビューのために送信されたドキュメントの作成者に電子メール メッセージを送信し、校閲者がドキュメントのレビューを完了したことを通知します。

replyWithChanges(options?: Word.DocumentReplyWithChangesOptions): void;

パラメーター

options
Word.DocumentReplyWithChangesOptions

省略可能。 変更を返信するための構成オプション。

戻り値

void

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

resetFormFields()

ドキュメント内のすべてのフォーム フィールドをクリアし、もう一度入力するフォームを準備します。

resetFormFields(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

returnToLastReadPosition()

最後に保存した読み取り位置にドキュメントを返します。

returnToLastReadPosition(): OfficeExtension.ClientResult<number>;

戻り値

注釈

[ API set: WordApiDesktop 1.4 ]

runAutoMacro(autoMacro)

ドキュメントに格納されている自動マクロを実行します。 指定した自動実行マクロが存在しない場合は、何も行われません。

runAutoMacro(autoMacro: Word.AutoMacro): void;

パラメーター

autoMacro
Word.AutoMacro

実行する自動実行マクロを指定します。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

runAutoMacro(autoMacro)

ドキュメントに格納されている自動マクロを実行します。 指定した自動実行マクロが存在しない場合は、何も行われません。

runAutoMacro(autoMacro: "StartWord" | "New" | "Open" | "Close" | "Exit" | "Sync"): void;

パラメーター

autoMacro

"StartWord" | "New" | "Open" | "Close" | "Exit" | "Sync"

実行する自動実行マクロを指定します。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

save(saveBehavior, fileName)

ドキュメントを保存します。

save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;

パラメーター

saveBehavior
Word.SaveBehavior

省略可能。 保存動作は、 save または promptする必要があります。 既定値は saveです。

fileName

string

省略可能。 ファイル名 (ファイル拡張子を除外)。 新しいドキュメントに対してのみ有効になります。

戻り値

void

注釈

[ API セット: WordApi 1.1 ]

注: saveBehavior パラメーターと fileName パラメーターは、WordApi 1.5 で導入されました。

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the document.
    const thisDocument = context.document;

    // Queue a command to load the document save state (on the saved property).
    thisDocument.load('saved');    
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
        
    if (thisDocument.saved === false) {
        // Queue a command to save this document.
        thisDocument.save();
        
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Saved the document');
    } else {
        console.log('The document has not changed since the last save.');
    }
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/save-close.yaml

// Saves the document with default behavior
// for current state of the document.
await Word.run(async (context) => {
  context.document.save();
  await context.sync();
});

save(saveBehavior, fileName)

ドキュメントを保存します。

save(saveBehavior?: "Save" | "Prompt", fileName?: string): void;

パラメーター

saveBehavior

"Save" | "Prompt"

省略可能。 保存動作は、 save または promptする必要があります。 既定値は saveです。

fileName

string

省略可能。 ファイル名 (ファイル拡張子を除外)。 新しいドキュメントに対してのみ有効になります。

戻り値

void

注釈

[ API セット: WordApi 1.1 ]

注: saveBehavior パラメーターと fileName パラメーターは、WordApi 1.5 で導入されました。

saveAsQuickStyleSet(fileName)

現在使用しているクイック スタイルのグループを保存します。

saveAsQuickStyleSet(fileName: string): void;

パラメーター

fileName

string

保存するファイルの名前。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

search(searchText, searchOptions)

指定した検索オプションを使用して、ドキュメント全体のスコープで検索を実行します。 検索結果は、 Range オブジェクトのコレクションです。

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; }

省略可能。 検索の実行方法を定義するオプション。

戻り値

注釈

[ API セット: WordApi 1.7 ]

select()

ドキュメントの内容を選択します。

select(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

selectContentControlsByTag(tag)

指定したタグを持つすべてのコンテンツ コントロールを返します。

selectContentControlsByTag(tag: string): Word.ContentControlCollection;

パラメーター

tag

string

コンテンツ コントロールをフィルター処理するタグ値。

戻り値

注釈

[ API set: WordApiDesktop 1.4 ]

selectContentControlsByTitle(title)

指定したタイトルを持つドキュメント内のすべてのコンテンツ コントロールを表す ContentControlCollection オブジェクトを返します。

selectContentControlsByTitle(title: string): Word.ContentControlCollection;

パラメーター

title

string

コンテンツ コントロールのタイトル。

戻り値

注釈

[ API set: WordApiDesktop 1.4 ]

selectLinkedControls(node)

特定のカスタム XML ノードにリンクされているドキュメント内のすべてのコンテンツ コントロールを表す ContentControlCollection オブジェクトを返します。

selectLinkedControls(node: Word.CustomXmlNode): Word.ContentControlCollection;

パラメーター

node
Word.CustomXmlNode

カスタム XML ノード。

戻り値

注釈

[ API set: WordApiDesktop 1.4 ]

selectNodes(xPath, options)

XPath パラメーターに一致するすべてのノードをドキュメントに表示する順序で表す XmlNodeCollection オブジェクトを返します。

selectNodes(xPath: string, options?: Word.SelectNodesOptions): Word.XmlNodeCollection;

パラメーター

xPath

string

XPath 式。

options
Word.SelectNodesOptions

省略可能。 ノード選択の構成オプション。

戻り値

注釈

[ API set: WordApiDesktop 1.4 ]

selectSingleNode(xPath, options)

ドキュメント内の XPath パラメーターに一致する最初のノードを表す XmlNode オブジェクトを返します。

selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): Word.XmlNode;

パラメーター

xPath

string

XPath 式。

options
Word.SelectSingleNodeOptions

省略可能。 ノード選択の構成オプション。

戻り値

注釈

[ API set: WordApiDesktop 1.4 ]

selectUnlinkedControls(stream)

XML ノードにリンクされていないドキュメント内のすべてのコンテンツ コントロールを表す ContentControlCollection オブジェクトを返します。

selectUnlinkedControls(stream?: Word.CustomXmlPart): Word.ContentControlCollection;

パラメーター

stream
Word.CustomXmlPart

省略可能。 カスタム XML パーツ。

戻り値

注釈

[ API set: WordApiDesktop 1.4 ]

sendFax(address, subject)

ユーザーの操作を行わずに、文書を FAX として送信します。

sendFax(address: string, subject?: string): void;

パラメーター

address

string

FAX アドレス。

subject

string

省略可能。 FAX の件名。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

sendFaxOverInternet(options)

注意

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

指定した 1 つ以上の受信者にドキュメントを FAX 送信する FAX サービス プロバイダーにドキュメントを送信します。

sendFaxOverInternet(options?: Word.DocumentSendFaxOverInternetOptions): void;

パラメーター

options
Word.DocumentSendFaxOverInternetOptions

省略可能。 インターネット経由で FAX を送信するための構成オプション。

戻り値

void

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

sendForReview(options)

注意

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

指定した受信者による確認のために、電子メール メッセージでドキュメントを送信します。

sendForReview(options?: Word.DocumentSendForReviewOptions): void;

パラメーター

options
Word.DocumentSendForReviewOptions

省略可能。 確認のためにドキュメントを送信するための構成オプション。

戻り値

void

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

sendMail()

Microsoft Exchange を介してドキュメントを送信するためのメッセージ ウィンドウを開きます。

sendMail(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

set(properties, options)

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

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

パラメーター

properties
Word.Interfaces.DocumentUpdateData

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

options
OfficeExtension.UpdateOptions

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

戻り値

void

set(properties)

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

set(properties: Word.Document): void;

パラメーター

properties
Word.Document

戻り値

void

setDefaultTableStyle(style, setInTemplate)

ドキュメント内の新しく作成されたテーブルに使用するテーブル スタイルを指定します。

setDefaultTableStyle(style: string, setInTemplate: boolean): void;

パラメーター

style

string

適用するスタイル。

setInTemplate

boolean

テンプレートでスタイルを設定するかどうか。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

setPasswordEncryptionOptions(passwordEncryptionProvider, passwordEncryptionAlgorithm, passwordEncryptionKeyLength, passwordEncryptFileProperties)

パスワードが設定されている文書の暗号化に使用されるオプションを設定します。

setPasswordEncryptionOptions(passwordEncryptionProvider: string, passwordEncryptionAlgorithm: string, passwordEncryptionKeyLength: number, passwordEncryptFileProperties?: boolean): void;

パラメーター

passwordEncryptionProvider

string

暗号化プロバイダー。

passwordEncryptionAlgorithm

string

暗号化アルゴリズム。

passwordEncryptionKeyLength

number

キーの長さ。

passwordEncryptFileProperties

boolean

省略可能。 ファイルのプロパティを暗号化するかどうか。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

toggleFormsDesign()

フォームのデザイン モードのオンとオフを切り替えます。

toggleFormsDesign(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

toJSON()

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

toJSON(): Word.Interfaces.DocumentData;

戻り値

track()

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

track(): Word.Document;

戻り値

transformDocument(path, dataOnly)

指定した拡張スタイルシート言語変換 (XSLT) ファイルをこのドキュメントに適用し、ドキュメントを結果に置き換えます。

transformDocument(path: string, dataOnly?: boolean): void;

パラメーター

path

string

XSLT ファイルへのパス。

dataOnly

boolean

省略可能。 データのみを使用するかどうか。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

undo(times)

[元に戻す] で表示される、直前に行った操作または一連の操作を元に戻します。

undo(times?: number): OfficeExtension.ClientResult<boolean>;

パラメーター

times

number

省略可能。 元に戻すアクションの数。

戻り値

true アクションが正常に取り消された場合。それ以外の場合は、 false

注釈

[ API set: WordApiDesktop 1.4 ]

undoClear()

ドキュメントで元に戻すことができるアクションの一覧をクリアします。

undoClear(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

unprotect(password)

ドキュメントから保護を削除します。

unprotect(password?: string): void;

パラメーター

password

string

省略可能。 ドキュメントの保護を解除するためのパスワード。

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

untrack()

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

untrack(): Word.Document;

戻り値

updateStyles()

添付されたテンプレートのすべてのスタイルを文書にコピーします。文書のスタイルの名前がテンプレートのスタイルの名前と同じ場合は、上書きします。

updateStyles(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

viewCode()

ドキュメントで選択した Microsoft ActiveX コントロールのコード ウィンドウを表示します。

viewCode(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

viewPropertyBrowser()

ドキュメントで選択した Microsoft ActiveX コントロールのプロパティ ウィンドウを表示します。

viewPropertyBrowser(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

webPagePreview()

Web ページとして保存されている場合と同様に、現在のドキュメントのプレビューを表示します。

webPagePreview(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.4 ]

イベントの詳細

onAnnotationClicked

ユーザーが注釈をクリック (または Alt + Down を使用して選択) したときに発生します。

readonly onAnnotationClicked: OfficeExtension.EventHandlers<Word.AnnotationClickedEventArgs>;

イベントの種類

注釈

[ API セット: WordApi 1.7 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onClickedHandler(args: Word.AnnotationClickedEventArgs) {
  await Word.run(async (context) => {
    const annotation: Word.Annotation = context.document.getAnnotationById(args.id);
    annotation.load("critiqueAnnotation");

    await context.sync();

    console.log(`AnnotationClicked: ID ${args.id}:`, annotation.critiqueAnnotation.critique);
  });
}

onAnnotationHovered

ユーザーが注釈の上にカーソルを合わせると発生します。

readonly onAnnotationHovered: OfficeExtension.EventHandlers<Word.AnnotationHoveredEventArgs>;

イベントの種類

注釈

[ API セット: WordApi 1.7 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onHoveredHandler(args: Word.AnnotationHoveredEventArgs) {
  await Word.run(async (context) => {
    const annotation: Word.Annotation = context.document.getAnnotationById(args.id);
    annotation.load("critiqueAnnotation");

    await context.sync();

    console.log(`AnnotationHovered: ID ${args.id}:`, annotation.critiqueAnnotation.critique);
  });
}

onAnnotationInserted

ユーザーが 1 つ以上の注釈を追加するときに発生します。

readonly onAnnotationInserted: OfficeExtension.EventHandlers<Word.AnnotationInsertedEventArgs>;

イベントの種類

注釈

[ API セット: WordApi 1.7 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onInsertedHandler(args: Word.AnnotationInsertedEventArgs) {
  await Word.run(async (context) => {
    const annotations = [];
    for (let i = 0; i < args.ids.length; i++) {
      let annotation: Word.Annotation = context.document.getAnnotationById(args.ids[i]);
      annotation.load("id,critiqueAnnotation");

      annotations.push(annotation);
    }

    await context.sync();

    for (let annotation of annotations) {
      console.log(`AnnotationInserted: ID ${annotation.id}:`, annotation.critiqueAnnotation.critique);
    }
  });
}

onAnnotationPopupAction

ユーザーが注釈ポップアップ メニューでアクションを実行したときに発生します。

readonly onAnnotationPopupAction: OfficeExtension.EventHandlers<Word.AnnotationPopupActionEventArgs>;

イベントの種類

注釈

[ API セット: WordApi 1.8 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onPopupActionHandler(args: Word.AnnotationPopupActionEventArgs) {
  await Word.run(async (context) => {
    let message = `AnnotationPopupAction: ID ${args.id} = `;
    if (args.action === "Accept") {
      message += `Accepted: ${args.critiqueSuggestion}`;
    } else {
      message += "Rejected";
    }

    console.log(message);
  });
}

onAnnotationRemoved

ユーザーが 1 つ以上の注釈を削除するときに発生します。

readonly onAnnotationRemoved: OfficeExtension.EventHandlers<Word.AnnotationRemovedEventArgs>;

イベントの種類

注釈

[ API セット: WordApi 1.7 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onRemovedHandler(args: Word.AnnotationRemovedEventArgs) {
  await Word.run(async (context) => {
    for (let id of args.ids) {
      console.log(`AnnotationRemoved: ID ${id}`);
    }
  });
}

onContentControlAdded

コンテンツ コントロールが追加されたときに発生します。 ハンドラーで context.sync() を実行して、新しいコンテンツ コントロールのプロパティを取得します。

readonly onContentControlAdded: OfficeExtension.EventHandlers<Word.ContentControlAddedEventArgs>;

イベントの種類

注釈

[ API セット: WordApi 1.5 ]

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

// Registers the onAdded event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onContentControlAdded.add(contentControlAdded);
  await context.sync();

  console.log("Added event handler for when content controls are added.");
});

...

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

onParagraphAdded

ユーザーが新しい段落を追加するときに発生します。

readonly onParagraphAdded: OfficeExtension.EventHandlers<Word.ParagraphAddedEventArgs>;

イベントの種類

注釈

[ API セット: WordApi 1.6 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onadded-event.yaml

// Registers the onParagraphAdded event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onParagraphAdded.add(paragraphAdded);
  await context.sync();

  console.log("Added event handler for when paragraphs are added.");
});

...

async function paragraphAdded(event: Word.ParagraphAddedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.type} event detected. IDs of paragraphs that were added:`, event.uniqueLocalIds);
  });
}

onParagraphChanged

ユーザーが段落を変更したときに発生します。

readonly onParagraphChanged: OfficeExtension.EventHandlers<Word.ParagraphChangedEventArgs>;

イベントの種類

注釈

[ API セット: WordApi 1.6 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onchanged-event.yaml

// Registers the onParagraphChanged event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onParagraphChanged.add(paragraphChanged);
  await context.sync();

  console.log("Added event handler for when content is changed in paragraphs.");
});

...

async function paragraphChanged(event: Word.ParagraphChangedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.type} event detected. IDs of paragraphs where content was changed:`, event.uniqueLocalIds);
  });
}

onParagraphDeleted

ユーザーが段落を削除したときに発生します。

readonly onParagraphDeleted: OfficeExtension.EventHandlers<Word.ParagraphDeletedEventArgs>;

イベントの種類

注釈

[ API セット: WordApi 1.6 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/ondeleted-event.yaml

// Registers the onParagraphDeleted event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onParagraphDeleted.add(paragraphDeleted);
  await context.sync();

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

...

async function paragraphDeleted(event: Word.ParagraphDeletedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.type} event detected. IDs of paragraphs that were deleted:`, event.uniqueLocalIds);
  });
}