Excel.Interfaces.ShapeCollectionLoadOptions interface

Représente un ensemble de toutes les formes de la feuille de calcul.

Propriétés

$all

La spécification $all des options de chargement charge toutes les propriétés scalaires (telles que Range.address) mais pas les propriétés de navigation (telles que Range.format.fill.color).

altTextDescription

Pour CHAQUE ÉLÉMENT de la collection : Spécifie le texte de description alternatif d’un Shape objet.

altTextTitle

Pour CHAQUE ÉLÉMENT de la collection : Spécifie le texte de remplacement du titre pour un Shape objet.

connectionSiteCount

Pour CHAQUE ÉLÉMENT de la collection : renvoie le nombre de sites de connexion sur cette forme.

displayName

Pour CHAQUE ÉLÉMENT de la collection : Obtient le nom d’affichage de la forme. Une forme nouvellement créée a un nom généré localisé qui peut ne pas correspondre à son name. Dans ce scénario, vous pouvez utiliser cette API pour obtenir le nom qui s’affiche dans l’interface utilisateur.

fill

Pour CHAQUE ÉLÉMENT DE la collection : Retourne la mise en forme de remplissage de cette forme.

geometricShape

Pour CHAQUE ÉLÉMENT de la collection : renvoie la forme géométrique associée à la forme. Une erreur sera lancée si le type de forme n’est pas "GeometricShape".

geometricShapeType

Pour CHAQUE ÉLÉMENT DE la collection : Spécifie le type de forme géométrique de cette forme géométrique. Pour Excel.GeometricShapeType plus de détails. Retourne null si le type de forme n’est pas « GeometricShape ».

group

Pour CHAQUE ÉLÉMENT de la collection : renvoie le groupe de formes associé à la forme. Une erreur sera lancée si le type de forme n’est pas "GroupShape".

height

Pour CHAQUE ÉLÉMENT de la collection : Spécifie la hauteur, en points, de la forme. Lève une InvalidArgument exception lorsqu’une valeur d’entrée est négative ou égale à zéro.

id

Pour CHAQUE ÉLÉMENT de la collection : Spécifie l’identificateur de forme.

image

Pour CHAQUE ÉLÉMENT de la collection : Renvoie l’image associée à la forme. Une erreur sera lancée si le type de forme n’est pas "Image".

left

Pour CHAQUE ÉLÉMENT de la collection : distance, en points, entre la gauche de la forme et la gauche de la feuille de calcul. Lève une InvalidArgument exception lorsqu’une valeur d’entrée est négative.

level

Pour CHAQUE ÉLÉMENT de la collection : Spécifie le niveau de la forme spécifiée. Par exemple, un niveau de 0 signifie que la forme ne fait pas partie d’un groupe, un niveau de la forme 1 signifie fait partie d’un groupe de niveau supérieur et un niveau de 2, la forme fait partie d’un groupe sous-blocs de niveau supérieur.

line

Pour CHAQUE ÉLÉMENT de la collection : Renvoie la ligne associée à la forme. Une erreur sera lancée si le type de forme n’est pas "Ligne".

lineFormat

Pour CHAQUE ÉLÉMENT de la collection : Renvoie la mise en forme de ligne de cette forme.

lockAspectRatio

Pour CHAQUE ÉLÉMENT de la collection : spécifie si les proportions de cette forme sont verrouillées.

name

Pour CHAQUE ÉLÉMENT de la collection : Spécifie le nom de la forme.

parentGroup

Pour CHAQUE ÉLÉMENT de la collection : Spécifie le groupe parent de cette forme.

placement

Pour CHAQUE ÉLÉMENT de la collection : Représente la façon dont l’objet est attaché aux cellules situées en dessous.

rotation

Pour CHAQUE ÉLÉMENT de la collection : Spécifie la rotation, en degrés, de la forme.

textFrame

Pour CHAQUE ÉLÉMENT de la collection : Renvoie l’objet de bloc de texte de cette forme.

top

Pour CHAQUE ÉLÉMENT de la collection : distance, en points, entre le bord supérieur de la forme et le bord supérieur de la feuille de calcul. Lève une InvalidArgument exception lorsqu’une valeur d’entrée est négative.

type

Pour CHAQUE ÉLÉMENT de la collection : Renvoie le type de cette forme. Pour Excel.ShapeType plus de détails.

visible

Pour CHAQUE ÉLÉMENT de la collection : Spécifie si la forme est visible.

width

Pour CHAQUE ÉLÉMENT de la collection : Spécifie la largeur, en points, de la forme. Lève une InvalidArgument exception lorsqu’une valeur d’entrée est négative ou égale à zéro.

zOrderPosition

Pour CHAQUE ÉLÉMENT de la collection : renvoie la position de la forme spécifiée dans l’ordre z, 0 représentant le bas de la pile d’ordres.

Détails de la propriété

$all

La spécification $all des options de chargement charge toutes les propriétés scalaires (telles que Range.address) mais pas les propriétés de navigation (telles que Range.format.fill.color).

$all?: boolean;

Valeur de propriété

boolean

altTextDescription

