Word.TableColumn class

Word 文書の表列を表します。

注釈

使用元

プロパティ

borders	テーブル列のすべての境界線を表す `BorderUniversalCollection` オブジェクトを返します。
columnIndex	コレクション内のこの列の位置を返します。
context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
isFirst	列または行がテーブルの最初の列の場合 `true` 返します。それ以外の場合は `false` 返します。
isLast	列または行がテーブルの最後の列である場合は `true` を返し、それ以外の場合は `false` 返します。
nestingLevel	列の入れ子レベルを返します。
preferredWidth	列の優先幅 (ウィンドウ幅のポイントまたはパーセンテージ) を指定します。測定単位は、 `preferredWidthType` プロパティで指定できます。
preferredWidthType	テーブルの列の幅に使用する優先計測単位を指定します。
shading	列の網掛け書式を参照する `ShadingUniversal` オブジェクトを返します。
width	列の幅をポイント単位で指定します。

メソッド

autoFit()	セル内での文字列の折り返しの方法を変更せずに、文字列の幅に合わせて表の列の幅を変更します。
delete()	列を削除します。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
select()	テーブルの列を選択します。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
setWidth(columnWidth, rulerStyle)	テーブルの列幅を設定します。
setWidth(columnWidth, rulerStyle)	テーブルの列幅を設定します。
sort()	テーブルの列を並べ替えます。
toJSON()	API オブジェクトが `JSON.stringify()` に渡されるときに、より有用な出力を提供するために、JavaScript `toJSON()` メソッドをオーバーライドします。 (次に、`JSON.stringify`渡されたオブジェクトの `toJSON` メソッドを呼び出します)。元の `Word.TableColumn` オブジェクトが API オブジェクトであるのに対し、 `toJSON` メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( `Word.Interfaces.TableColumnData` と型指定) を返します。
track()	ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。このオブジェクトを `.sync` 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクトコレクションにオブジェクトを追加する必要があります。このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
untrack()	前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。追跡対象オブジェクトが多いとホストアプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。メモリリリースを有効にする前に、 `context.sync()` を呼び出す必要があります。

borders

テーブル列のすべての境界線を表す BorderUniversalCollection オブジェクトを返します。

readonly borders: Word.BorderUniversalCollection;

プロパティ値

Word.BorderUniversalCollection

注釈

API セット: WordApiDesktop 1.3

columnIndex

コレクション内のこの列の位置を返します。

readonly columnIndex: number;

プロパティ値

number

注釈

API セット: WordApiDesktop 1.3

context

オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Word.RequestContext

isFirst

列または行がテーブルの最初の列の場合 true 返します。それ以外の場合は false 返します。

readonly isFirst: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.3

isLast

列または行がテーブルの最後の列である場合は true を返し、それ以外の場合は false 返します。

readonly isLast: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.3

nestingLevel

列の入れ子レベルを返します。

readonly nestingLevel: number;

プロパティ値

number

注釈

API セット: WordApiDesktop 1.3

preferredWidth

列の優先幅 (ウィンドウ幅のポイントまたはパーセンテージ) を指定します。測定単位は、 preferredWidthType プロパティで指定できます。

preferredWidth: number;

プロパティ値

number

注釈

API セット: WordApiDesktop 1.3

preferredWidthType

テーブルの列の幅に使用する優先計測単位を指定します。

preferredWidthType: Word.PreferredWidthType | "Auto" | "Percent" | "Points";

プロパティ値

Word.PreferredWidthType | "Auto" | "Percent" | "Points"

注釈

API セット: WordApiDesktop 1.3

shading

列の網掛け書式を参照する ShadingUniversal オブジェクトを返します。

readonly shading: Word.ShadingUniversal;

プロパティ値

Word.ShadingUniversal

注釈

API セット: WordApiDesktop 1.3

width

列の幅をポイント単位で指定します。

width: number;

プロパティ値

number

注釈

API セット: WordApiDesktop 1.3

autoFit()

セル内での文字列の折り返しの方法を変更せずに、文字列の幅に合わせて表の列の幅を変更します。

autoFit(): void;

返品

void

注釈

API セット: WordApiDesktop 1.3

delete()

列を削除します。

delete(): void;

返品

void

注釈

API セット: WordApiDesktop 1.3

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Word.Interfaces.TableColumnLoadOptions): Word.TableColumn;

パラメーター

options: Word.Interfaces.TableColumnLoadOptions

読み込むオブジェクトのプロパティのオプションを指定します。

返品

Word.TableColumn

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Word.TableColumn;

パラメーター

propertyNames: string | string[]

読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。

返品

Word.TableColumn

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.TableColumn;

パラメーター

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。

返品

Word.TableColumn

select()

テーブルの列を選択します。

select(): void;

返品

void

注釈

API セット: WordApiDesktop 1.3

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクト、または同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties: Word.Interfaces.TableColumnUpdateData

メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。

options: OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

返品

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

注釈

API セット: WordApiDesktop 1.3

setWidth(columnWidth, rulerStyle)

テーブルの列幅を設定します。

setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;

パラメーター

columnWidth: number

設定する幅。

rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"

適用するルーラースタイル。

返品

void

注釈

API セット: WordApiDesktop 1.3

sort()

テーブルの列を並べ替えます。

sort(): void;

返品

void

注釈

API セット: WordApiDesktop 1.3

toJSON()

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.TableColumn オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.TableColumnData と型指定) を返します。

toJSON(): Word.Interfaces.TableColumnData;

返品

Word.Interfaces.TableColumnData

track()

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクトコレクションにオブジェクトを追加する必要があります。このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。

track(): Word.TableColumn;

返品

Word.TableColumn

untrack()

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。追跡対象オブジェクトが多いとホストアプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。メモリリリースを有効にする前に、 context.sync() を呼び出す必要があります。

untrack(): Word.TableColumn;

返品

Word.TableColumn

注釈

使用元

プロパティ

メソッド

プロパティの詳細

borders

プロパティ値

注釈

columnIndex

プロパティ値

注釈

context

プロパティ値

isFirst

プロパティ値

注釈

isLast

プロパティ値

注釈

nestingLevel

プロパティ値

注釈

preferredWidth

プロパティ値

注釈

preferredWidthType

プロパティ値

注釈

shading

プロパティ値

注釈

width

プロパティ値

注釈

メソッドの詳細

autoFit()

返品

注釈

delete()

返品

注釈

load(options)

パラメーター

返品

load(propertyNames)

パラメーター

返品

load(propertyNamesAndPaths)

パラメーター

返品

select()

返品

注釈

set(properties, options)

パラメーター

返品

set(properties)

パラメーター

返品

setWidth(columnWidth, rulerStyle)

パラメーター

返品

注釈

setWidth(columnWidth, rulerStyle)

パラメーター

返品

注釈

sort()

返品

注釈

toJSON()

返品

track()

返品

untrack()

返品

フィードバック