ExcelScript.TextFrame interface

Пакет:

ExcelScript

Представляет текстовый кадр объекта фигуры.

Комментарии

Примеры

/**
 * 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);
}

Методы

deleteText()	Удаляет весь текст в рамке с текстом.
getAutoSizeSetting()	Параметры автоматического изменения размера текстового фрейма. Для рамки с текстом можно настроить автоматический подбор размера текста в соответствии с размером рамки, автоматический подбор размера рамки в соответствии с содержимым или не выполнять автоматический подбор размера.
getBottomMargin()	Представляет нижнее поле рамки с текстом (в пунктах).
getHasText()	Указывает, содержит ли текстовый фрейм текст.
getHorizontalAlignment()	Представляет горизонтальное выравнивание рамки с текстом. Дополнительные сведения см. в этой ExcelScript.ShapeTextHorizontalAlignment статье.
getHorizontalOverflow()	Представляет действие горизонтального переполнения рамки с текстом. Дополнительные сведения см. в этой ExcelScript.ShapeTextHorizontalOverflow статье.
getLeftMargin()	Представляет левое поле рамки с текстом (в пунктах).
getOrientation()	Представляет угол, на который ориентирован текст для текстового фрейма. Дополнительные сведения см. в этой ExcelScript.ShapeTextOrientation статье.
getReadingOrder()	Представляет направление чтения рамки с текстом (слева направо или справа налево). Дополнительные сведения см. в этой ExcelScript.ShapeTextReadingOrder статье.
getRightMargin()	Представляет правое поле рамки с текстом (в пунктах).
getTextRange()	Представляет текст, присоединенный к фигуре в текстовой рамке, а также свойства и методы для операций с текстом. Дополнительные сведения см. в этой ExcelScript.TextRange статье.
getTopMargin()	Представляет верхнее поле рамки с текстом (в пунктах).
getVerticalAlignment()	Представляет вертикальное выравнивание для рамки с текстом. Дополнительные сведения см. в этой ExcelScript.ShapeTextVerticalAlignment статье.
getVerticalOverflow()	Представляет действие вертикального переполнения рамки с текстом. Дополнительные сведения см. в этой ExcelScript.ShapeTextVerticalOverflow статье.
setAutoSizeSetting(autoSizeSetting)	Параметры автоматического изменения размера текстового фрейма. Для рамки с текстом можно настроить автоматический подбор размера текста в соответствии с размером рамки, автоматический подбор размера рамки в соответствии с содержимым или не выполнять автоматический подбор размера.
setBottomMargin(bottomMargin)	Представляет нижнее поле рамки с текстом (в пунктах).
setHorizontalAlignment(horizontalAlignment)	Представляет горизонтальное выравнивание рамки с текстом. Дополнительные сведения см. в этой ExcelScript.ShapeTextHorizontalAlignment статье.
setHorizontalOverflow(horizontalOverflow)	Представляет действие горизонтального переполнения рамки с текстом. Дополнительные сведения см. в этой ExcelScript.ShapeTextHorizontalOverflow статье.
setLeftMargin(leftMargin)	Представляет левое поле рамки с текстом (в пунктах).
setOrientation(orientation)	Представляет угол, на который ориентирован текст для текстового фрейма. Дополнительные сведения см. в этой ExcelScript.ShapeTextOrientation статье.
setReadingOrder(readingOrder)	Представляет направление чтения рамки с текстом (слева направо или справа налево). Дополнительные сведения см. в этой ExcelScript.ShapeTextReadingOrder статье.
setRightMargin(rightMargin)	Представляет правое поле рамки с текстом (в пунктах).
setTopMargin(topMargin)	Представляет верхнее поле рамки с текстом (в пунктах).
setVerticalAlignment(verticalAlignment)	Представляет вертикальное выравнивание для рамки с текстом. Дополнительные сведения см. в этой ExcelScript.ShapeTextVerticalAlignment статье.
setVerticalOverflow(verticalOverflow)	Представляет действие вертикального переполнения рамки с текстом. Дополнительные сведения см. в этой ExcelScript.ShapeTextVerticalOverflow статье.

Сведения о методе

deleteText()

Удаляет весь текст в рамке с текстом.

deleteText(): void;

Возвращаемое значение

void

getAutoSizeSetting()

Параметры автоматического изменения размера текстового фрейма. Для рамки с текстом можно настроить автоматический подбор размера текста в соответствии с размером рамки, автоматический подбор размера рамки в соответствии с содержимым или не выполнять автоматический подбор размера.

getAutoSizeSetting(): ShapeAutoSize;

Возвращаемое значение

ExcelScript.ShapeAutoSize

getBottomMargin()

Представляет нижнее поле рамки с текстом (в пунктах).

getBottomMargin(): number;

Возвращаемое значение

number

getHasText()

Указывает, содержит ли текстовый фрейм текст.

getHasText(): boolean;

Возвращаемое значение

boolean

getHorizontalAlignment()

Представляет горизонтальное выравнивание рамки с текстом. Дополнительные сведения см. в этой ExcelScript.ShapeTextHorizontalAlignment статье.

getHorizontalAlignment(): ShapeTextHorizontalAlignment;

Возвращаемое значение

ExcelScript.ShapeTextHorizontalAlignment

getHorizontalOverflow()

Представляет действие горизонтального переполнения рамки с текстом. Дополнительные сведения см. в этой ExcelScript.ShapeTextHorizontalOverflow статье.

getHorizontalOverflow(): ShapeTextHorizontalOverflow;

Возвращаемое значение

ExcelScript.ShapeTextHorizontalOverflow

getLeftMargin()

Представляет левое поле рамки с текстом (в пунктах).

getLeftMargin(): number;

Возвращаемое значение

number

getOrientation()

Представляет угол, на который ориентирован текст для текстового фрейма. Дополнительные сведения см. в этой ExcelScript.ShapeTextOrientation статье.

getOrientation(): ShapeTextOrientation;

Возвращаемое значение

ExcelScript.ShapeTextOrientation

getReadingOrder()

Представляет направление чтения рамки с текстом (слева направо или справа налево). Дополнительные сведения см. в этой ExcelScript.ShapeTextReadingOrder статье.

getReadingOrder(): ShapeTextReadingOrder;

Возвращаемое значение

ExcelScript.ShapeTextReadingOrder

getRightMargin()

Представляет правое поле рамки с текстом (в пунктах).

getRightMargin(): number;

Возвращаемое значение

number

getTextRange()

Представляет текст, присоединенный к фигуре в текстовой рамке, а также свойства и методы для операций с текстом. Дополнительные сведения см. в этой ExcelScript.TextRange статье.

getTextRange(): TextRange;

Возвращаемое значение

ExcelScript.TextRange

getTopMargin()

Представляет верхнее поле рамки с текстом (в пунктах).

getTopMargin(): number;

Возвращаемое значение

number

getVerticalAlignment()

Представляет вертикальное выравнивание для рамки с текстом. Дополнительные сведения см. в этой ExcelScript.ShapeTextVerticalAlignment статье.

getVerticalAlignment(): ShapeTextVerticalAlignment;

Возвращаемое значение

ExcelScript.ShapeTextVerticalAlignment

getVerticalOverflow()

Представляет действие вертикального переполнения рамки с текстом. Дополнительные сведения см. в этой ExcelScript.ShapeTextVerticalOverflow статье.

getVerticalOverflow(): ShapeTextVerticalOverflow;

Возвращаемое значение

ExcelScript.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