Excel.Interfaces.ShapeLoadOptions interface

Paket:
excel

Stellt ein generisches Formobjekt im Arbeitsblatt dar. Ein Shape kann ein geometrisches Shape, eine Linie, eine Gruppe von Shapes usw. sein. Weitere Informationen zum Formobjektmodell finden Sie unter Arbeiten mit Formen mithilfe der Excel-JavaScript-API.

Hinweise

[API-Satz: ExcelApi 1.9]

Eigenschaften

$all

Wenn Sie für die Ladeoptionen angeben $all , werden alle skalaren Eigenschaften (z. B Range.address. ) geladen, aber nicht die Navigationseigenschaften (z. B Range.format.fill.color. ).
altTextDescription

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

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

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

Ruft den Anzeigenamen der Form ab. Ein neu erstelltes Shape hat einen generierten Namen, der lokalisiert ist und möglicherweise nicht mit seinem nameübereinstimmt. In diesem Szenario können Sie diese API verwenden, um den Namen abzurufen, der auf der Benutzeroberfläche angezeigt wird.
fill

Gibt die Füllungsformatierung dieser Form zurück.
geometricShape

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

Gibt den geometrischen Formtyp dieser geometrischen Form an. Weitere Informationen findest du hier Excel.GeometricShapeType . Gibt zurück null , wenn der Formtyp nicht "GeometricShape" ist.
group

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

Gibt die Höhe des Shapes in Punkten an. Löst eine InvalidArgument Ausnahme aus, wenn sie mit einem negativen Wert oder Null als Eingabe festgelegt wurde.
id

Gibt den Formbezeichner an.
image

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

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

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

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

Gibt die Linienformatierung dieser Form zurück.
lockAspectRatio

Gibt an, ob das Seitenverhältnis dieses Shapes gesperrt ist.
name

Gibt den Namen der Form an.
parentGroup

Gibt die übergeordnete Gruppe dieses Shapes an.
placement

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

Gibt die Drehung der Form in Grad an.
textFrame

Gibt das textFrame-Objekt dieser Form zurück.
top

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

Gibt den Typ dieser Form zurück. Weitere Informationen findest du hier Excel.ShapeType .
visible

Gibt an, ob das Shape sichtbar ist.
width

Gibt die Breite des Shapes in Punkten an. Löst eine InvalidArgument Ausnahme aus, wenn sie mit einem negativen Wert oder Null als Eingabe festgelegt wurde.
zOrderPosition

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

Details zur Eigenschaft

$all

Wenn Sie für die Ladeoptionen angeben $all , werden alle skalaren Eigenschaften (z. B Range.address. ) geladen, aber nicht die Navigationseigenschaften (z. B Range.format.fill.color. ).

$all?: boolean;

Eigenschaftswert

boolean

altTextDescription

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

altTextDescription?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9]

altTextTitle

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

altTextTitle?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9]

connectionSiteCount

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

connectionSiteCount?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9]

displayName

Ruft den Anzeigenamen der Form ab. Ein neu erstelltes Shape hat einen generierten Namen, der lokalisiert ist und möglicherweise nicht mit seinem nameübereinstimmt. In diesem Szenario können Sie diese API verwenden, um den Namen abzurufen, der auf der Benutzeroberfläche angezeigt wird.

displayName?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.15]

fill

Gibt die Füllungsformatierung dieser Form zurück.

fill?: Excel.Interfaces.ShapeFillLoadOptions;

Eigenschaftswert

Excel.Interfaces.ShapeFillLoadOptions

Hinweise

[API-Satz: ExcelApi 1.9]

geometricShape

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

geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions;

Eigenschaftswert

Excel.Interfaces.GeometricShapeLoadOptions

Hinweise

[API-Satz: ExcelApi 1.9]

geometricShapeType

Gibt den geometrischen Formtyp dieser geometrischen Form an. Weitere Informationen findest du hier Excel.GeometricShapeType . Gibt zurück null , wenn der Formtyp nicht "GeometricShape" ist.

geometricShapeType?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9]

group

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

group?: Excel.Interfaces.ShapeGroupLoadOptions;

Eigenschaftswert

Excel.Interfaces.ShapeGroupLoadOptions

Hinweise

[API-Satz: ExcelApi 1.9]

height

Gibt die Höhe des Shapes in Punkten an. Löst eine InvalidArgument Ausnahme aus, wenn sie mit einem negativen Wert oder Null als Eingabe festgelegt wurde.

height?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9]

id

Gibt den Formbezeichner an.

id?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9]

image

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

image?: Excel.Interfaces.ImageLoadOptions;

Eigenschaftswert

Excel.Interfaces.ImageLoadOptions

Hinweise

[API-Satz: ExcelApi 1.9]

left

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

left?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9]

level

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.

level?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9]

line

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

line?: Excel.Interfaces.LineLoadOptions;

Eigenschaftswert

Excel.Interfaces.LineLoadOptions

Hinweise

[API-Satz: ExcelApi 1.9]

lineFormat

Gibt die Linienformatierung dieser Form zurück.

lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;

Eigenschaftswert

Excel.Interfaces.ShapeLineFormatLoadOptions

Hinweise

[API-Satz: ExcelApi 1.9]

lockAspectRatio

Gibt an, ob das Seitenverhältnis dieses Shapes gesperrt ist.

lockAspectRatio?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9]

name

Gibt den Namen der Form an.

name?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9]

parentGroup

Gibt die übergeordnete Gruppe dieses Shapes an.

parentGroup?: Excel.Interfaces.ShapeLoadOptions;

Eigenschaftswert

Excel.Interfaces.ShapeLoadOptions

Hinweise

[API-Satz: ExcelApi 1.9]

placement

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

placement?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.10]

rotation

Gibt die Drehung der Form in Grad an.

rotation?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9]

textFrame

Gibt das textFrame-Objekt dieser Form zurück.

textFrame?: Excel.Interfaces.TextFrameLoadOptions;

Eigenschaftswert

Excel.Interfaces.TextFrameLoadOptions

Hinweise

[API-Satz: ExcelApi 1.9]

top

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

top?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9]

type

Gibt den Typ dieser Form zurück. Weitere Informationen findest du hier Excel.ShapeType .

type?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9]

visible

Gibt an, ob das Shape sichtbar ist.

visible?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9]

width

Gibt die Breite des Shapes in Punkten an. Löst eine InvalidArgument Ausnahme aus, wenn sie mit einem negativen Wert oder Null als Eingabe festgelegt wurde.

width?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9]

zOrderPosition

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

zOrderPosition?: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9]