Word.TextColumnCollection class

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

context: RequestContext;

プロパティ値

このコレクション内に読み込まれた子アイテムを取得します。

readonly items: Word.TextColumn[];

プロパティ値

セクションまたはドキュメントに追加された新しいテキスト列を表す TextColumn オブジェクトを返します。

add(options?: Word.TextColumnAddOptions): Word.TextColumn;

パラメーター

返品

ドキュメントに追加された新しいテキスト列を表す TextColumn オブジェクト。

注釈

API セット: WordApiDesktop 1.3

テキストが 1 つのテキスト列から次のテキスト列に流れる方向を取得します。

getFlowDirection(): OfficeExtension.ClientResult<Word.FlowDirection>;

返品

注釈

API セット: WordApiDesktop 1.3

TextColumnCollection オブジェクトのすべての列の間に縦線が表示されるかどうかを取得します。

getHasLineBetween(): OfficeExtension.ClientResult<boolean>;

返品

注釈

API セット: WordApiDesktop 1.3

テキスト列が等間隔であるかどうかを取得します。

getIsEvenlySpaced(): OfficeExtension.ClientResult<boolean>;

返品

注釈

API セット: WordApiDesktop 1.3

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

load(options?: Word.Interfaces.TextColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TextColumnCollection;

パラメーター

返品

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

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

パラメーター

返品

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TextColumnCollection;

パラメーター

返品

文字列を指定された数の段組みを作成します。

setCount(numColumns: number): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

1 つのテキスト列から次のテキスト列へのテキストのフロー方向を設定します。

setFlowDirection(value: Word.FlowDirection): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

1 つのテキスト列から次のテキスト列へのテキストのフロー方向を設定します。

setFlowDirection(value: "LeftToRight" | "RightToLeft"): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

TextColumnCollection オブジェクトのすべての列の間に縦線を表示するかどうかを設定します。

setHasLineBetween(value: boolean): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

テキスト列を均等に配置するかどうかを設定します。

setIsEvenlySpaced(value: boolean): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

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

toJSON(): Word.Interfaces.TextColumnCollectionData;

返品

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

track(): Word.TextColumnCollection;

返品

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

untrack(): Word.TextColumnCollection;

返品