Word.View class

ウィンドウまたはウィンドウ枠の表示属性 (すべて表示、フィールドの網かけ、表のグリッド線など) が含まれます。

Extends

プロパティ

areAllNonprintingCharactersDisplayed

印刷されない文字をすべて表示するかどうかを指定します。

areBackgroundsDisplayed

ドキュメントが印刷レイアウト表示に表示されたときに、背景色と背景画像を表示するかどうかを取得します。

areBookmarksIndicated

各ブックマークの最初と最後に角かっこを表示するかどうかを取得します。

areCommentsDisplayed

Microsoft Word で文書内のコメントを表示するかどうかを指定します。

areConnectingLinesToRevisionsBalloonDisplayed

Microsoft Word でテキストから変更履歴およびコメント吹き出しへの接続行を表示するかどうかを指定します。

areCropMarksDisplayed

ページの隅に切り抜きマークが表示され、余白が配置されている場所を示すかどうかを取得します。

areDrawingsDisplayed

描画ツールで作成したオブジェクトが印刷レイアウト ビューに表示されるかどうかを取得します。

areEditableRangesShaded

ユーザーが変更するアクセス許可を持っているドキュメント内の範囲に網かけを適用するかどうかを指定します。

areFieldCodesDisplayed

フィールド コードを表示するかどうかを指定します。

areFormatChangesDisplayed

[変更の追跡] が有効になっている文書に加えられた書式設定の変更を Microsoft Word で表示するかどうかを指定します。

areInkAnnotationsDisplayed

手書きのインク注釈を表示するか非表示にするかを指定します。

areInsertionsAndDeletionsDisplayed

変更の追跡が有効になっている文書への挿入と削除を Microsoft Word で表示するかどうかを指定します。

areLinesWrappedToWindow

行が右余白または右列境界ではなく、ドキュメント ウィンドウの右端で折り返されるかどうかを取得します。

areObjectAnchorsDisplayed

印刷レイアウト ビューで配置できるアイテムの横にオブジェクト アンカーが表示されるかどうかを取得します。

areOptionalBreaksDisplayed

Microsoft Word でオプションの改行が表示されるかどうかを取得します。

areOptionalHyphensDisplayed

オプションのハイフンが表示されるかどうかを取得します。

areOtherAuthorsVisible

他の作成者のプレゼンスをドキュメントに表示する必要があるかどうかを取得します。

arePageBoundariesDisplayed

文書内の上、下の余白、およびページ間のグレー領域を表示するかどうかを取得します。

areParagraphsMarksDisplayed

段落記号が表示されるかどうかを取得します。

arePicturePlaceholdersDisplayed

空白のボックスが画像のプレースホルダーとして表示されるかどうかを取得します。

areRevisionsAndCommentsDisplayed

変更の追跡が有効になっている文書に加えられた変更とコメントを Microsoft Word で表示するかどうかを指定します。

areSpacesIndicated

スペース文字が表示されるかどうかを取得します。

areTableGridlinesDisplayed

テーブルの枠線を表示するかどうかを指定します。

areTabsDisplayed

タブ文字が表示されるかどうかを取得します。

areTextBoundariesDisplayed

印刷レイアウト表示で、ページ余白、テキスト列、オブジェクト、およびフレームの周囲に点線が表示されるかどうかを取得します。

columnWidth

閲覧モードの列幅を指定します。

context

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

fieldShading

フィールドの画面上のシェーディングを取得します。

isDraft

ウィンドウ内のすべてのテキストを同じサンセリフ フォントで表示するかどうかを指定します。書式設定は最小限で、表示を高速化します。

isFirstLineOnlyDisplayed

アウトライン表示で本文テキストの最初の行のみを表示するかどうかを指定します。

isFormatDisplayed

アウトライン ビューで文字書式を表示するかどうかを指定します。

isFullScreen

ウィンドウを全画面表示にするかどうかを指定します。

isHiddenTextDisplayed

隠しテキストとして書式設定されたテキストが表示されるかどうかを取得します。

isHighlightingDisplayed

強調表示の書式設定がドキュメントと共に表示および印刷されるかどうかを取得します。

isInConflictMode

文書が競合モード ビューであるかどうかを指定します。

isInPanning

Microsoft Word がパン モードかどうかを指定します。

isInReadingLayout

ドキュメントが閲覧レイアウト表示で表示されているかどうかを指定します。

isMailMergeDataView

差し込み印刷フィールドの代わりに差し込み印刷データを表示するかどうかを指定します。

isMainTextLayerVisible

ヘッダー領域とフッター領域が表示されたときに、文書内のテキストを表示するかどうかを指定します。