Pour CHAQUE ÉLÉMENT de la collection : Spécifie le texte de description alternatif d’un Shape objet.

altTextDescription?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

altTextTitle

Pour CHAQUE ÉLÉMENT de la collection : Spécifie le texte de remplacement du titre pour un Shape objet.

altTextTitle?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

connectionSiteCount

Pour CHAQUE ÉLÉMENT de la collection : renvoie le nombre de sites de connexion sur cette forme.

connectionSiteCount?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

displayName

Pour CHAQUE ÉLÉMENT de la collection : Obtient le nom d’affichage de la forme. Une forme nouvellement créée a un nom généré localisé qui peut ne pas correspondre à son name. Dans ce scénario, vous pouvez utiliser cette API pour obtenir le nom qui s’affiche dans l’interface utilisateur.

displayName?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.15

fill

Pour CHAQUE ÉLÉMENT DE la collection : Retourne la mise en forme de remplissage de cette forme.

fill?: Excel.Interfaces.ShapeFillLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

geometricShape

Pour CHAQUE ÉLÉMENT de la collection : renvoie la forme géométrique associée à la forme. Une erreur sera lancée si le type de forme n’est pas "GeometricShape".

geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

geometricShapeType

Pour CHAQUE ÉLÉMENT DE la collection : Spécifie le type de forme géométrique de cette forme géométrique. Pour Excel.GeometricShapeType plus de détails. Retourne null si le type de forme n’est pas « GeometricShape ».

geometricShapeType?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

group

Pour CHAQUE ÉLÉMENT de la collection : renvoie le groupe de formes associé à la forme. Une erreur sera lancée si le type de forme n’est pas "GroupShape".

group?: Excel.Interfaces.ShapeGroupLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

height

Pour CHAQUE ÉLÉMENT de la collection : Spécifie la hauteur, en points, de la forme. Lève une InvalidArgument exception lorsqu’une valeur d’entrée est négative ou égale à zéro.

height?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

id

Pour CHAQUE ÉLÉMENT de la collection : Spécifie l’identificateur de forme.

id?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

image

Pour CHAQUE ÉLÉMENT de la collection : Renvoie l’image associée à la forme. Une erreur sera lancée si le type de forme n’est pas "Image".

image?: Excel.Interfaces.ImageLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

left

Pour CHAQUE ÉLÉMENT de la collection : distance, en points, entre la gauche de la forme et la gauche de la feuille de calcul. Lève une InvalidArgument exception lorsqu’une valeur d’entrée est négative.

left?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

level

Pour CHAQUE ÉLÉMENT de la collection : Spécifie le niveau de la forme spécifiée. Par exemple, un niveau de 0 signifie que la forme ne fait pas partie d’un groupe, un niveau de la forme 1 signifie fait partie d’un groupe de niveau supérieur et un niveau de 2, la forme fait partie d’un groupe sous-blocs de niveau supérieur.

level?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

line

Pour CHAQUE ÉLÉMENT de la collection : Renvoie la ligne associée à la forme. Une erreur sera lancée si le type de forme n’est pas "Ligne".

line?: Excel.Interfaces.LineLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

lineFormat

Pour CHAQUE ÉLÉMENT de la collection : Renvoie la mise en forme de ligne de cette forme.

lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

lockAspectRatio

Pour CHAQUE ÉLÉMENT de la collection : spécifie si les proportions de cette forme sont verrouillées.

lockAspectRatio?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

name

Pour CHAQUE ÉLÉMENT de la collection : Spécifie le nom de la forme.

name?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

parentGroup

Pour CHAQUE ÉLÉMENT de la collection : Spécifie le groupe parent de cette forme.

parentGroup?: Excel.Interfaces.ShapeLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

placement

Pour CHAQUE ÉLÉMENT de la collection : Représente la façon dont l’objet est attaché aux cellules situées en dessous.

placement?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.10

rotation

Pour CHAQUE ÉLÉMENT de la collection : Spécifie la rotation, en degrés, de la forme.

rotation?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

textFrame

Pour CHAQUE ÉLÉMENT de la collection : Renvoie l’objet de bloc de texte de cette forme.

textFrame?: Excel.Interfaces.TextFrameLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

top

Pour CHAQUE ÉLÉMENT de la collection : distance, en points, entre le bord supérieur de la forme et le bord supérieur de la feuille de calcul. Lève une InvalidArgument exception lorsqu’une valeur d’entrée est négative.

top?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

type

Pour CHAQUE ÉLÉMENT de la collection : Renvoie le type de cette forme. Pour Excel.ShapeType plus de détails.

type?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

visible

Pour CHAQUE ÉLÉMENT de la collection : Spécifie si la forme est visible.

visible?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

width

Pour CHAQUE ÉLÉMENT de la collection : Spécifie la largeur, en points, de la forme. Lève une InvalidArgument exception lorsqu’une valeur d’entrée est négative ou égale à zéro.

width?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

zOrderPosition

Pour CHAQUE ÉLÉMENT de la collection : renvoie la position de la forme spécifiée dans l’ordre z, 0 représentant le bas de la pile d’ordres.

zOrderPosition?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9