ExcelScript.TextFrame interface
図形オブジェクトのテキスト フレームを表します。
注釈
例
/**
* This script creates a star shape with the value from cell A1.
*/
function main(workbook: ExcelScript.Workbook) {
// Get the value of A1 from the worksheet named Sheet1.
const sheet = workbook.getWorksheet("Sheet1");
const value = sheet.getRange("A1").getValue();
// Create a Shape object that looks like a 5-pointed star.
const star = sheet.addGeometricShape(ExcelScript.GeometricShapeType.star5);
// Set the text of star and make sure the shape fits the text.
const textFrame: ExcelScript.TextFrame = star.getTextFrame();
textFrame.getTextRange().setText(value.toString());
textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFitText);
}
メソッド
| delete |
テキスト フレーム内のテキストをすべて削除します。 |
| get |
テキスト フレームの自動サイズ設定。 テキストをテキスト フレームに自動的に合わせる、テキスト フレームをテキストに自動的に合わせる、自動サイズ変更を行わない、のいずれかにテキスト フレームを設定できます。 |
| get |
テキスト フレームの下余白を表します (ポイント数)。 |
| get |
テキスト フレームにテキストが含まれているかどうかを指定します。 |
| get |
テキスト フレームの水平方向の配置を表します。 詳細は「 |
| get |
テキスト フレームの水平方向のオーバーフローの動作を表します。 詳細は「 |
| get |
テキスト フレームの左余白を表します (ポイント数)。 |
| get |
テキスト フレームのテキストの向きを示す角度を表します。 詳細は「 |
| get |
テキスト フレームの読む方向を表します (左から右または右から左)。 詳細は「 |
| get |
テキスト フレームの右余白を表します (ポイント数)。 |
| get |
テキスト フレーム内の図形にアタッチされているテキスト、およびテキストを操作するためのプロパティとメソッドを表します。 詳細は「 |
| get |
テキスト フレームの上余白を表します (ポイント数)。 |
| get |
テキスト フレームの垂直方向の配置を表します。 詳細は「 |
| get |
テキスト フレームの垂直方向のオーバーフローの動作を表します。 詳細は「 |
| set |
テキスト フレームの自動サイズ設定。 テキストをテキスト フレームに自動的に合わせる、テキスト フレームをテキストに自動的に合わせる、自動サイズ変更を行わない、のいずれかにテキスト フレームを設定できます。 |
| set |
テキスト フレームの下余白を表します (ポイント数)。 |
| set |
テキスト フレームの水平方向の配置を表します。 詳細は「 |
| set |
テキスト フレームの水平方向のオーバーフローの動作を表します。 詳細は「 |
| set |
テキスト フレームの左余白を表します (ポイント数)。 |
| set |
テキスト フレームのテキストの向きを示す角度を表します。 詳細は「 |
| set |
テキスト フレームの読む方向を表します (左から右または右から左)。 詳細は「 |
| set |
テキスト フレームの右余白を表します (ポイント数)。 |
| set |
テキスト フレームの上余白を表します (ポイント数)。 |
| set |
テキスト フレームの垂直方向の配置を表します。 詳細は「 |
| set |
テキスト フレームの垂直方向のオーバーフローの動作を表します。 詳細は「 |
メソッドの詳細
deleteText()
テキスト フレーム内のテキストをすべて削除します。
deleteText(): void;戻り値
void
getAutoSizeSetting()
テキスト フレームの自動サイズ設定。 テキストをテキスト フレームに自動的に合わせる、テキスト フレームをテキストに自動的に合わせる、自動サイズ変更を行わない、のいずれかにテキスト フレームを設定できます。
getAutoSizeSetting(): ShapeAutoSize;戻り値
getBottomMargin()
テキスト フレームの下余白を表します (ポイント数)。
getBottomMargin(): number;戻り値
number
getHasText()
テキスト フレームにテキストが含まれているかどうかを指定します。
getHasText(): boolean;戻り値
boolean
getHorizontalAlignment()
テキスト フレームの水平方向の配置を表します。 詳細は「ExcelScript.ShapeTextHorizontalAlignment」をご覧ください。
getHorizontalAlignment(): ShapeTextHorizontalAlignment;戻り値
getHorizontalOverflow()
テキスト フレームの水平方向のオーバーフローの動作を表します。 詳細は「ExcelScript.ShapeTextHorizontalOverflow」をご覧ください。
getHorizontalOverflow(): ShapeTextHorizontalOverflow;戻り値
getLeftMargin()
テキスト フレームの左余白を表します (ポイント数)。
getLeftMargin(): number;戻り値
number
getOrientation()
テキスト フレームのテキストの向きを示す角度を表します。 詳細は「ExcelScript.ShapeTextOrientation」をご覧ください。
getOrientation(): ShapeTextOrientation;戻り値
getReadingOrder()
テキスト フレームの読む方向を表します (左から右または右から左)。 詳細は「ExcelScript.ShapeTextReadingOrder」をご覧ください。
getReadingOrder(): ShapeTextReadingOrder;戻り値
getRightMargin()
テキスト フレームの右余白を表します (ポイント数)。
getRightMargin(): number;戻り値
number
getTextRange()
テキスト フレーム内の図形にアタッチされているテキスト、およびテキストを操作するためのプロパティとメソッドを表します。 詳細は「ExcelScript.TextRange」をご覧ください。
getTextRange(): TextRange;戻り値
getTopMargin()
テキスト フレームの上余白を表します (ポイント数)。
getTopMargin(): number;戻り値
number
getVerticalAlignment()
テキスト フレームの垂直方向の配置を表します。 詳細は「ExcelScript.ShapeTextVerticalAlignment」をご覧ください。
getVerticalAlignment(): ShapeTextVerticalAlignment;戻り値
getVerticalOverflow()
テキスト フレームの垂直方向のオーバーフローの動作を表します。 詳細は「ExcelScript.ShapeTextVerticalOverflow」をご覧ください。
getVerticalOverflow(): ShapeTextVerticalOverflow;戻り値
setAutoSizeSetting(autoSizeSetting)
テキスト フレームの自動サイズ設定。 テキストをテキスト フレームに自動的に合わせる、テキスト フレームをテキストに自動的に合わせる、自動サイズ変更を行わない、のいずれかにテキスト フレームを設定できます。
setAutoSizeSetting(autoSizeSetting: ShapeAutoSize): void;パラメーター
- autoSizeSetting
- ExcelScript.ShapeAutoSize
戻り値
void
setBottomMargin(bottomMargin)
テキスト フレームの下余白を表します (ポイント数)。
setBottomMargin(bottomMargin: number): void;パラメーター
- bottomMargin
-
number
戻り値
void
setHorizontalAlignment(horizontalAlignment)
テキスト フレームの水平方向の配置を表します。 詳細は「ExcelScript.ShapeTextHorizontalAlignment」をご覧ください。
setHorizontalAlignment(
horizontalAlignment: ShapeTextHorizontalAlignment
): void;パラメーター
- horizontalAlignment
- ExcelScript.ShapeTextHorizontalAlignment
戻り値
void
setHorizontalOverflow(horizontalOverflow)
テキスト フレームの水平方向のオーバーフローの動作を表します。 詳細は「ExcelScript.ShapeTextHorizontalOverflow」をご覧ください。
setHorizontalOverflow(
horizontalOverflow: ShapeTextHorizontalOverflow
): void;パラメーター
- horizontalOverflow
- ExcelScript.ShapeTextHorizontalOverflow
戻り値
void
setLeftMargin(leftMargin)
テキスト フレームの左余白を表します (ポイント数)。
setLeftMargin(leftMargin: number): void;パラメーター
- leftMargin
-
number
戻り値
void
setOrientation(orientation)
テキスト フレームのテキストの向きを示す角度を表します。 詳細は「ExcelScript.ShapeTextOrientation」をご覧ください。
setOrientation(orientation: ShapeTextOrientation): void;パラメーター
- orientation
- ExcelScript.ShapeTextOrientation
戻り値
void
setReadingOrder(readingOrder)
テキスト フレームの読む方向を表します (左から右または右から左)。 詳細は「ExcelScript.ShapeTextReadingOrder」をご覧ください。
setReadingOrder(readingOrder: ShapeTextReadingOrder): void;パラメーター
- readingOrder
- ExcelScript.ShapeTextReadingOrder
戻り値
void
setRightMargin(rightMargin)
テキスト フレームの右余白を表します (ポイント数)。
setRightMargin(rightMargin: number): void;パラメーター
- rightMargin
-
number
戻り値
void
setTopMargin(topMargin)
テキスト フレームの上余白を表します (ポイント数)。
setTopMargin(topMargin: number): void;パラメーター
- topMargin
-
number
戻り値
void
setVerticalAlignment(verticalAlignment)
テキスト フレームの垂直方向の配置を表します。 詳細は「ExcelScript.ShapeTextVerticalAlignment」をご覧ください。
setVerticalAlignment(
verticalAlignment: ShapeTextVerticalAlignment
): void;パラメーター
- verticalAlignment
- ExcelScript.ShapeTextVerticalAlignment
戻り値
void
setVerticalOverflow(verticalOverflow)
テキスト フレームの垂直方向のオーバーフローの動作を表します。 詳細は「ExcelScript.ShapeTextVerticalOverflow」をご覧ください。
setVerticalOverflow(verticalOverflow: ShapeTextVerticalOverflow): void;パラメーター
- verticalOverflow
- ExcelScript.ShapeTextVerticalOverflow
戻り値
void
Office Scripts