isPointerShownAsMagnifier

印刷プレビューでポインターを虫眼鏡として表示するかどうかを指定します。

isReadingLayoutActualView

閲覧レイアウト ビューで表示されたページを、印刷ページと同じレイアウトを使用して表示するかどうかを指定します。

isXmlMarkupVisible

XML タグをドキュメントに表示するかどうかを指定します。

markupMode

変更履歴の表示モードを指定します。

pageColor

閲覧モードのページの色を指定します。

pageMovementType

ページ移動の種類を指定します。

readingLayoutTruncateMargins

文書を全画面閲覧表示で表示するときに、余白を表示するか非表示にするかを指定します。

revisionsBalloonSide

Word で文書の左余白と右余白のどちらにリビジョン吹き出しが表示されるかを取得します。

revisionsBalloonWidth

リビジョン吹き出しの幅を指定します。

revisionsBalloonWidthType

変更履歴の吹き出しの幅を測定する方法を指定します。

revisionsFilter

RevisionsFilter オブジェクトのインスタンスを取得します。

seekView

印刷レイアウト ビューに表示されるドキュメント要素を指定します。

splitSpecial

アクティブなウィンドウ ウィンドウを指定します。

type

表示の種類を指定します。

メソッド

collapseAllHeadings()

文書内のすべての見出しを折りたたみます。

collapseOutline(range)

選択範囲または指定範囲の本文と下位の見出しを、1 レベルだけ折りたたんで非表示にします。

expandAllHeadings()

文書内のすべての見出しを展開します。

expandOutline(range)

選択範囲の下位の文字列を、1 レベルだけ展開します。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

nextHeaderFooter()

ヘッダーとフッターのいずれがビューに表示されているかに基づいて、次のヘッダーまたはフッターに移動します。

previousHeaderFooter()

ヘッダーとフッターのいずれがビューに表示されているかに基づいて、前のヘッダーまたはフッターに移動します。

set(properties, options)

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

set(properties)

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

showAllHeadings()

すべての文字列 (見出しおよび本文) の表示と見出しのみの表示を切り替えます。

showHeading(level)

指定したレベルまでのすべての見出しを表示し、このレベル以下の見出しと本文は非表示にします。

toJSON()

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

track()

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

untrack()

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

プロパティの詳細

areAllNonprintingCharactersDisplayed

印刷されない文字をすべて表示するかどうかを指定します。

areAllNonprintingCharactersDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areBackgroundsDisplayed

ドキュメントが印刷レイアウト表示に表示されたときに、背景色と背景画像を表示するかどうかを取得します。

areBackgroundsDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areBookmarksIndicated

各ブックマークの最初と最後に角かっこを表示するかどうかを取得します。

readonly areBookmarksIndicated: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areCommentsDisplayed

Microsoft Word で文書内のコメントを表示するかどうかを指定します。

areCommentsDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areConnectingLinesToRevisionsBalloonDisplayed

Microsoft Word でテキストから変更履歴およびコメント吹き出しへの接続行を表示するかどうかを指定します。

areConnectingLinesToRevisionsBalloonDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areCropMarksDisplayed

ページの隅に切り抜きマークが表示され、余白が配置されている場所を示すかどうかを取得します。

readonly areCropMarksDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areDrawingsDisplayed

描画ツールで作成したオブジェクトが印刷レイアウト ビューに表示されるかどうかを取得します。

readonly areDrawingsDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areEditableRangesShaded

ユーザーが変更するアクセス許可を持っているドキュメント内の範囲に網かけを適用するかどうかを指定します。

areEditableRangesShaded: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areFieldCodesDisplayed

フィールド コードを表示するかどうかを指定します。

areFieldCodesDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areFormatChangesDisplayed

[変更の追跡] が有効になっている文書に加えられた書式設定の変更を Microsoft Word で表示するかどうかを指定します。

areFormatChangesDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areInkAnnotationsDisplayed

手書きのインク注釈を表示するか非表示にするかを指定します。

areInkAnnotationsDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areInsertionsAndDeletionsDisplayed

変更の追跡が有効になっている文書への挿入と削除を Microsoft Word で表示するかどうかを指定します。

areInsertionsAndDeletionsDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areLinesWrappedToWindow

行が右余白または右列境界ではなく、ドキュメント ウィンドウの右端で折り返されるかどうかを取得します。

readonly areLinesWrappedToWindow: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areObjectAnchorsDisplayed

印刷レイアウト ビューで配置できるアイテムの横にオブジェクト アンカーが表示されるかどうかを取得します。

readonly areObjectAnchorsDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areOptionalBreaksDisplayed

Microsoft Word でオプションの改行が表示されるかどうかを取得します。

