PowerPoint.TextFrame class

図形オブジェクトのテキスト フレームを表します。

Extends

注釈

[ API セット: PowerPointApi 1.4 ]

プロパティ

autoSizeSetting

テキスト フレームの自動サイズ設定。 テキストをテキスト フレームに自動的に合わせる、テキスト フレームをテキストに自動的に合わせる、自動サイズ変更を行わない、のいずれかにテキスト フレームを設定できます。

bottomMargin

テキスト フレームの下余白を表します (ポイント数)。

context

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

hasText

テキスト フレームにテキストが含まれているかどうかを指定します。

leftMargin

テキスト フレームの左余白を表します (ポイント数)。

rightMargin

テキスト フレームの右余白を表します (ポイント数)。

textRange

テキスト フレーム内の図形にアタッチされているテキスト、およびテキストを操作するためのプロパティとメソッドを表します。 詳細については、「 PowerPoint.TextRange 」を参照してください。

topMargin

テキスト フレームの上余白を表します (ポイント数)。

verticalAlignment

テキスト フレームの垂直方向の配置を表します。 詳細については、「 PowerPoint.TextVerticalAlignment 」を参照してください。

wordWrap

図形内のテキストに合わせて自動的に改行するかどうかを指定します。

メソッド

deleteText()

テキスト フレーム内のテキストをすべて削除します。

getParentShape()

この TextFrameを保持する親 PowerPoint.Shape オブジェクトを返します。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

プロパティの詳細

autoSizeSetting

テキスト フレームの自動サイズ設定。 テキストをテキスト フレームに自動的に合わせる、テキスト フレームをテキストに自動的に合わせる、自動サイズ変更を行わない、のいずれかにテキスト フレームを設定できます。

autoSizeSetting: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";

プロパティ値

PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"

注釈

[ API セット: PowerPointApi 1.4 ]

bottomMargin

テキスト フレームの下余白を表します (ポイント数)。

bottomMargin: number;

プロパティ値

number

注釈

[ API セット: PowerPointApi 1.4 ]

context

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

context: RequestContext;

プロパティ値

hasText

テキスト フレームにテキストが含まれているかどうかを指定します。

readonly hasText: boolean;

プロパティ値

boolean

注釈

[ API セット: PowerPointApi 1.4 ]

leftMargin

テキスト フレームの左余白を表します (ポイント数)。

leftMargin: number;

プロパティ値

number

注釈

[ API セット: PowerPointApi 1.4 ]

rightMargin

テキスト フレームの右余白を表します (ポイント数)。

rightMargin: number;

プロパティ値

number

注釈

[ API セット: PowerPointApi 1.4 ]

textRange

テキスト フレーム内の図形にアタッチされているテキスト、およびテキストを操作するためのプロパティとメソッドを表します。 詳細については、「 PowerPoint.TextRange 」を参照してください。

readonly textRange: PowerPoint.TextRange;

プロパティ値

注釈

[ API セット: PowerPointApi 1.4 ]

topMargin

テキスト フレームの上余白を表します (ポイント数)。

topMargin: number;

プロパティ値

number

注釈

[ API セット: PowerPointApi 1.4 ]

verticalAlignment

テキスト フレームの垂直方向の配置を表します。 詳細については、「 PowerPoint.TextVerticalAlignment 」を参照してください。

verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";

プロパティ値

PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered"

注釈

[ API セット: PowerPointApi 1.4 ]

wordWrap

図形内のテキストに合わせて自動的に改行するかどうかを指定します。

wordWrap: boolean;

プロパティ値

boolean

注釈

[ API セット: PowerPointApi 1.4 ]

メソッドの詳細

deleteText()

テキスト フレーム内のテキストをすべて削除します。

deleteText(): void;

戻り値

void

注釈

[ API セット: PowerPointApi 1.4 ]

getParentShape()

この TextFrameを保持する親 PowerPoint.Shape オブジェクトを返します。

getParentShape(): PowerPoint.Shape;

戻り値

注釈

[ API セット: PowerPointApi 1.5 ]

load(options)

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

load(options?: PowerPoint.Interfaces.TextFrameLoadOptions): PowerPoint.TextFrame;

パラメーター

options
PowerPoint.Interfaces.TextFrameLoadOptions

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

戻り値

load(propertyNames)

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

load(propertyNames?: string | string[]): PowerPoint.TextFrame;

パラメーター

propertyNames

string | string[]

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

戻り値

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.TextFrame;

パラメーター

propertyNamesAndPaths

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

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

戻り値

toJSON()

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

toJSON(): PowerPoint.Interfaces.TextFrameData;

戻り値