Word JavaScript API デスクトップのみの要件セット 1.2

WordApiDesktop要件セットは、Windows、Mac、iPad のWordでのみ使用できる機能を含む特別な要件セットです。 この要件セットの API は、Windows、Mac、iPad 上の Word アプリケーション用の運用 API と見なされます。 Microsoft 365 開発者サポート ポリシーに従います。 WordApiDesktop API は、他のプラットフォーム (Web) の "プレビュー" API と見なされ、これらのプラットフォームでサポートされていない場合があります。

WordApiDesktop要件セットの API がすべてのプラットフォームでサポートされている場合は、次にリリースされた要件セット (WordApi 1.[NEXT]) に追加されます。 新しい要件セットが公開されると、これらの API もこの WordApiDesktop 要件セットで引き続きタグ付けされます。 一般的なプラットフォーム固有の要件の詳細については、「 プラットフォーム固有の要件セットについて」を参照してください。

重要

WordApiDesktop 1.2 はデスクトップのみの要件セットです。 これは、WordApi 1.9 と WordApiDesktop 1.1 のスーパーセットです。

WordApiDesktop 1.2 API は Windows、Mac、iPad の Word でのみサポートされるため、アドインチェック要件セットがサポートされている場合は、これらの API を呼び出す必要があります。 これにより、サポートされていないプラットフォームでデスクトップ専用 API を使用しようとする試みを回避できます。

if (Office.context.requirements.isSetSupported("WordApiDesktop", "1.2")) {
   // Any API exclusive to this WordApiDesktop requirement set.
}

API がクロスプラットフォーム要件セットになったら、isSetSupported チェックを削除または編集する必要があります。 これにより、他のプラットフォームでのアドインの機能が有効になります。 この変更を行う際は、必ずそれらのプラットフォームで機能をテストしてください。

重要

アドインのみ (XML) マニフェストでは、アクティブ化要件としてデスクトップ専用またはオンライン専用の要件セットを指定できません。 これは、Set 要素で使用する有効な値ではありません。 統合マニフェストでは、 "requirements.capabilities" プロパティでデスクトップ専用の要件セットがサポートされています。

API リスト

次の表は、WordApiDesktop 1.2要件セットに現在含まれている Word つの JavaScript API の一覧です。 すべての Word JavaScript API (WordApiDesktop 1.2 API と以前にリリースされた API を含む) の完全なリストについては、すべての Word JavaScript API を参照してください。