readonly areOptionalBreaksDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areOptionalHyphensDisplayed

オプションのハイフンが表示されるかどうかを取得します。

readonly areOptionalHyphensDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areOtherAuthorsVisible

他の作成者のプレゼンスをドキュメントに表示する必要があるかどうかを取得します。

areOtherAuthorsVisible: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

arePageBoundariesDisplayed

文書内の上、下の余白、およびページ間のグレー領域を表示するかどうかを取得します。

readonly arePageBoundariesDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areParagraphsMarksDisplayed

段落記号が表示されるかどうかを取得します。

readonly areParagraphsMarksDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

arePicturePlaceholdersDisplayed

空白のボックスが画像のプレースホルダーとして表示されるかどうかを取得します。

readonly arePicturePlaceholdersDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areRevisionsAndCommentsDisplayed

変更の追跡が有効になっている文書に加えられた変更とコメントを Microsoft Word で表示するかどうかを指定します。

areRevisionsAndCommentsDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areSpacesIndicated

スペース文字が表示されるかどうかを取得します。

readonly areSpacesIndicated: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areTableGridlinesDisplayed

テーブルの枠線を表示するかどうかを指定します。

areTableGridlinesDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areTabsDisplayed

タブ文字が表示されるかどうかを取得します。

readonly areTabsDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

areTextBoundariesDisplayed

印刷レイアウト表示で、ページ余白、テキスト列、オブジェクト、およびフレームの周囲に点線が表示されるかどうかを取得します。

readonly areTextBoundariesDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

columnWidth

閲覧モードの列幅を指定します。

columnWidth: Word.ColumnWidth | "Narrow" | "Default" | "Wide";

プロパティ値

Word.ColumnWidth | "Narrow" | "Default" | "Wide"

注釈

API セット: WordApiDesktop 1.4

context

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

context: RequestContext;

プロパティ値

fieldShading

フィールドの画面上のシェーディングを取得します。

readonly fieldShading: Word.FieldShading | "Never" | "Always" | "WhenSelected";

プロパティ値

Word.FieldShading | "Never" | "Always" | "WhenSelected"

注釈

API セット: WordApiDesktop 1.4

isDraft

ウィンドウ内のすべてのテキストを同じサンセリフ フォントで表示するかどうかを指定します。書式設定は最小限で、表示を高速化します。

isDraft: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

isFirstLineOnlyDisplayed

アウトライン表示で本文テキストの最初の行のみを表示するかどうかを指定します。

isFirstLineOnlyDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

isFormatDisplayed

アウトライン ビューで文字書式を表示するかどうかを指定します。

isFormatDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

isFullScreen

ウィンドウを全画面表示にするかどうかを指定します。

isFullScreen: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

isHiddenTextDisplayed

隠しテキストとして書式設定されたテキストが表示されるかどうかを取得します。

readonly isHiddenTextDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

isHighlightingDisplayed

強調表示の書式設定がドキュメントと共に表示および印刷されるかどうかを取得します。

readonly isHighlightingDisplayed: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

isInConflictMode

文書が競合モード ビューであるかどうかを指定します。

isInConflictMode: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

isInPanning

Microsoft Word がパン モードかどうかを指定します。

isInPanning: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

isInReadingLayout

ドキュメントが閲覧レイアウト表示で表示されているかどうかを指定します。

isInReadingLayout: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

isMailMergeDataView

差し込み印刷フィールドの代わりに差し込み印刷データを表示するかどうかを指定します。

isMailMergeDataView: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

isMainTextLayerVisible

ヘッダー領域とフッター領域が表示されたときに、文書内のテキストを表示するかどうかを指定します。

isMainTextLayerVisible: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

isPointerShownAsMagnifier

印刷プレビューでポインターを虫眼鏡として表示するかどうかを指定します。

isPointerShownAsMagnifier: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

isReadingLayoutActualView

閲覧レイアウト ビューで表示されたページを、印刷ページと同じレイアウトを使用して表示するかどうかを指定します。

isReadingLayoutActualView: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

isXmlMarkupVisible

XML タグをドキュメントに表示するかどうかを指定します。

isXmlMarkupVisible: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

markupMode

変更履歴の表示モードを指定します。

markupMode: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed";

プロパティ値

Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"

注釈

API セット: WordApiDesktop 1.4

pageColor

閲覧モードのページの色を指定します。

pageColor: Word.PageColor | "None" | "Sepia" | "Inverse";

プロパティ値

Word.PageColor | "None" | "Sepia" | "Inverse"

注釈

API セット: WordApiDesktop 1.4

pageMovementType

ページ移動の種類を指定します。

