Word.TableColumn class
Word ドキュメント内のテーブル列を表します。
- Extends
プロパティ
| borders | テーブル列のすべての罫線を表す |
| column |
コレクション内のこの列の位置を返します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| is |
列または行がテーブルの最初の列である場合は |
| is |
列または行がテーブル内の最後の行の場合は |
| nesting |
列の入れ子レベルを返します。 |
| preferred |
列の優先幅 (ポイント単位、またはウィンドウ幅のパーセンテージ) を指定します。 測定単位は、 |
| preferred |
テーブル列の幅に使用する測定単位を指定します。 |
| shading | 列の網かけの書式設定を参照する |
| width | 列の幅をポイント単位で指定します。 |
メソッド
| auto |
セル内のテキストの折り返し方法を変更せずに、テキストの幅に合わせてテーブル列の幅を変更します。 |
| delete() | 列を削除します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| select() | テーブル列を選択します。 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| set |
テーブル内の列の幅を設定します。 |
| set |
テーブル内の列の幅を設定します。 |
| sort() | テーブル列を並べ替えます。 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 |
プロパティの詳細
borders
テーブル列のすべての罫線を表す BorderUniversalCollection オブジェクトを返します。
readonly borders: Word.BorderUniversalCollection;プロパティ値
注釈
columnIndex
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
isFirst
列または行がテーブルの最初の列である場合は true を返します。それ以外の場合は false 。
readonly isFirst: boolean;プロパティ値
boolean
注釈
isLast
列または行がテーブル内の最後の行の場合は true を返します。それ以外の場合は false 。
readonly isLast: boolean;プロパティ値
boolean
注釈
nestingLevel
preferredWidth
列の優先幅 (ポイント単位、またはウィンドウ幅のパーセンテージ) を指定します。 測定単位は、 preferredWidthType プロパティで指定できます。
preferredWidth: number;プロパティ値
number
注釈
preferredWidthType
テーブル列の幅に使用する測定単位を指定します。
preferredWidthType: Word.PreferredWidthType | "Auto" | "Percent" | "Points";プロパティ値
Word.PreferredWidthType | "Auto" | "Percent" | "Points"
注釈
shading
列の網かけの書式設定を参照する ShadingUniversal オブジェクトを返します。
readonly shading: Word.ShadingUniversal;プロパティ値
注釈
width
メソッドの詳細
autoFit()
セル内のテキストの折り返し方法を変更せずに、テキストの幅に合わせてテーブル列の幅を変更します。
autoFit(): void;返品
void
注釈
delete()
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.TableColumnLoadOptions): Word.TableColumn;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.TableColumn;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.TableColumn;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
返品
select()
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Word.Interfaces.TableColumnUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Word.TableColumn): void;パラメーター
- properties
- Word.TableColumn
返品
void
setWidth(columnWidth, rulerStyle)
テーブル内の列の幅を設定します。
setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void;パラメーター
- columnWidth
-
number
設定する幅。
- rulerStyle
- Word.RulerStyle
適用するルーラー スタイル。
返品
void
注釈
setWidth(columnWidth, rulerStyle)
テーブル内の列の幅を設定します。
setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;パラメーター
- columnWidth
-
number
設定する幅。
- rulerStyle
-
"None" | "Proportional" | "FirstColumn" | "SameWidth"
適用するルーラー スタイル。
返品
void
注釈
sort()
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Word.TableColumn オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.TableColumnData として型指定) を返します。
toJSON(): Word.Interfaces.TableColumnData;返品
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.TableColumn;返品
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync() を呼び出す必要があります。
untrack(): Word.TableColumn;