Excel.Interfaces.ShapeLoadOptions interface

Paquet:

excel

Représente un objet de forme générique dans la feuille de calcul. Une forme peut être une forme géométrique, une ligne, un groupe de formes, etc. Pour en savoir plus sur le modèle objet de forme, consultez Utiliser des formes à l’aide de l’API JavaScript Excel.

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	Spécifie le texte de description de remplacement d’un Shape objet.
altTextTitle	Spécifie le texte de titre de remplacement d’un Shape objet.
connectionSiteCount	Renvoie le nombre de sites de connexion sur la forme spécifiée.
displayName	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	Renvoie la mise en forme de remplissage de cette forme.
geometricShape	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	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	Renvoie le groupe de la Forme associée à la forme. Une erreur sera lancée si le type de forme n’est pas "GroupShape".
height	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	Spécifie l’identificateur de forme.
image	Renvoie l’image associé à la forme. Une erreur sera lancée si le type de forme n’est pas "Image".
left	La distance, en points, entre le côté gauche du graphique et l’origine 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	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	Renvoie l’image associée à la forme. Une erreur sera lancée si le type de forme n’est pas "Ligne".
lineFormat	Renvoie la mise en forme de ligne de cette forme.
lockAspectRatio	Spécifie si les proportions de cette forme sont verrouillées.
name	Spécifie le nom de la forme.
parentGroup	Spécifie le groupe parent de cette forme.
placement	Représente la manière dont l’objet est attaché aux cellules en dessous.
rotation	Spécifie la rotation, en degrés, de la forme.
textFrame	Renvoie l’objet textFrame d’une forme.
top	La distance, en points, du bord supérieur de l’objet au 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	Renvoie le type de cette forme. Pour plus d’informations, consultez Excel.ShapeType .
visible	Spécifie si la forme est visible.
width	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	Renvoie la position de la forme spécifiée dans l’ordre z, valeur z de commande de la forme tout en bas est égal à 0.

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

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

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

Renvoie le nombre de sites de connexion sur la forme spécifiée.

connectionSiteCount?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

displayName

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

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

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

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

Renvoie le groupe de la Forme associée à 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

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

Spécifie l’identificateur de forme.

id?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

image

Renvoie l’image associé à 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

La distance, en points, entre le côté gauche du graphique et l’origine 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

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

Renvoie l’image 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

Renvoie la mise en forme de ligne de cette forme.

lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;

Valeur de propriété

Excel.Interfaces.ShapeLineFormatLoadOptions

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

lockAspectRatio

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

Spécifie le nom de la forme.

name?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

parentGroup

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

Représente la manière dont l’objet est attaché aux cellules en dessous.

placement?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

rotation

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

Renvoie l’objet textFrame d’une forme.

textFrame?: Excel.Interfaces.TextFrameLoadOptions;

Valeur de propriété

Excel.Interfaces.TextFrameLoadOptions

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

top

La distance, en points, du bord supérieur de l’objet au 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

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

Spécifie si la forme est visible.

visible?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

width

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

Renvoie la position de la forme spécifiée dans l’ordre z, valeur z de commande de la forme tout en bas est égal à 0.

zOrderPosition?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]