ExcelScript.TextFrame interface

Paket:

ExcelScript

Stellt den Textrahmen eines Formobjekts dar.

Hinweise

Beispiele

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

Methoden

deleteText()	Löscht den gesamten Text im Textrahmen.
getAutoSizeSetting()	Die Einstellungen für die automatische Größenanpassung für den Textrahmen. Für einen Textrahmen kann automatische Anpassung des Texts an den Textrahmen, automatische Anpassung des Textrahmens an den Text oder gar keine automatische Größenanpassung festgelegt werden.
getBottomMargin()	Stellt den unteren Rand des Textrahmens in Punkt dar.
getHasText()	Gibt an, ob der Textrahmen Text enthält.
getHorizontalAlignment()	Stellt die horizontale Ausrichtung des Textrahmens dar. Weitere Informationen finden Sie unter ExcelScript.ShapeTextHorizontalAlignment .
getHorizontalOverflow()	Stellt das horizontale Überlaufverhalten des Textrahmens dar. Weitere Informationen finden Sie unter ExcelScript.ShapeTextHorizontalOverflow .
getLeftMargin()	Stellt den linken Rand des Textrahmens in Punkt dar.
getOrientation()	Stellt den Winkel dar, an dem der Text für den Textrahmen ausgerichtet ist. Weitere Informationen finden Sie unter ExcelScript.ShapeTextOrientation .
getReadingOrder()	Stellt die Lesereihenfolge des Textrahmens dar, entweder von links nach rechts oder von rechts nach links. Weitere Informationen finden Sie unter ExcelScript.ShapeTextReadingOrder .
getRightMargin()	Stellt den rechten Rand des Textrahmens in Punkt dar.
getTextRange()	Stellt den Text dar, der an eine Form im Textrahmen angefügt ist, sowie Eigenschaften und Methoden für das Bearbeiten des Texts. Weitere Informationen finden Sie unter ExcelScript.TextRange .
getTopMargin()	Stellt den oberen Rand des Textrahmens in Punkt dar.
getVerticalAlignment()	Stellt die vertikale Ausrichtung des Textrahmens dar. Weitere Informationen finden Sie unter ExcelScript.ShapeTextVerticalAlignment .
getVerticalOverflow()	Stellt das vertikale Überlaufverhalten des Textrahmens dar. Weitere Informationen finden Sie unter ExcelScript.ShapeTextVerticalOverflow .
setAutoSizeSetting(autoSizeSetting)	Die Einstellungen für die automatische Größenanpassung für den Textrahmen. Für einen Textrahmen kann automatische Anpassung des Texts an den Textrahmen, automatische Anpassung des Textrahmens an den Text oder gar keine automatische Größenanpassung festgelegt werden.
setBottomMargin(bottomMargin)	Stellt den unteren Rand des Textrahmens in Punkt dar.
setHorizontalAlignment(horizontalAlignment)	Stellt die horizontale Ausrichtung des Textrahmens dar. Weitere Informationen finden Sie unter ExcelScript.ShapeTextHorizontalAlignment .
setHorizontalOverflow(horizontalOverflow)	Stellt das horizontale Überlaufverhalten des Textrahmens dar. Weitere Informationen finden Sie unter ExcelScript.ShapeTextHorizontalOverflow .
setLeftMargin(leftMargin)	Stellt den linken Rand des Textrahmens in Punkt dar.
setOrientation(orientation)	Stellt den Winkel dar, an dem der Text für den Textrahmen ausgerichtet ist. Weitere Informationen finden Sie unter ExcelScript.ShapeTextOrientation .
setReadingOrder(readingOrder)	Stellt die Lesereihenfolge des Textrahmens dar, entweder von links nach rechts oder von rechts nach links. Weitere Informationen finden Sie unter ExcelScript.ShapeTextReadingOrder .
setRightMargin(rightMargin)	Stellt den rechten Rand des Textrahmens in Punkt dar.
setTopMargin(topMargin)	Stellt den oberen Rand des Textrahmens in Punkt dar.
setVerticalAlignment(verticalAlignment)	Stellt die vertikale Ausrichtung des Textrahmens dar. Weitere Informationen finden Sie unter ExcelScript.ShapeTextVerticalAlignment .
setVerticalOverflow(verticalOverflow)	Stellt das vertikale Überlaufverhalten des Textrahmens dar. Weitere Informationen finden Sie unter ExcelScript.ShapeTextVerticalOverflow .

