次の方法で共有

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 チェックを削除または編集する必要があります。 これにより、他のプラットフォームでアドインの機能が有効になります。 この変更を行うときは、これらのプラットフォームで機能をテストしてください。

重要

マニフェストでは、アクティブ化要件として WordApiDesktop 1.2 を指定できません。 Set 要素で使用する有効な値ではありません。

API リスト

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

クラス フィールド 説明
Body shapes インライン図形と浮動図形の両方を含む、本文内の図形オブジェクトのコレクションを取得します。
キャンバス id キャンバス識別子を表す整数を取得します。
shape キャンバスに関連付けられている Shape オブジェクトを取得します。
shapes Shape オブジェクトのコレクションを取得します。
ドキュメント activeWindow ドキュメントのアクティブ ウィンドウを取得します。
compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions) 指定された文書と別の文書を比較して、変更箇所を示す変更履歴を表示します。
ウィンドウズ ドキュメントの Word.Window オブジェクトのコレクションを取得します。
InsertShapeOptions height 挿入する図形の高さを表します。
left 挿入する図形の左の位置を表します。
top 挿入する図形の上端の位置を表します。
width 挿入する図形の幅を表します。
Page getNext() ウィンドウ内の次のページを取得します。
getNextOrNullObject() 次のページを取得します。
getRange(rangeLocation?: Word。RangeLocation.whole |Word。RangeLocation.start |Word。RangeLocation.end |"全体" |"Start" |"End") ページ全体、またはページの始点または終了位置を範囲として取得します。
height [ページ設定] ダイアログ ボックスで定義されている用紙の高さをポイント単位で取得します。
index ページのインデックスを取得します。
width [ページ設定] ダイアログ ボックスで定義されている用紙の幅をポイント単位で取得します。
PageCollection getFirst() このコレクションの最初のページを取得します。
getFirstOrNullObject() このコレクションの最初のページを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
ペイン getNext() ウィンドウ内の次のウィンドウを取得します。
getNextOrNullObject() 次のウィンドウを取得します。
pages ウィンドウ内のページのコレクションを取得します。
pagesEnclosingViewport ウィンドウのビューポートに表示される PageCollection を取得します。
PaneCollection getFirst() このコレクションの最初のウィンドウを取得します。
getFirstOrNullObject() このコレクションの最初のウィンドウを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
Paragraph insertCanvas(insertShapeOptions?: Word。InsertShapeOptions) 段落の先頭にアンカーを付け、テキストの前に浮動キャンバスを挿入します。
insertGeometricShape(geometrShapeType: Word。GeometrShapeType、insertShapeOptions?: Word。InsertShapeOptions) テキストの前に、段落の先頭にアンカーを含む幾何学的図形を挿入します。
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions) 段落の先頭にアンカーを付け、テキストの前に浮動画像を挿入します。
insertTextBox(text?: string, insertShapeOptions?: Word。InsertShapeOptions) 段落の先頭にアンカーを付け、テキストの前に浮動テキスト ボックスを挿入します。
shapes インライン図形と浮動図形の両方を含む、段落に固定されている図形オブジェクトのコレクションを取得します。
Range insertCanvas(insertShapeOptions?: Word。InsertShapeOptions) 範囲の先頭にアンカーを付け、テキストの前に浮動キャンバスを挿入します。
insertGeometricShape(geometrShapeType: Word。GeometrShapeType、insertShapeOptions?: Word。InsertShapeOptions) 範囲の先頭にアンカーを付け、テキストの前に幾何学的図形を挿入します。
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions) 範囲の先頭にアンカーを付け、テキストの前に浮動画像を挿入します。
insertTextBox(text?: string, insertShapeOptions?: Word。InsertShapeOptions) 範囲の先頭にアンカーを付け、テキストの前に浮動テキスト ボックスを挿入します。
pages 範囲内のページのコレクションを取得します。
shapes インライン図形と浮動図形の両方を含む、範囲内に固定された図形オブジェクトのコレクションを取得します。
Shape allowOverlap 特定の図形が他の図形と重なることができるかどうかを指定します。
altTextDescription 図形に関連付けられている代替テキストを表す文字列を指定します。
body 図形の body オブジェクトを表します。
カンバス 図形に関連付けられているキャンバスを取得します。
delete() 図形とその内容を削除します。
fill 図形の塗りつぶしの書式設定を返します。
geometricShapeType 図形の幾何学的図形の種類。
height 図形の高さ (ポイント単位)。
heightRelative 垂直方向の相対的なサイズに対する図形の高さの割合については、「Word」を参照してください。RelativeSize。
id 図形識別子を表す整数を取得します。
isChild この図形がグループ図形またはキャンバス図形の子であるかどうかを確認します。
left 図形の左側から水平方向の相対位置までの距離 (ポイント単位) については、「Word」を参照してください。RelativeHorizontalPosition。
leftRelative 図形の左側から水平方向の相対位置に対する割合としての相対左位置については、「Word」を参照してください。RelativeHorizontalPosition。
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 図形のテキスト フレーム オブジェクトを取得します。
textWrap 図形のテキスト折り返し書式を返します。
top 図形の上端から垂直相対位置までの距離 (ポイント単位) については、「Word」を参照してください。RelativeVerticalPosition。
topRelative 図形の上端から垂直方向の相対位置までの割合としての相対的な上端の位置については、「Word」を参照してください。RelativeVerticalPosition。
type 図形の種類を取得します。
visible 図形を表示するかどうかを指定します。
width 図形の幅をポイント単位で指定します。
widthRelative 水平方向の相対サイズに対する図形の幅の割合については、「Word」を参照してください。RelativeSize。
ShapeCollection getByGeometricTypes(types: Word。GeometrShapeType[]) 指定したジオメトリ型を持つ図形を取得します。
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 テキスト フレームにテキストが含まれているかどうかを指定します。
leftMargin テキスト フレームの左余白を表します (ポイント数)。
noTextRotation 図形の回転時にテキスト フレーム内のテキストが回転しない場合は True を返します。
orientation テキスト フレームのテキストの向きを示す角度を表します。
rightMargin テキスト フレームの右余白を表します (ポイント数)。
topMargin テキスト フレームの上余白を表します (ポイント数)。
verticalAlignment テキスト フレームの垂直方向の配置を表します。
wordWrap 図形内のテキストに合わせて自動的に改行するかどうかを指定します。
Window activePane ウィンドウ内のアクティブなウィンドウを取得します。
ペイン ウィンドウ内のペインのコレクションを取得します。
WindowCollection getFirst() このコレクションの最初のウィンドウを取得します。
getFirstOrNullObject() このコレクションの最初のウィンドウを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。

関連項目