Word.Frame class
レイアウト枠を表します。
Frame オブジェクトは、Wordのメンバーです。FrameCollection オブジェクト。
- Extends
プロパティ
| borders | フレームのすべての罫線を表す |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| height | フレームの高さをポイント単位で指定します。 |
| height |
フレームの高さを決定するためのルールを表す |
| horizontal |
フレームと周囲のテキストの水平方向の距離をポイント単位で指定します。 |
| horizontal |
フレームの端と、 |
| lock |
フレームがロックされているかどうかを指定します。 |
| range | フレーム内に含まれるドキュメントの部分を表す |
| relative |
フレームの相対水平位置を指定します。 |
| relative |
フレームの相対的な垂直位置を指定します。 |
| shading | フレームのシェーディング書式設定を参照する |
| text |
文書のテキストをフレームの周りに折り返すかどうかを指定します。 |
| vertical |
フレームと周囲のテキストとの間の垂直距離 (ポイント単位) を指定します。 |
| vertical |
フレームの端と、 |
| width | フレームの幅 (ポイント単位) を指定します。 |
| width |
フレームの幅を決定するために使用するルールを指定します。 |
メソッド
| copy() | フレームをクリップボードにコピーします。 |
| cut() | ドキュメントからフレームを削除し、クリップボードに配置します。 |
| delete() | フレームを削除します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| select() | フレームを選択します。 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 |
プロパティの詳細
borders
フレームのすべての罫線を表す BorderUniversalCollection オブジェクトを返します。
readonly borders: Word.BorderUniversalCollection;プロパティ値
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
height
heightRule
フレームの高さを決定するためのルールを表す FrameSizeRule 値を指定します。
heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";プロパティ値
Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"
注釈
horizontalDistanceFromText
フレームと周囲のテキストの水平方向の距離をポイント単位で指定します。
horizontalDistanceFromText: number;プロパティ値
number
注釈
horizontalPosition
フレームの端と、 relativeHorizontalPosition プロパティで指定された項目間の水平方向の距離を指定します。
horizontalPosition: number;プロパティ値
number
注釈
lockAnchor
range
フレーム内に含まれるドキュメントの部分を表す Range オブジェクトを返します。
readonly range: Word.Range;プロパティ値
注釈
relativeHorizontalPosition
フレームの相対水平位置を指定します。
relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";プロパティ値
Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"
注釈
relativeVerticalPosition
フレームの相対的な垂直位置を指定します。
relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";プロパティ値
Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
注釈
shading
フレームのシェーディング書式設定を参照する ShadingUniversal オブジェクトを返します。
readonly shading: Word.ShadingUniversal;プロパティ値
注釈
textWrap
verticalDistanceFromText
フレームと周囲のテキストとの間の垂直距離 (ポイント単位) を指定します。
verticalDistanceFromText: number;プロパティ値
number
注釈
verticalPosition
フレームの端と、 relativeVerticalPosition プロパティで指定された項目との間の垂直距離を指定します。
verticalPosition: number;プロパティ値
number
注釈
width
widthRule
フレームの幅を決定するために使用するルールを指定します。
widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";プロパティ値
Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"
注釈
メソッドの詳細
copy()
cut()
delete()
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.FrameLoadOptions): Word.Frame;パラメーター
- options
- Word.Interfaces.FrameLoadOptions
読み込むオブジェクトのプロパティのオプションを提供します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.Frame;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.Frame;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
返品
select()
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.FrameUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Word.Interfaces.FrameUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Word.Frame): void;パラメーター
- properties
- Word.Frame
返品
void
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Word.Frame オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.FrameData として型指定) を返します。
toJSON(): Word.Interfaces.FrameData;返品
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.Frame;返品
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync() を呼び出す必要があります。
untrack(): Word.Frame;