Word.ShapeTextWrap class
図形の周囲にテキストを折り返すすべてのプロパティを表します。
- Extends
注釈
[ API set: WordApiDesktop 1.2 ]
プロパティ
| bottom |
文書のテキストと、指定した図形を囲むテキストのない領域の下端との間の距離 (ポイント単位) を指定します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| left |
文書のテキストと、指定した図形を囲むテキストのない領域の左端との間の距離をポイント単位で指定します。 |
| right |
文書のテキストと、指定した図形を囲むテキストのない領域の右端との間の距離をポイント単位で指定します。 |
| side | 文書のテキストを、指定した図形の両側、左側または右側、またはページ余白から最も遠い図形の側にラップするかどうかを指定します。 |
| top |
文書のテキストと、指定した図形を囲むテキストのない領域の上端との間の距離 (ポイント単位) を指定します。 |
| type | 図形の周囲のテキスト折り返しの種類を指定します。 詳細は「 |
メソッド
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 |
プロパティの詳細
bottomDistance
文書のテキストと、指定した図形を囲むテキストのない領域の下端との間の距離 (ポイント単位) を指定します。
bottomDistance: number;プロパティ値
number
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
leftDistance
文書のテキストと、指定した図形を囲むテキストのない領域の左端との間の距離をポイント単位で指定します。
leftDistance: number;プロパティ値
number
注釈
rightDistance
文書のテキストと、指定した図形を囲むテキストのない領域の右端との間の距離をポイント単位で指定します。
rightDistance: number;プロパティ値
number
注釈
side
文書のテキストを、指定した図形の両側、左側または右側、またはページ余白から最も遠い図形の側にラップするかどうかを指定します。
side: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest";プロパティ値
Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"
注釈
topDistance
文書のテキストと、指定した図形を囲むテキストのない領域の上端との間の距離 (ポイント単位) を指定します。
topDistance: number;プロパティ値
number
注釈
type
図形の周囲のテキスト折り返しの種類を指定します。 詳細は「Word.ShapeTextWrapType」をご覧ください。
type: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front";プロパティ値
Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"
注釈
メソッドの詳細
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.ShapeTextWrapLoadOptions): Word.ShapeTextWrap;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.ShapeTextWrap;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.ShapeTextWrap;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.ShapeTextWrapUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Word.Interfaces.ShapeTextWrapUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Word.ShapeTextWrap): void;パラメーター
- properties
- Word.ShapeTextWrap
戻り値
void
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Word.ShapeTextWrap オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.ShapeTextWrapData として型指定) を返します。
toJSON(): Word.Interfaces.ShapeTextWrapData;戻り値
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.ShapeTextWrap;戻り値
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync() を呼び出す必要があります。
untrack(): Word.ShapeTextWrap;戻り値
Office Add-ins