ExcelScript.Shape interface

Referenz

Paket:: ExcelScript

Stellt ein generisches Formobjekt im Arbeitsblatt dar. Eine Form kann eine geometrische Form, eine Linie, eine Gruppe von Formen usw. sein.

Hinweise

Beispiele

/**
 * This script creates a hexagon shape on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const hexagon: ExcelScript.Shape = 
    currentSheet.addGeometricShape(ExcelScript.GeometricShapeType.hexagon);
  
  // Set the hexagon size to 40x40 pixels.
  hexagon.setHeight(40);
  hexagon.setWidth(40);

  // Position the hexagon at [100,100] pixels.
  hexagon.setLeft(100);
  hexagon.setTop(100);
}

Methoden

copyTo(destinationSheet)	Kopiert ein Objekt und fügt es ein `Shape` . Die eingefügte Form wird an die gleiche Pixelposition wie dieses Shape kopiert.
delete()	Entfernt die Form aus dem Arbeitsblatt.
getAltTextDescription()	Gibt den alternativen Beschreibungstext für ein `Shape` -Objekt an.
getAltTextTitle()	Gibt den alternativen Titeltext für ein `Shape` -Objekt an.
getAsImage(format)	Konvertiert die Form in ein Bild und gibt das Bild als base64-codierte Zeichenfolge zurück. Der DPI-Wert ist 96. Die einzigen unterstützten Formate sind `ExcelScript.PictureFormat.BMP`, `ExcelScript.PictureFormat.PNG`, `ExcelScript.PictureFormat.JPEG`und `ExcelScript.PictureFormat.GIF`.
getConnectionSiteCount()	Gibt die Anzahl der Verbindungsseiten für diese Form zurück.
getFill()	Gibt die Füllungsformatierung dieser Form zurück.
getGeometricShape()	Gibt die der Form zugeordnete geometrische Form zurück. Es wird ein Fehler ausgelöst, wenn der Formtyp nicht "GeometricShape" ist.
getGeometricShapeType()	Gibt den geometrischen Formtyp dieser geometrischen Form an. Weitere Informationen finden Sie unter `ExcelScript.GeometricShapeType` . Gibt zurück `null` , wenn der Formtyp nicht "GeometricShape" ist.
getGroup()	Gibt die der Form zugeordnete Formgruppe zurück. Es wird ein Fehler ausgelöst, wenn der Formtyp nicht "GroupShape" ist.
getHeight()	Gibt die Höhe der Form in Punkt an. Löst eine Ausnahme aus `InvalidArgument` , wenn als Eingabe mit einem negativen Wert oder 0 (null) festgelegt wird.
getId()	Gibt den Shape-Bezeichner an.
getImage()	Gibt das Bild zurück, das der Form zugeordnet ist. Es wird ein Fehler ausgelöst, wenn der Formtyp nicht "Image" ist.
getImageAsBase64(format)	Konvertiert die Form in ein Bild und gibt das Bild als base64-codierte Zeichenfolge zurück. Der DPI-Wert ist 96. Die einzigen unterstützten Formate sind `ExcelScript.PictureFormat.BMP`, `ExcelScript.PictureFormat.PNG`, `ExcelScript.PictureFormat.JPEG`und `ExcelScript.PictureFormat.GIF`.
getLeft()	Der Abstand in Punkten von der linken Seite der Form zur linken Seite des Arbeitsblatts. Löst eine `InvalidArgument` Ausnahme aus, wenn mit einem negativen Wert als Eingabe festgelegt wird.
getLevel()	Gibt die Ebene der angegebenen Form an. Beispielsweise bedeutet die Ebene 0, dass die Form nicht Teil von Gruppen ist, die Ebene 1 bedeutet, die Form ist Teil einer Gruppe der obersten Ebene, und die Ebene 2 bedeutet, dass die Form Teil einer Untergruppe der obersten Ebene ist.
getLine()	Gibt die Linie zurück, die der Form zugeordnet ist. Es wird ein Fehler ausgelöst, wenn der Formtyp nicht "Line" ist.
getLineFormat()	Gibt die Linienformatierung dieser Form zurück.
getLockAspectRatio()	Gibt an, ob das Seitenverhältnis dieser Form gesperrt ist.
getName()	Gibt den Namen der Form an.
getParentGroup()	Gibt die übergeordnete Gruppe dieser Form an.
getPlacement()	Stellt dar, wie das Objekt an die Zellen darunter angefügt ist.
getRotation()	Gibt die Drehung der Form in Grad an.
getTextFrame()	Gibt das textFrame-Objekt dieser Form zurück.
getTop()	Der Abstand in Punkten zwischen der oberen Kante der Form und der oberen Kante der Arbeitsmappe. Löst eine `InvalidArgument` Ausnahme aus, wenn mit einem negativen Wert als Eingabe festgelegt wird.
getType()	Gibt den Typ dieser Form zurück. Weitere Informationen finden Sie unter `ExcelScript.ShapeType` .
getVisible()	Gibt an, ob die Form sichtbar ist.
getWidth()	Gibt die Breite der Form in Punkt an. Löst eine Ausnahme aus `InvalidArgument` , wenn als Eingabe mit einem negativen Wert oder 0 (null) festgelegt wird.
getZOrderPosition()	Gibt die Position der angegebenen Form in der Z-Reihenfolge an, wobei 0 den Boden des Reihenfolgestapels darstellt.
incrementLeft(increment)	Verschiebt die Form horizontal um die angegebene Punktanzahl.
incrementRotation(increment)	Dreht die Form um die angegebene Gradzahl um die Z-Achse. Verwenden Sie die `rotation` -Eigenschaft, um die absolute Drehung der Form festzulegen.
incrementTop(increment)	Verschiebt die Form vertikal um die angegebene Anzahl von Punkten.
scaleHeight(scaleFactor, scaleType, scaleFrom)	Skaliert die Höhe der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Höhe skaliert.
scaleWidth(scaleFactor, scaleType, scaleFrom)	Skaliert die Breite der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Breite skaliert.
setAltTextDescription(altTextDescription)	Gibt den alternativen Beschreibungstext für ein `Shape` -Objekt an.
setAltTextTitle(altTextTitle)	Gibt den alternativen Titeltext für ein `Shape` -Objekt an.
setGeometricShapeType(geometricShapeType)	Gibt den geometrischen Formtyp dieser geometrischen Form an. Weitere Informationen finden Sie unter `ExcelScript.GeometricShapeType` . Gibt zurück `null` , wenn der Formtyp nicht "GeometricShape" ist.
setHeight(height)	Gibt die Höhe der Form in Punkt an. Löst eine Ausnahme aus `InvalidArgument` , wenn als Eingabe mit einem negativen Wert oder 0 (null) festgelegt wird.
setLeft(left)	Der Abstand in Punkten von der linken Seite der Form zur linken Seite des Arbeitsblatts. Löst eine `InvalidArgument` Ausnahme aus, wenn mit einem negativen Wert als Eingabe festgelegt wird.
setLockAspectRatio(lockAspectRatio)	Gibt an, ob das Seitenverhältnis dieser Form gesperrt ist.
setName(name)	Gibt den Namen der Form an.
setPlacement(placement)	Stellt dar, wie das Objekt an die Zellen darunter angefügt ist.
setRotation(rotation)	Gibt die Drehung der Form in Grad an.
setTop(top)	Der Abstand in Punkten zwischen der oberen Kante der Form und der oberen Kante der Arbeitsmappe. Löst eine `InvalidArgument` Ausnahme aus, wenn mit einem negativen Wert als Eingabe festgelegt wird.
setVisible(visible)	Gibt an, ob die Form sichtbar ist.
setWidth(width)	Gibt die Breite der Form in Punkt an. Löst eine Ausnahme aus `InvalidArgument` , wenn als Eingabe mit einem negativen Wert oder 0 (null) festgelegt wird.
setZOrder(position)	Verschiebt de angegebene Form in der Z-Reihenfolge der Sammlung nach oben oder unten, wodurch sie vor oder hinter anderen Formen zu liegen kommt.

Details zur Methode

copyTo(destinationSheet)

Kopiert ein Objekt und fügt es ein Shape . Die eingefügte Form wird an die gleiche Pixelposition wie dieses Shape kopiert.

copyTo(destinationSheet?: Worksheet | string): Shape;

Parameter

destinationSheet: ExcelScript.Worksheet | string

Das Blatt, in das das Shape-Objekt eingefügt wird. Der Standardwert ist das Arbeitsblatt der kopierten Form.

Gibt zurück

ExcelScript.Shape

delete()

Entfernt die Form aus dem Arbeitsblatt.

delete(): void;

Gibt zurück

void

Beispiele

/**
 * This script deletes all the shapes on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the collection of shapes on the currently selected worksheet.
  const shapes = workbook.getActiveWorksheet().getShapes();

  // Remove each shape.
  shapes.forEach(shape =>{
    shape.delete();
  });
}

getAltTextDescription()

Gibt den alternativen Beschreibungstext für ein Shape -Objekt an.

getAltTextDescription(): string;

Gibt zurück

string

getAltTextTitle()

Gibt den alternativen Titeltext für ein Shape -Objekt an.

getAltTextTitle(): string;

Gibt zurück

string

getAsImage(format)

Warnung

Diese API ist nun veraltet.

Use getImageAsBase64 instead.

Konvertiert die Form in ein Bild und gibt das Bild als base64-codierte Zeichenfolge zurück. Der DPI-Wert ist 96. Die einzigen unterstützten Formate sind ExcelScript.PictureFormat.BMP, ExcelScript.PictureFormat.PNG, ExcelScript.PictureFormat.JPEGund ExcelScript.PictureFormat.GIF.

getAsImage(format: PictureFormat): string;

Parameter

format: ExcelScript.PictureFormat

Gibt das Format des Bilds an.

Gibt zurück

string

Beispiele

/**
 * This script creates a star shape with the value from cell A1.
 * It then returns the image as a base64-encoded string. 
 * This string would be used as part of a Power Automate flow to add the image elsewhere.
 */
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 = star.getTextFrame();
  textFrame.getTextRange().setText(value.toString());
  textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFitText);

  // Return the shape as a PNG image represented by a base64-encoded string.
  return star.getAsImage(ExcelScript.PictureFormat.png);
}