pageMovementType: Word.PageMovementType | "Vertical" | "SideToSide";

プロパティ値

Word.PageMovementType | "Vertical" | "SideToSide"

注釈

API セット: WordApiDesktop 1.4

readingLayoutTruncateMargins

文書を全画面閲覧表示で表示するときに、余白を表示するか非表示にするかを指定します。

readingLayoutTruncateMargins: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full";

プロパティ値

Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"

注釈

API セット: WordApiDesktop 1.4

revisionsBalloonSide

Word で文書の左余白と右余白のどちらにリビジョン吹き出しが表示されるかを取得します。

readonly revisionsBalloonSide: Word.RevisionsBalloonMargin | "Left" | "Right";

プロパティ値

Word.RevisionsBalloonMargin | "Left" | "Right"

注釈

API セット: WordApiDesktop 1.4

revisionsBalloonWidth

リビジョン吹き出しの幅を指定します。

revisionsBalloonWidth: number;

プロパティ値

number

注釈

API セット: WordApiDesktop 1.4

revisionsBalloonWidthType

変更履歴の吹き出しの幅を測定する方法を指定します。

revisionsBalloonWidthType: Word.RevisionsBalloonWidthType | "Percent" | "Points";

プロパティ値

Word.RevisionsBalloonWidthType | "Percent" | "Points"

注釈

API セット: WordApiDesktop 1.4

revisionsFilter

RevisionsFilter オブジェクトのインスタンスを取得します。

readonly revisionsFilter: Word.RevisionsFilter;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

seekView

印刷レイアウト ビューに表示されるドキュメント要素を指定します。

seekView: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter";

プロパティ値

Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"

注釈

API セット: WordApiDesktop 1.4

splitSpecial

アクティブなウィンドウ ウィンドウを指定します。

splitSpecial: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert";

プロパティ値

Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"

注釈

API セット: WordApiDesktop 1.4

type

表示の種類を指定します。

type: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict";

プロパティ値

Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"

注釈

API セット: WordApiDesktop 1.4

メソッドの詳細

collapseAllHeadings()

文書内のすべての見出しを折りたたみます。

collapseAllHeadings(): void;

返品

void

注釈

API セット: WordApiDesktop 1.4

collapseOutline(range)

選択範囲または指定範囲の本文と下位の見出しを、1 レベルだけ折りたたんで非表示にします。

collapseOutline(range: Word.Range): void;

パラメーター

range
Word.Range

折りたたむ範囲を指定する Range オブジェクト。

返品

void

注釈

API セット: WordApiDesktop 1.4

expandAllHeadings()

文書内のすべての見出しを展開します。

expandAllHeadings(): void;

返品

void

注釈

API セット: WordApiDesktop 1.4

expandOutline(range)

選択範囲の下位の文字列を、1 レベルだけ展開します。

expandOutline(range: Word.Range): void;

パラメーター

range
Word.Range

展開する範囲を指定する Range オブジェクト。

返品

void

注釈

API セット: WordApiDesktop 1.4

load(options)

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

load(options?: Word.Interfaces.ViewLoadOptions): Word.View;

パラメーター

options
Word.Interfaces.ViewLoadOptions

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

返品

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

返品

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

返品

nextHeaderFooter()

ヘッダーとフッターのいずれがビューに表示されているかに基づいて、次のヘッダーまたはフッターに移動します。

nextHeaderFooter(): void;

返品

void

注釈

API セット: WordApiDesktop 1.4

previousHeaderFooter()

ヘッダーとフッターのいずれがビューに表示されているかに基づいて、前のヘッダーまたはフッターに移動します。

previousHeaderFooter(): void;

返品

void

注釈

API セット: WordApiDesktop 1.4

set(properties, options)

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

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

パラメーター

properties
Word.Interfaces.ViewUpdateData

メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。

options
OfficeExtension.UpdateOptions

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

返品

void

set(properties)

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

set(properties: Word.View): void;

パラメーター

properties
Word.View

返品

void

showAllHeadings()

すべての文字列 (見出しおよび本文) の表示と見出しのみの表示を切り替えます。

showAllHeadings(): void;

返品

void

注釈

API セット: WordApiDesktop 1.4

showHeading(level)

指定したレベルまでのすべての見出しを表示し、このレベル以下の見出しと本文は非表示にします。

showHeading(level: number): void;

パラメーター

level

number

表示する見出しレベル。

返品

void

注釈

API セット: WordApiDesktop 1.4

toJSON()

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

toJSON(): Word.Interfaces.ViewData;

返品

track()

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

track(): Word.View;

返品

untrack()

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

untrack(): Word.View;

返品