Word.TextColumnCollection class
Wordのコレクション。文書または文書のセクション内のすべてのテキスト列を表す TextColumn オブジェクト。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(options) | セクションまたはドキュメントに追加された新しいテキスト列を表す |
| get |
1 つのテキスト列から次の列にテキストが流れる方向を取得します。 |
| get |
|
| get |
テキスト列が均等に間隔を空けるかどうかを取得します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set |
文字列を指定された数の段組みを作成します。 |
| set |
テキストが 1 つのテキスト列から次の列に流れる方向を設定します。 |
| set |
テキストが 1 つのテキスト列から次の列に流れる方向を設定します。 |
| set |
|
| set |
テキスト列を均等に配置するかどうかを設定します。 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
items
メソッドの詳細
add(options)
セクションまたはドキュメントに追加された新しいテキスト列を表す TextColumn オブジェクトを返します。
add(options?: Word.TextColumnAddOptions): Word.TextColumn;パラメーター
- options
- Word.TextColumnAddOptions
省略可能。 新しいテキスト列を構成するためのオプション。
戻り値
ドキュメントに追加された新しいテキスト列を表す TextColumn オブジェクト。
注釈
getFlowDirection()
1 つのテキスト列から次の列にテキストが流れる方向を取得します。
getFlowDirection(): OfficeExtension.ClientResult<Word.FlowDirection>;戻り値
注釈
getHasLineBetween()
TextColumnCollection オブジェクト内のすべての列の間に垂直線が表示されるかどうかを取得します。
getHasLineBetween(): OfficeExtension.ClientResult<boolean>;戻り値
OfficeExtension.ClientResult<boolean>
注釈
getIsEvenlySpaced()
テキスト列が均等に間隔を空けるかどうかを取得します。
getIsEvenlySpaced(): OfficeExtension.ClientResult<boolean>;戻り値
OfficeExtension.ClientResult<boolean>
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.TextColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TextColumnCollection;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.TextColumnCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TextColumnCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
setCount(numColumns)
文字列を指定された数の段組みを作成します。
setCount(numColumns: number): void;パラメーター
- numColumns
-
number
文字列の段組み数を指定します。
戻り値
void
注釈
setFlowDirection(value)
テキストが 1 つのテキスト列から次の列に流れる方向を設定します。
setFlowDirection(value: Word.FlowDirection): void;パラメーター
- value
- Word.FlowDirection
設定するフロー方向。
戻り値
void
注釈
setFlowDirection(value)
テキストが 1 つのテキスト列から次の列に流れる方向を設定します。
setFlowDirection(value: "LeftToRight" | "RightToLeft"): void;パラメーター
- value
-
"LeftToRight" | "RightToLeft"
設定するフロー方向。
戻り値
void
注釈
setHasLineBetween(value)
TextColumnCollection オブジェクト内のすべての列の間に垂直線を表示するかどうかを設定します。
setHasLineBetween(value: boolean): void;パラメーター
- value
-
boolean
true 列間の垂直線を表示します。
戻り値
void
注釈
setIsEvenlySpaced(value)
テキスト列を均等に配置するかどうかを設定します。
setIsEvenlySpaced(value: boolean): void;パラメーター
- value
-
boolean
true を使用して、ドキュメント内のすべてのテキスト列を均等に配置します。
戻り値
void
注釈
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Word.TextColumnCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Word.Interfaces.TextColumnCollectionDataとして型指定) を返します。
toJSON(): Word.Interfaces.TextColumnCollectionData;戻り値
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.TextColumnCollection;戻り値
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync() を呼び出す必要があります。
untrack(): Word.TextColumnCollection;