Excel.TextFrame class

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

Extends

注釈

[ API セット: ExcelApi 1.9 ]

プロパティ

autoSizeSetting

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

bottomMargin

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

context

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

hasText

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

horizontalAlignment

テキスト フレームの水平方向の配置を表します。 詳細は「Excel.ShapeTextHorizontalAlignment」をご覧ください。

horizontalOverflow

テキスト フレームの水平方向のオーバーフローの動作を表します。 詳細は「Excel.ShapeTextHorizontalOverflow」をご覧ください。

leftMargin

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

orientation

テキスト フレームのテキストの向きを示す角度を表します。 詳細は「Excel.ShapeTextOrientation」をご覧ください。

readingOrder

テキスト フレームの読む方向を表します (左から右または右から左)。 詳細は「Excel.ShapeTextReadingOrder」をご覧ください。

rightMargin

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

textRange

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

topMargin

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

verticalAlignment

テキスト フレームの垂直方向の配置を表します。 詳細は「Excel.ShapeTextVerticalAlignment」をご覧ください。

verticalOverflow

テキスト フレームの垂直方向のオーバーフローの動作を表します。 詳細は「Excel.ShapeTextVerticalOverflow」をご覧ください。

メソッド

deleteText()

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

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

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

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

toJSON()

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

プロパティの詳細

autoSizeSetting

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

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

プロパティ値

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

注釈

[ API セット: ExcelApi 1.9 ]

bottomMargin

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

bottomMargin: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.9 ]

context

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

context: RequestContext;

プロパティ値

hasText

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

readonly hasText: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

horizontalAlignment

テキスト フレームの水平方向の配置を表します。 詳細は「Excel.ShapeTextHorizontalAlignment」をご覧ください。

horizontalAlignment: Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";

プロパティ値

Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed"

注釈

[ API セット: ExcelApi 1.9 ]

horizontalOverflow

テキスト フレームの水平方向のオーバーフローの動作を表します。 詳細は「Excel.ShapeTextHorizontalOverflow」をご覧ください。

horizontalOverflow: Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip";

プロパティ値

Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip"

注釈

[ API セット: ExcelApi 1.9 ]

leftMargin

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

leftMargin: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.9 ]

orientation

テキスト フレームのテキストの向きを示す角度を表します。 詳細は「Excel.ShapeTextOrientation」をご覧ください。

orientation: Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL";

プロパティ値

Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL"

注釈

[ API セット: ExcelApi 1.9 ]

readingOrder

テキスト フレームの読む方向を表します (左から右または右から左)。 詳細は「Excel.ShapeTextReadingOrder」をご覧ください。

readingOrder: Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft";

プロパティ値

Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft"

注釈

[ API セット: ExcelApi 1.9 ]

rightMargin

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

rightMargin: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.9 ]

textRange

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

readonly textRange: Excel.TextRange;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

topMargin

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

topMargin: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.9 ]

verticalAlignment

テキスト フレームの垂直方向の配置を表します。 詳細は「Excel.ShapeTextVerticalAlignment」をご覧ください。

verticalAlignment: Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed";

プロパティ値

Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed"

注釈

[ API セット: ExcelApi 1.9 ]

verticalOverflow

テキスト フレームの垂直方向のオーバーフローの動作を表します。 詳細は「Excel.ShapeTextVerticalOverflow」をご覧ください。

verticalOverflow: Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip";

プロパティ値

Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip"

注釈

[ API セット: ExcelApi 1.9 ]

メソッドの詳細

deleteText()

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

deleteText(): void;

戻り値

void

注釈

[ API セット: ExcelApi 1.9 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-textboxes.yaml

await Excel.run(async (context) => {
    const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    const textbox = shapes.getItem("Textbox");
    textbox.textFrame.deleteText();
    await context.sync();
});

load(options)

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

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

パラメーター

options
Excel.Interfaces.TextFrameLoadOptions

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

戻り値

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

戻り値

set(properties, options)

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

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

パラメーター

properties
Excel.Interfaces.TextFrameUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options
OfficeExtension.UpdateOptions

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

戻り値

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.TextFrame): void;

パラメーター

properties
Excel.TextFrame

戻り値

void

toJSON()

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

toJSON(): Excel.Interfaces.TextFrameData;

戻り値