getConnectionSiteCount()

Gibt die Anzahl der Verbindungsseiten für diese Form zurück.

getConnectionSiteCount(): number;

Gibt zurück

number

getFill()

Gibt die Füllungsformatierung dieser Form zurück.

getFill(): ShapeFill;

Gibt zurück

ExcelScript.ShapeFill

getGeometricShape()

Gibt die der Form zugeordnete geometrische Form zurück. Es wird ein Fehler ausgelöst, wenn der Formtyp nicht "GeometricShape" ist.

getGeometricShape(): GeometricShape;

Gibt zurück

ExcelScript.GeometricShape

getGeometricShapeType()

Gibt den geometrischen Formtyp dieser geometrischen Form an. Weitere Informationen finden Sie unter ExcelScript.GeometricShapeType . Gibt zurück null , wenn der Formtyp nicht "GeometricShape" ist.

getGeometricShapeType(): GeometricShapeType;

Gibt zurück

ExcelScript.GeometricShapeType

getGroup()

Gibt die der Form zugeordnete Formgruppe zurück. Es wird ein Fehler ausgelöst, wenn der Formtyp nicht "GroupShape" ist.

getGroup(): ShapeGroup;

Gibt zurück

ExcelScript.ShapeGroup

getHeight()

Gibt die Höhe der Form in Punkt an. Löst eine Ausnahme aus InvalidArgument , wenn als Eingabe mit einem negativen Wert oder 0 (null) festgelegt wird.