Details zur Methode

deleteText()

Löscht den gesamten Text im Textrahmen.

deleteText(): void;

Gibt zurück

void

getAutoSizeSetting()

Die Einstellungen für die automatische Größenanpassung für den Textrahmen. Für einen Textrahmen kann automatische Anpassung des Texts an den Textrahmen, automatische Anpassung des Textrahmens an den Text oder gar keine automatische Größenanpassung festgelegt werden.

getAutoSizeSetting(): ShapeAutoSize;

Gibt zurück

ExcelScript.ShapeAutoSize

getBottomMargin()

Stellt den unteren Rand des Textrahmens in Punkt dar.

getBottomMargin(): number;

Gibt zurück

number

getHasText()

Gibt an, ob der Textrahmen Text enthält.

getHasText(): boolean;

Gibt zurück

boolean

getHorizontalAlignment()

Stellt die horizontale Ausrichtung des Textrahmens dar. Weitere Informationen finden Sie unter ExcelScript.ShapeTextHorizontalAlignment .

getHorizontalAlignment(): ShapeTextHorizontalAlignment;

Gibt zurück

ExcelScript.ShapeTextHorizontalAlignment

getHorizontalOverflow()

Stellt das horizontale Überlaufverhalten des Textrahmens dar. Weitere Informationen finden Sie unter ExcelScript.ShapeTextHorizontalOverflow .

getHorizontalOverflow(): ShapeTextHorizontalOverflow;

Gibt zurück

ExcelScript.ShapeTextHorizontalOverflow

getLeftMargin()

Stellt den linken Rand des Textrahmens in Punkt dar.

getLeftMargin(): number;

Gibt zurück

number

getOrientation()

Stellt den Winkel dar, an dem der Text für den Textrahmen ausgerichtet ist. Weitere Informationen finden Sie unter ExcelScript.ShapeTextOrientation .

getOrientation(): ShapeTextOrientation;

Gibt zurück

ExcelScript.ShapeTextOrientation

getReadingOrder()

Stellt die Lesereihenfolge des Textrahmens dar, entweder von links nach rechts oder von rechts nach links. Weitere Informationen finden Sie unter ExcelScript.ShapeTextReadingOrder .

getReadingOrder(): ShapeTextReadingOrder;

Gibt zurück

ExcelScript.ShapeTextReadingOrder

getRightMargin()

Stellt den rechten Rand des Textrahmens in Punkt dar.

getRightMargin(): number;

Gibt zurück

number

getTextRange()

Stellt den Text dar, der an eine Form im Textrahmen angefügt ist, sowie Eigenschaften und Methoden für das Bearbeiten des Texts. Weitere Informationen finden Sie unter ExcelScript.TextRange .

getTextRange(): TextRange;

Gibt zurück

ExcelScript.TextRange

getTopMargin()

Stellt den oberen Rand des Textrahmens in Punkt dar.

getTopMargin(): number;

Gibt zurück

number

getVerticalAlignment()

Stellt die vertikale Ausrichtung des Textrahmens dar. Weitere Informationen finden Sie unter ExcelScript.ShapeTextVerticalAlignment .

getVerticalAlignment(): ShapeTextVerticalAlignment;

Gibt zurück

ExcelScript.ShapeTextVerticalAlignment

getVerticalOverflow()

Stellt das vertikale Überlaufverhalten des Textrahmens dar. Weitere Informationen finden Sie unter ExcelScript.ShapeTextVerticalOverflow .

getVerticalOverflow(): ShapeTextVerticalOverflow;

