Partager via

Excel.Interfaces.ShapeCollectionLoadOptions interface

  • Référence
Paquet:
excel

Représente une collection de toutes les formes de la feuille de calcul.

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Propriétés

$all

La spécification des options de $all 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 de remplacement d’un Shape objet.
altTextTitle

Pour CHAQUE ÉLÉMENT de la collection : spécifie le texte de titre de remplacement d’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 complet de la forme. Une forme nouvellement créée a un nom généré qui est localisé et peut ne pas correspondre à son name. Dans ce scénario, vous pouvez utiliser cette API pour obtenir le nom affiché dans l’interface utilisateur.
fill

Pour CHAQUE ÉLÉMENT de la collection : renvoie 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 plus d’informations, consultez Excel.GeometricShapeType . Renvoie 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 exception lorsqu’elle InvalidArgument est définie avec une valeur négative ou zéro comme entrée.
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 le côté gauche de la forme et le côté gauche de la feuille de calcul. Lève une exception lorsqu’elle InvalidArgument est définie avec une valeur négative en tant qu’entrée.
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 trait 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 cadre 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 exception lorsqu’elle InvalidArgument est définie avec une valeur négative en tant qu’entrée.
type

Pour CHAQUE ÉLÉMENT de la collection : renvoie le type de cette forme. Pour plus d’informations, consultez Excel.ShapeType .
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 exception lorsqu’elle InvalidArgument est définie avec une valeur négative ou zéro comme entrée.
zOrderPosition

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

Détails de la propriété

$all

La spécification des options de $all 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 de remplacement d’un Shape objet.

altTextDescription?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

altTextTitle

Pour CHAQUE ÉLÉMENT de la collection : spécifie le texte de titre de remplacement d’un Shape objet.

altTextTitle?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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

[ Ensemble d’API : ExcelApi 1.9 ]

displayName

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

displayName?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.15 ]

fill

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

fill?: Excel.Interfaces.ShapeFillLoadOptions;

Valeur de propriété

Excel.Interfaces.ShapeFillLoadOptions

Remarques

[ Ensemble 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é

Excel.Interfaces.GeometricShapeLoadOptions

Remarques

[ Ensemble 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 plus d’informations, consultez Excel.GeometricShapeType . Renvoie null si le type de forme n’est pas « GeometricShape ».

geometricShapeType?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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é

Excel.Interfaces.ShapeGroupLoadOptions

Remarques

[ Ensemble 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 exception lorsqu’elle InvalidArgument est définie avec une valeur négative ou zéro comme entrée.

height?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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

[ Ensemble 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é

Excel.Interfaces.ImageLoadOptions

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

left

Pour CHAQUE ÉLÉMENT de la collection : distance, en points, entre le côté gauche de la forme et le côté gauche de la feuille de calcul. Lève une exception lorsqu’elle InvalidArgument est définie avec une valeur négative en tant qu’entrée.

left?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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

[ Ensemble 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é

Excel.Interfaces.LineLoadOptions

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

lineFormat

Pour CHAQUE ÉLÉMENT de la collection : renvoie la mise en forme de trait de cette forme.

lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;

Valeur de propriété

Excel.Interfaces.ShapeLineFormatLoadOptions

Remarques

[ Ensemble 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

[ Ensemble 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

[ Ensemble 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é

Excel.Interfaces.ShapeLoadOptions

Remarques

[ Ensemble 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

[ Ensemble 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

[ Ensemble d’API : ExcelApi 1.9 ]

textFrame

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

textFrame?: Excel.Interfaces.TextFrameLoadOptions;

Valeur de propriété

Excel.Interfaces.TextFrameLoadOptions

Remarques

[ Ensemble 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 exception lorsqu’elle InvalidArgument est définie avec une valeur négative en tant qu’entrée.

top?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

type

Pour CHAQUE ÉLÉMENT de la collection : renvoie le type de cette forme. Pour plus d’informations, consultez Excel.ShapeType .

type?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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

[ Ensemble 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 exception lorsqu’elle InvalidArgument est définie avec une valeur négative ou zéro comme entrée.

width?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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 de plan, avec 0 représentant le bas de la pile de commandes.

zOrderPosition?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]