getHeight(): number;

Gibt zurück

number

getId()

Gibt den Shape-Bezeichner an.

getId(): string;

Gibt zurück

string

getImage()

Gibt das Bild zurück, das der Form zugeordnet ist. Es wird ein Fehler ausgelöst, wenn der Formtyp nicht "Image" ist.

getImage(): Image;

Gibt zurück

ExcelScript.Image

Beispiele

/**
 * This script transfers an image from one worksheet to another.
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the worksheet with the image on it.
  let firstWorksheet = workbook.getWorksheet("FirstSheet");

  // Get the first image from the worksheet.
  // If a script added the image, you could add a name to make it easier to find.
  let image: ExcelScript.Image;
  firstWorksheet.getShapes().forEach((shape, index) => {
    if (shape.getType() === ExcelScript.ShapeType.image) {
      image = shape.getImage();
      return;
    }
  });

  // Copy the image to another worksheet.
  image.getShape().copyTo("SecondSheet");
}

getImageAsBase64(format)

getImageAsBase64(format: PictureFormat): string;

Parameter

format: ExcelScript.PictureFormat

Gibt das Format des Bilds an.

Gibt zurück

string

getLeft()

Der Abstand in Punkten von der linken Seite der Form zur linken Seite des Arbeitsblatts. Löst eine InvalidArgument Ausnahme aus, wenn mit einem negativen Wert als Eingabe festgelegt wird.

getLeft(): number;

Gibt zurück

number

getLevel()

Gibt die Ebene der angegebenen Form an. Beispielsweise bedeutet die Ebene 0, dass die Form nicht Teil von Gruppen ist, die Ebene 1 bedeutet, die Form ist Teil einer Gruppe der obersten Ebene, und die Ebene 2 bedeutet, dass die Form Teil einer Untergruppe der obersten Ebene ist.

getLevel(): number;

Gibt zurück

number

getLine()

Gibt die Linie zurück, die der Form zugeordnet ist. Es wird ein Fehler ausgelöst, wenn der Formtyp nicht "Line" ist.

getLine(): Line;

Gibt zurück

ExcelScript.Line

Beispiele

/**
 * This script adds a line that goes from cell B2 to cell F4 on the current worksheet.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  const sheet = workbook.getActiveWorksheet();

  // Get the ranges for the two cells.
  const b2Range = sheet.getRange("B2");
  const f4Range = sheet.getRange("F4");

  // Add a straight line that connects the top-left corners of both cells.
  const newShape = sheet.addLine(
    b2Range.getLeft(),
    b2Range.getTop(),
    f4Range.getLeft(),
    f4Range.getTop(),
    ExcelScript.ConnectorType.straight);

  // Add an open arrowhead to the end of the line, such that it points at F4.
  const line = newShape.getLine();
  line.setEndArrowheadStyle(ExcelScript.ArrowheadStyle.open);
}

getLineFormat()

Gibt die Linienformatierung dieser Form zurück.

getLineFormat(): ShapeLineFormat;

Gibt zurück

ExcelScript.ShapeLineFormat

getLockAspectRatio()

Gibt an, ob das Seitenverhältnis dieser Form gesperrt ist.

getLockAspectRatio(): boolean;

Gibt zurück

boolean

getName()

Gibt den Namen der Form an.

getName(): string;

Gibt zurück

string

getParentGroup()

Gibt die übergeordnete Gruppe dieser Form an.

getParentGroup(): Shape;

Gibt zurück

ExcelScript.Shape

getPlacement()

Stellt dar, wie das Objekt an die Zellen darunter angefügt ist.

getPlacement(): Placement;

Gibt zurück

ExcelScript.Placement

getRotation()

Gibt die Drehung der Form in Grad an.

getRotation(): number;

Gibt zurück

number

getTextFrame()

Gibt das textFrame-Objekt dieser Form zurück.

getTextFrame(): TextFrame;

Gibt zurück

ExcelScript.TextFrame

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 = star.getTextFrame();
  textFrame.getTextRange().setText(value.toString());
  textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFitText);
}

getTop()

Der Abstand in Punkten zwischen der oberen Kante der Form und der oberen Kante der Arbeitsmappe. Löst eine InvalidArgument Ausnahme aus, wenn mit einem negativen Wert als Eingabe festgelegt wird.

getTop(): number;

Gibt zurück

number

getType()

Gibt den Typ dieser Form zurück. Weitere Informationen finden Sie unter ExcelScript.ShapeType .

getType(): ShapeType;

Gibt zurück

ExcelScript.ShapeType

getVisible()

Gibt an, ob die Form sichtbar ist.

getVisible(): boolean;

Gibt zurück

boolean

getWidth()

Gibt die Breite der Form in Punkt an. Löst eine Ausnahme aus InvalidArgument , wenn als Eingabe mit einem negativen Wert oder 0 (null) festgelegt wird.

getWidth(): number;

Gibt zurück

number

getZOrderPosition()

Gibt die Position der angegebenen Form in der Z-Reihenfolge an, wobei 0 den Boden des Reihenfolgestapels darstellt.

getZOrderPosition(): number;

Gibt zurück

number

incrementLeft(increment)

Verschiebt die Form horizontal um die angegebene Punktanzahl.

incrementLeft(increment: number): void;

Parameter

increment: number

Das Inkrement in Punkt wird die Form horizontal verschoben. Ein positiver Wert verschiebt die Form nach rechts und ein negativer Wert nach links. Wenn das Blatt von rechts nach links ausgerichtet ist, wird dies umgekehrt: Positive Werte verschieben die Form nach links und negative Werte nach rechts.

Gibt zurück

void

incrementRotation(increment)

Dreht die Form um die angegebene Gradzahl um die Z-Achse. Verwenden Sie die rotation -Eigenschaft, um die absolute Drehung der Form festzulegen.

incrementRotation(increment: number): void;

Parameter

increment: number

Wie viele Grad die Form gedreht wird. Ein positiver Wert dreht die Form im Uhrzeigersinn, und ein negativer Wert dreht sie gegen den Uhrzeigersinn.

Gibt zurück

void

incrementTop(increment)

Verschiebt die Form vertikal um die angegebene Anzahl von Punkten.

incrementTop(increment: number): void;

Parameter

increment: number

Das Inkrement in Punkt wird die Form vertikal verschoben. Ein positiver Wert verschiebt die Form nach unten, und ein negativer Wert verschiebt sie nach oben.

Gibt zurück

void

scaleHeight(scaleFactor, scaleType, scaleFrom)

Skaliert die Höhe der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Höhe skaliert.

scaleHeight(
            scaleFactor: number,
            scaleType: ShapeScaleType,
            scaleFrom?: ShapeScaleFrom
        ): void;

Parameter

scaleFactor: number

Gibt das Verhältnis zwischen der Höhe der Form nach der Änderung ihrer Größe und der aktuellen oder ursprünglichen Höhe an.

scaleType: ExcelScript.ShapeScaleType

Gibt an, ob die Form relativ zur ursprünglichen oder aktuellen Größe skaliert wird. Die Ursprüngliche Größenskalierungsoption funktioniert nur für Bilder.

scaleFrom: ExcelScript.ShapeScaleFrom

Optional. Gibt an, welcher Teil der Form beim Skalieren die Position beibehält. Wenn sie nicht angegeben wird, stellt sie dar, dass die obere linke Ecke der Form ihre Position behält.

Gibt zurück

void

scaleWidth(scaleFactor, scaleType, scaleFrom)

Skaliert die Breite der Form anhand eines angegebenen Faktors. Für Bilder können Sie angeben, ob Sie die Form relativ zum Original oder zur aktuellen Größe skalieren möchten. Andere Formen als Bilder werden immer relativ zu ihrer aktuellen Breite skaliert.

scaleWidth(
            scaleFactor: number,
            scaleType: ShapeScaleType,
            scaleFrom?: ShapeScaleFrom
        ): void;

Parameter

scaleFactor: number

Gibt das Verhältnis zwischen der Breite der Form nach der Änderung ihrer Größe und der aktuellen oder ursprünglichen Breite an.

scaleType: ExcelScript.ShapeScaleType

Gibt an, ob die Form relativ zur ursprünglichen oder aktuellen Größe skaliert wird. Die Ursprüngliche Größenskalierungsoption funktioniert nur für Bilder.

scaleFrom: ExcelScript.ShapeScaleFrom

Optional. Gibt an, welcher Teil der Form beim Skalieren die Position beibehält. Wenn sie nicht angegeben wird, stellt sie dar, dass die obere linke Ecke der Form ihre Position behält.

Gibt zurück

void

setAltTextDescription(altTextDescription)

Gibt den alternativen Beschreibungstext für ein Shape -Objekt an.

setAltTextDescription(altTextDescription: string): void;

Parameter

altTextDescription: string

Gibt zurück

void

setAltTextTitle(altTextTitle)

Gibt den alternativen Titeltext für ein Shape -Objekt an.

setAltTextTitle(altTextTitle: string): void;

Parameter

altTextTitle: string

Gibt zurück

void

setGeometricShapeType(geometricShapeType)

setGeometricShapeType(geometricShapeType: GeometricShapeType): void;

Parameter

geometricShapeType: ExcelScript.GeometricShapeType

Gibt zurück

void

setHeight(height)

Gibt die Höhe der Form in Punkt an. Löst eine Ausnahme aus InvalidArgument , wenn als Eingabe mit einem negativen Wert oder 0 (null) festgelegt wird.

setHeight(height: number): void;

Parameter

height: number

Gibt zurück

void

setLeft(left)

Der Abstand in Punkten von der linken Seite der Form zur linken Seite des Arbeitsblatts. Löst eine InvalidArgument Ausnahme aus, wenn mit einem negativen Wert als Eingabe festgelegt wird.

setLeft(left: number): void;

Parameter

left: number

Gibt zurück

void

setLockAspectRatio(lockAspectRatio)

Gibt an, ob das Seitenverhältnis dieser Form gesperrt ist.

setLockAspectRatio(lockAspectRatio: boolean): void;

Parameter

lockAspectRatio: boolean

Gibt zurück

void

setName(name)

Gibt den Namen der Form an.

setName(name: string): void;

Parameter

name: string

Gibt zurück

void

Beispiele

/**
 * This script creates a triangle shape on the current worksheet and names it "TRI".
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const triangle: ExcelScript.Shape = 
    currentSheet.addGeometricShape(ExcelScript.GeometricShapeType.triangle);
  
  triangle.setName("TRI");
}

setPlacement(placement)

Stellt dar, wie das Objekt an die Zellen darunter angefügt ist.

setPlacement(placement: Placement): void;

Parameter

placement: ExcelScript.Placement

Gibt zurück

void

Beispiele

/**
 * This script creates a diamond shape at cell C3.
 * The shape moves and resizes as the grid underneath it changes.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get cell C3 in the current worksheet.
  const sheet = workbook.getActiveWorksheet();
  const cell = sheet.getRange("C3");

  // Create a diamond that slightly overlaps the cell C3.
  const diamond = sheet.addGeometricShape(ExcelScript.GeometricShapeType.diamond);
  // Set each dimension so that the shape extends 5 pixels beyond the cell borders.
  diamond.setLeft(cell.getLeft() - 5);
  diamond.setTop(cell.getTop() - 5);
  diamond.setHeight(cell.getHeight() + 10);
  diamond.setWidth(cell.getWidth() + 10);

  // Set the placement of the shape so that it resizes and moves with the grid.
  diamond.setPlacement(ExcelScript.Placement.twoCell);
}

setRotation(rotation)

Gibt die Drehung der Form in Grad an.

setRotation(rotation: number): void;

Parameter

rotation: number

Gibt zurück

void

setTop(top)

Der Abstand in Punkten zwischen der oberen Kante der Form und der oberen Kante der Arbeitsmappe. Löst eine InvalidArgument Ausnahme aus, wenn mit einem negativen Wert als Eingabe festgelegt wird.

setTop(top: number): void;

Parameter

top: number

Gibt zurück

void

setVisible(visible)

Gibt an, ob die Form sichtbar ist.

setVisible(visible: boolean): void;

Parameter

visible: boolean

Gibt zurück

void

setWidth(width)

Gibt die Breite der Form in Punkt an. Löst eine Ausnahme aus InvalidArgument , wenn als Eingabe mit einem negativen Wert oder 0 (null) festgelegt wird.

setWidth(width: number): void;

Parameter

width: number

Gibt zurück

void

setZOrder(position)

Verschiebt de angegebene Form in der Z-Reihenfolge der Sammlung nach oben oder unten, wodurch sie vor oder hinter anderen Formen zu liegen kommt.

setZOrder(position: ShapeZOrder): void;

Parameter

position: ExcelScript.ShapeZOrder

Wo die Form im Z-Reihenfolgenstapel relativ zu den anderen Shapes verschoben werden soll. Weitere Informationen finden Sie unter ExcelScript.ShapeZOrder .

Gibt zurück

void

Freigeben über

ExcelScript.Shape interface

Hinweise

Beispiele

Methoden

Details zur Methode

copyTo(destinationSheet)

Parameter

Gibt zurück

delete()

Gibt zurück

Beispiele

getAltTextDescription()

Gibt zurück

getAltTextTitle()

Gibt zurück

getAsImage(format)

Parameter

Gibt zurück

Beispiele

getConnectionSiteCount()

Gibt zurück

getFill()

Gibt zurück

getGeometricShape()

Gibt zurück

getGeometricShapeType()

Gibt zurück

getGroup()

Gibt zurück

getHeight()

Gibt zurück

getId()

Gibt zurück

getImage()

Gibt zurück

Beispiele

getImageAsBase64(format)

Parameter

Gibt zurück

getLeft()

Gibt zurück

getLevel()

Gibt zurück

getLine()

Gibt zurück

Beispiele

getLineFormat()

Gibt zurück

getLockAspectRatio()

Gibt zurück

getName()

Gibt zurück

getParentGroup()

Gibt zurück

getPlacement()

Gibt zurück

getRotation()

Gibt zurück

getTextFrame()

Gibt zurück

Beispiele

getTop()

Gibt zurück

getType()

Gibt zurück

getVisible()

Gibt zurück

getWidth()

Gibt zurück

getZOrderPosition()

Gibt zurück

incrementLeft(increment)

Parameter

Gibt zurück

incrementRotation(increment)

Parameter

Gibt zurück

incrementTop(increment)

Parameter