Gibt zurück

ExcelScript.ShapeTextVerticalOverflow

setAutoSizeSetting(autoSizeSetting)

Die Einstellungen für die automatische Größenanpassung für den Textrahmen. Für einen Textrahmen kann automatische Anpassung des Texts an den Textrahmen, automatische Anpassung des Textrahmens an den Text oder gar keine automatische Größenanpassung festgelegt werden.

setAutoSizeSetting(autoSizeSetting: ShapeAutoSize): void;

Parameter

autoSizeSetting

ExcelScript.ShapeAutoSize

Gibt zurück

void

setBottomMargin(bottomMargin)

Stellt den unteren Rand des Textrahmens in Punkt dar.

setBottomMargin(bottomMargin: number): void;

Parameter

bottomMargin

number

Gibt zurück

void

setHorizontalAlignment(horizontalAlignment)

Stellt die horizontale Ausrichtung des Textrahmens dar. Weitere Informationen finden Sie unter ExcelScript.ShapeTextHorizontalAlignment .

setHorizontalAlignment(
            horizontalAlignment: ShapeTextHorizontalAlignment
        ): void;

Parameter

horizontalAlignment

ExcelScript.ShapeTextHorizontalAlignment

Gibt zurück

void

setHorizontalOverflow(horizontalOverflow)

Stellt das horizontale Überlaufverhalten des Textrahmens dar. Weitere Informationen finden Sie unter ExcelScript.ShapeTextHorizontalOverflow .

setHorizontalOverflow(
            horizontalOverflow: ShapeTextHorizontalOverflow
        ): void;

Parameter

horizontalOverflow

ExcelScript.ShapeTextHorizontalOverflow

Gibt zurück

void

setLeftMargin(leftMargin)

Stellt den linken Rand des Textrahmens in Punkt dar.

setLeftMargin(leftMargin: number): void;

Parameter

leftMargin

number

Gibt zurück

void

setOrientation(orientation)

Stellt den Winkel dar, an dem der Text für den Textrahmen ausgerichtet ist. Weitere Informationen finden Sie unter ExcelScript.ShapeTextOrientation .

setOrientation(orientation: ShapeTextOrientation): void;

Parameter

orientation

ExcelScript.ShapeTextOrientation

Gibt zurück

void

setReadingOrder(readingOrder)

Stellt die Lesereihenfolge des Textrahmens dar, entweder von links nach rechts oder von rechts nach links. Weitere Informationen finden Sie unter ExcelScript.ShapeTextReadingOrder .

setReadingOrder(readingOrder: ShapeTextReadingOrder): void;

Parameter

readingOrder

ExcelScript.ShapeTextReadingOrder

Gibt zurück

void

setRightMargin(rightMargin)

Stellt den rechten Rand des Textrahmens in Punkt dar.

setRightMargin(rightMargin: number): void;

Parameter

rightMargin

number

Gibt zurück

void

setTopMargin(topMargin)

Stellt den oberen Rand des Textrahmens in Punkt dar.

setTopMargin(topMargin: number): void;

Parameter

topMargin

number

Gibt zurück

void

setVerticalAlignment(verticalAlignment)

Stellt die vertikale Ausrichtung des Textrahmens dar. Weitere Informationen finden Sie unter ExcelScript.ShapeTextVerticalAlignment .

setVerticalAlignment(
            verticalAlignment: ShapeTextVerticalAlignment
        ): void;

Parameter

verticalAlignment

ExcelScript.ShapeTextVerticalAlignment

Gibt zurück

void

setVerticalOverflow(verticalOverflow)

Stellt das vertikale Überlaufverhalten des Textrahmens dar. Weitere Informationen finden Sie unter ExcelScript.ShapeTextVerticalOverflow .

setVerticalOverflow(verticalOverflow: ShapeTextVerticalOverflow): void;

Parameter

verticalOverflow

ExcelScript.ShapeTextVerticalOverflow

Gibt zurück

void