Excel.TextFrame class

Shape オブジェクトのレイアウト枠を表します。Represents the text frame of a shape object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

Extends

プロパティ

autoSizeSetting

テキスト フレームの自動サイズ変更設定を取得または設定します。Gets or sets the automatic sizing settings for the text frame. テキストをテキスト フレームに自動的に合わせる、テキスト フレームをテキストに自動的に合わせる、自動サイズ変更を行わない、のいずれかにテキスト フレームを設定できます。A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

bottomMargin

テキスト フレームの下余白を表します (ポイント数)。Represents the bottom margin, in points, of the text frame.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

hasText

テキスト フレームにテキストが含まれるかどうかを指定します。Specifies whether the text frame contains text.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

horizontalAlignment

テキスト フレームの水平方向の配置を表します。Represents the horizontal alignment of the text frame. 詳細については、Excel.ShapeTextHorizontalAlignment を参照してください。See Excel.ShapeTextHorizontalAlignment for details.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

horizontalOverflow

テキスト フレームの水平方向のオーバーフローの動作を表します。Represents the horizontal overflow behavior of the text frame. 詳細については、Excel.ShapeTextHorizontalOverflow を参照してください。See Excel.ShapeTextHorizontalOverflow for details.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

leftMargin

テキスト フレームの左余白を表します (ポイント数)。Represents the left margin, in points, of the text frame.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

orientation

テキスト フレームのテキストの向きを表します。Represents the text orientation of the text frame. 詳細については、Excel.ShapeTextOrientation を参照してください。See Excel.ShapeTextOrientation for details.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readingOrder

テキスト フレームの読む方向を表します (左から右または右から左)。Represents the reading order of the text frame, either left-to-right or right-to-left. 詳細については、Excel.ShapeTextReadingOrder を参照してください。See Excel.ShapeTextReadingOrder for details.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

rightMargin

テキスト フレームの右余白を表します (ポイント数)。Represents the right margin, in points, of the text frame.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

textRange

テキスト フレーム内の図形にアタッチされているテキスト、およびテキストを操作するためのプロパティとメソッドを表します。Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text. 詳細については、Excel.TextRange を参照してください。See Excel.TextRange for details.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

topMargin

テキスト フレームの上余白を表します (ポイント数)。Represents the top margin, in points, of the text frame.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

verticalAlignment

テキスト フレームの垂直方向の配置を表します。Represents the vertical alignment of the text frame. 詳細については、Excel.ShapeTextVerticalAlignment を参照してください。See Excel.ShapeTextVerticalAlignment for details.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

verticalOverflow

テキスト フレームの垂直方向のオーバーフローの動作を表します。Represents the vertical overflow behavior of the text frame. 詳細については、Excel.ShapeTextVerticalOverflow を参照してください。See Excel.ShapeTextVerticalOverflow for details.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

メソッド

deleteText()

テキスト フレーム内のテキストをすべて削除します。Deletes all the text in the text frame.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel の TextFrame オブジェクトは API オブジェクトであるのにtoJSON対して、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.TextFrameData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.TextFrame object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.TextFrameData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

プロパティの詳細

autoSizeSetting

テキスト フレームの自動サイズ変更設定を取得または設定します。Gets or sets the automatic sizing settings for the text frame. テキストをテキスト フレームに自動的に合わせる、テキスト フレームをテキストに自動的に合わせる、自動サイズ変更を行わない、のいずれかにテキスト フレームを設定できます。A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

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

bottomMargin

テキスト フレームの下余白を表します (ポイント数)。Represents the bottom margin, in points, of the text frame.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

bottomMargin: number;

プロパティ値

number

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

hasText

テキスト フレームにテキストが含まれるかどうかを指定します。Specifies whether the text frame contains text.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly hasText: boolean;

プロパティ値

boolean

horizontalAlignment

テキスト フレームの水平方向の配置を表します。Represents the horizontal alignment of the text frame. 詳細については、Excel.ShapeTextHorizontalAlignment を参照してください。See Excel.ShapeTextHorizontalAlignment for details.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

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

horizontalOverflow

テキスト フレームの水平方向のオーバーフローの動作を表します。Represents the horizontal overflow behavior of the text frame. 詳細については、Excel.ShapeTextHorizontalOverflow を参照してください。See Excel.ShapeTextHorizontalOverflow for details.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip"

leftMargin

テキスト フレームの左余白を表します (ポイント数)。Represents the left margin, in points, of the text frame.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

leftMargin: number;

プロパティ値

number

orientation

テキスト フレームのテキストの向きを表します。Represents the text orientation of the text frame. 詳細については、Excel.ShapeTextOrientation を参照してください。See Excel.ShapeTextOrientation for details.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

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

readingOrder

テキスト フレームの読む方向を表します (左から右または右から左)。Represents the reading order of the text frame, either left-to-right or right-to-left. 詳細については、Excel.ShapeTextReadingOrder を参照してください。See Excel.ShapeTextReadingOrder for details.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft"

rightMargin

テキスト フレームの右余白を表します (ポイント数)。Represents the right margin, in points, of the text frame.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

rightMargin: number;

プロパティ値

number

textRange

テキスト フレーム内の図形にアタッチされているテキスト、およびテキストを操作するためのプロパティとメソッドを表します。Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text. 詳細については、Excel.TextRange を参照してください。See Excel.TextRange for details.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly textRange: Excel.TextRange;

プロパティ値

topMargin

テキスト フレームの上余白を表します (ポイント数)。Represents the top margin, in points, of the text frame.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

topMargin: number;

プロパティ値

number

verticalAlignment

テキスト フレームの垂直方向の配置を表します。Represents the vertical alignment of the text frame. 詳細については、Excel.ShapeTextVerticalAlignment を参照してください。See Excel.ShapeTextVerticalAlignment for details.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

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

verticalOverflow

テキスト フレームの垂直方向のオーバーフローの動作を表します。Represents the vertical overflow behavior of the text frame. 詳細については、Excel.ShapeTextVerticalOverflow を参照してください。See Excel.ShapeTextVerticalOverflow for details.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

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

メソッドの詳細

deleteText()

テキスト フレーム内のテキストをすべて削除します。Deletes all the text in the text frame.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

deleteText(): void;

戻り値

void

Examples

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(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

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

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.TextFrame-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.TextFrame - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.TextFrame-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.TextFrame - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TextFrame-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TextFrame - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

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

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

パラメーター

properties
Interfaces.TextFrameUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.TextFrame): void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.TextFrame): void;

パラメーター

properties
Excel.TextFrame

戻り値

void

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel の TextFrame オブジェクトは API オブジェクトであるのにtoJSON対して、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.TextFrameData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.TextFrame object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.TextFrameData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.TextFrameData;

戻り値