クラス フィールド 説明
Body shapes インライン図形と浮動図形の両方を含む、本文内の Shape オブジェクトのコレクションを取得します。
キャンバス id キャンバス識別子を表す整数を取得します。
shape キャンバスに関連付けられている Shape オブジェクトを取得します。
shapes Word のコレクションを取得します。オブジェクトをシェイプします。
ドキュメント activeWindow ドキュメントのアクティブなウィンドウを取得します。
compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions) 現在のドキュメントと指定したドキュメントのどこが違うかを示すリビジョン マークを表示します。
windows ドキュメントの Word.Window オブジェクトのコレクションを取得します。
フォント hidden フォントに非表示としてタグ付けするかどうかを指定します。
InsertShapeOptions height 指定した場合は、挿入する図形の高さを指定します。
left 指定した場合は、挿入する図形の左位置を指定します。
top 指定した場合は、挿入する図形の最上部の位置を指定します。
width 指定した場合は、挿入する図形の幅を指定します。
Page getNext() ウィンドウの次のページを取得します。
getNextOrNullObject() 次のページを取得します。
getRange(rangeLocation?: Word.RangeLocation.whole |Word.RangeLocation.start |Word.RangeLocation.end |"全体" |"開始" |"End") ページ全体、ページの開始点または終了点を範囲として取得します。
height [ページ設定] ダイアログ ボックスで定義された用紙の高さをポイント単位で取得します。
index ページのインデックスを取得します。
width [ページ設定] ダイアログ ボックスで定義された用紙の幅をポイント単位で取得します。
PageCollection getFirst() このコレクションの最初のページを取得します。
getFirstOrNullObject() このコレクションの最初のページを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
ペイン getNext() ウィンドウ内の次のウィンドウを取得します。
getNextOrNullObject() 次のウィンドウを取得します。
pages ウィンドウ内のページのコレクションを取得します。
pagesEnclosingViewport ウィンドウのビューポートに表示される PageCollection を取得します。
PaneCollection getFirst() このコレクションの最初のウィンドウを取得します。
getFirstOrNullObject() このコレクションの最初のウィンドウを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
Paragraph insertCanvas(insertShapeOptions?: Word.InsertShapeOptions) アンカーを段落の先頭に配置して、テキストの前にフローティング キャンバスを挿入します。
insertGeometricShape(GeometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions) テキストの前に幾何学図形を挿入し、アンカーを段落の先頭に配置します。
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions) アンカーを段落の先頭に配置して、テキストの前に浮動画像を挿入します。
insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions) テキストの前にフローティング テキスト ボックスを挿入し、アンカーを段落の先頭に配置します。
shapes インライン図形とフローティング図形の両方を含む、段落に固定されている Shape オブジェクトのコレクションを取得します。
Range insertCanvas(insertShapeOptions?: Word.InsertShapeOptions) テキストの前にフローティング キャンバスを挿入し、アンカーを範囲の先頭に配置します。
insertGeometricShape(GeometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions) テキストの前に幾何学図形を挿入し、範囲の先頭にアンカーを配置します。
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions) テキストの前に浮動ピクチャを挿入し、範囲の先頭にアンカーを配置します。
insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions) テキストの前にフローティング テキスト ボックスを挿入し、アンカーを範囲の先頭に配置します。
pages 範囲内のページのコレクションを取得します。
shapes 範囲に固定されている Shape オブジェクトのコレクション (インライン図形と浮動図形の両方を含む) を取得します。
Shape allowOverlap 特定の図形が他の図形と重なることができるかどうかを指定します。
altTextDescription 図形に関連付けられている代替テキストを表す文字列を指定します。
body 図形の Body オブジェクトを取得します。
キャンバス 図形に関連付けられているキャンバスを取得します。
delete() 図形とその内容を削除します。
fill 図形の塗りつぶしの書式設定を返します。
geometricShapeType 図形の幾何学的形状の種類を指定します。
height 図形の高さをポイント単位で指定します。
heightRelative 相対的な垂直サイズに対する図形の高さの割合を指定します (つまり、 relativeVerticalSize プロパティ)。
id 図形の識別子を表す整数を取得します。
isChild この図形がグループ図形の子であるかキャンバス図形であるかを確認します。
left 図形の左側から相対的な水平位置 (つまり、 relativeHorizontalPosition プロパティ) までの距離をポイント単位で指定します。
leftRelative 図形の左側からの相対的な水平位置に対するパーセンテージ (つまり、 relativeHorizontalalPosition プロパティ) を指定します。
lockAspectRatio この図形の縦横比をロックするかどうかを指定します。
moveHorizontally(distance: number) ポイントの数だけ図形を水平方向に移動します。
moveVertically(distance: number) ポイントの数だけ図形を垂直方向に移動します。
name 図形の名前を指定します。
parentCanvas この子図形の最上位の親キャンバス図形を取得します。
parentGroup この子図形の最上位レベルの親グループ図形を取得します。
relativeHorizontalPosition 図形の相対的な水平位置を指定します。
relativeHorizontalSize 図形の相対的な水平方向のサイズを指定します。
relativeVerticalPosition 図形の相対的な垂直位置を指定します。
relativeVerticalSize 図形の相対的な垂直方向のサイズを指定します。
rotation 図形の回転を度単位で指定します。
scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom) 指定した係数分だけ図形の高さを変更します。
scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom) 指定した係数分だけ図形の幅を変更します。
select(selectMultipleShapes?: boolean) 図形を選びます。
shapeGroup 図形に関連付けられている図形グループを取得します。
textFrame 図形の TextFrame オブジェクトを取得します。
textWrap 図形の文字列の折り返し書式を返します。
top 図形の上端から相対的な垂直位置 (つまり、 relativeVerticalPosition プロパティ) までの距離をポイント単位で指定します。
topRelative 相対的な最上位置を、図形の上端から相対的な垂直位置までのパーセンテージで指定します (つまり、 relativeVerticalPosition プロパティ)。
type 形状の種類を取得します。
visible 図形を表示するかどうかを指定します。
width 図形の幅をポイント単位で指定します。
widthRelative 相対的な水平サイズに対する図形の幅のパーセンテージを指定します (つまり、 relativeHorizontalSize プロパティ)。
ShapeCollection getByGeometricTypes(types: Word.GeometricShapeType[]) 指定された幾何学的タイプを持つ図形を取得します。
getById(id: number) 識別子によって図形を取得します。
getByIdOrNullObject(id: number) 識別子によって図形を取得します。
getByIds(ids: number[]) 識別子によって図形を取得します。
getByNames(names: string[]) 指定した名前の図形を取得します。
getByTypes(types: Word.ShapeType[]) 指定した型の図形を取得します。
getFirst() このコレクション内の最初の図形を取得します。
getFirstOrNullObject() このコレクション内の最初の図形を取得します。
group() このコレクション内のフローティング図形をグループ化すると、インライン図形はスキップされます。
items このコレクション内に読み込まれた子アイテムを取得します。
ShapeFill backgroundColor 図形の塗りつぶしの背景色を指定します。
clear() この図形の塗りつぶしの書式設定をクリアし、[ Word.ShapeFillType.noFill] に設定します。
foregroundColor 図形の塗りつぶしの前景色を指定します。
setSolidColor(color: string) 図形の塗りつぶしの書式設定を均一な色に設定します。
transparency 塗りつぶしの透明度の割合を、0.0 (不透明) から 1.0 (クリア) までの値で指定します。
type 図形の塗りつぶしの種類を返します。
ShapeGroup id 図形グループの識別子を表す整数を取得します。
shape グループに関連付けられている Shape オブジェクトを取得します。
shapes Shape オブジェクトのコレクションを取得します。
ungroup() 指定した図形グループに含まれるグループ化された図形のグループを解除します。
ShapeTextWrap bottomDistance ドキュメント テキストと、指定した図形を囲むテキストのない領域の下端までの距離 (ポイント単位) を指定します。
leftDistance ドキュメント テキストと、指定した図形を囲むテキストのない領域の左端との間の距離 (ポイント単位) を指定します。
rightDistance ドキュメント テキストと、指定した図形を囲むテキストのない領域の右端との間の距離 (ポイント単位) を指定します。
サイド ドキュメント テキストを、指定した図形の両側で折り返すか、左側か右側のみか、図形のページ余白から最も遠い側で折り返すかを指定します。
topDistance ドキュメント テキストと、指定した図形を囲むテキストのない領域の上端までの距離 (ポイント単位) を指定します。
type 図形の周りの文字列の折り返しの種類を指定します。
TextFrame autoSizeSetting テキスト フレームの自動サイズ変更設定を指定します。
bottomMargin テキスト フレームの下余白をポイント単位で指定します。
hasText テキスト フレームにテキストが含まれている場合は true を返し、それ以外の場合は falseを返します。
leftMargin テキスト フレームの左余白をポイント単位で指定します。
noTextRotation 図形を回転したときにテキスト フレーム内のテキストを回転させないかどうかを指定します。
orientation テキスト フレームに対するテキストの向きの角度を指定します。
rightMargin テキスト フレームの右余白をポイント単位で指定します。
topMargin テキスト フレームの上余白をポイント単位で指定します。
verticalAlignment テキスト フレームの垂直方向の配置を指定します。
wordWrap テキストを図形内に収めるために自動的に改行するかどうかを決定します。
Window activePane ウィンドウ内のアクティブなウィンドウを取得します。
ウィンドウ ウィンドウ内のウィンドウのコレクションを取得します。
WindowCollection getFirst() このコレクション内の最初のウィンドウを取得します。
getFirstOrNullObject() このコレクション内の最初のウィンドウを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。

関連項目

  • 最終更新: