Word.Interfaces.ShapeLoadOptions interface
Représente une forme dans l’en-tête, le pied de page ou le corps du document. Actuellement, seules les formes suivantes sont prises en charge : zones de texte, formes géométriques, groupes, images et canevas.
Remarques
[ Ensemble d’API : WordApiDesktop 1.2 ]
Propriétés
$all | La spécification des options de |
allow |
Spécifie si une forme donnée peut chevaucher d’autres formes. |
alt |
Spécifie une chaîne qui représente le texte de remplacement associé à la forme. |
body | Représente l’objet body de la forme. S’applique uniquement aux zones de texte et aux formes géométriques. |
canvas | Obtient le canevas associé à la forme. Un objet dont la |
fill | Renvoie la mise en forme de remplissage de la forme. |
geometric |
Type de forme géométrique de la forme. Elle sera null si n’est pas une forme géométrique. |
height | Hauteur, en points, de la forme. |
height |
Pourcentage de hauteur de forme par taille relative verticale, voir Word. RelativeSize. Pour une forme inline ou enfant, elle ne peut pas être définie. |
id | Obtient un entier qui représente l’identificateur de forme. |
is |
Vérifiez si cette forme est un enfant d’une forme de groupe ou d’une forme de canevas. |
left | La distance, en points, entre le côté gauche de la forme et la position relative horizontale, voir Word. RelativeHorizontalPosition. Pour une forme inline, elle retourne 0 et ne peut pas être définie. Pour une forme enfant dans un canevas ou un groupe, elle est relative au coin supérieur gauche. |
left |
La position de gauche relative sous la forme d’un pourcentage entre le côté gauche de la forme et la position relative horizontale, voir Word. RelativeHorizontalPosition. Pour une forme inline ou enfant, elle retourne 0 et ne peut pas être définie. |
lock |
Spécifie si les proportions de cette forme sont verrouillées. |
name | Nom de la forme. |
parent |
Obtient la forme de canevas parent de niveau supérieur de cette forme enfant. Elle sera null s’il ne s’agit pas d’une forme enfant d’un canevas. |
parent |
Obtient la forme de groupe parent de niveau supérieur de cette forme enfant. Il sera null s’il ne s’agit pas d’une forme enfant d’un groupe. |
relative |
Position horizontale relative de la forme. Pour une forme inline, elle ne peut pas être définie. Pour plus d’informations, consultez Word. RelativeHorizontalPosition. |
relative |
Taille horizontale relative de la forme. Pour une forme inline ou enfant, elle ne peut pas être définie. Pour plus d’informations, consultez Word. RelativeHorizontalPosition. |
relative |
Position verticale relative de la forme. Pour une forme inline, elle ne peut pas être définie. Pour plus d’informations, consultez Word. RelativeVerticalPosition. |
relative |
Taille verticale relative de la forme. Pour une forme inline ou enfant, elle ne peut pas être définie. Pour plus d’informations, consultez Word. RelativeHorizontalPosition. |
rotation | Spécifie la rotation, en degrés, de la forme. Non applicable à la forme Canevas. |
shape |
Obtient le groupe de formes associé à la forme. Un objet dont la |
text |
Obtient l’objet de cadre de texte de la forme. |
text |
Retourne la mise en forme de habillage du texte de la forme. |
top | La distance, en points, entre le bord supérieur de la forme et la position relative verticale, voir Word. RelativeVerticalPosition. Pour une forme inline, elle retourne 0 et ne peut pas être définie. Pour une forme enfant dans un canevas ou un groupe, elle est relative au coin supérieur gauche. |
top |
La position supérieure relative sous la forme d’un pourcentage entre le bord supérieur de la forme et la position relative verticale, voir Word. RelativeVerticalPosition. Pour une forme inline ou enfant, elle retourne 0 et ne peut pas être définie. |
type | Obtient le type de forme. Actuellement, seules les formes suivantes sont prises en charge : zones de texte, formes géométriques, groupes, images et canevas. |
visible | Spécifie si la forme est visible. Non applicable aux formes insérées. |
width | Largeur, en points, de la forme. |
width |
Pourcentage de largeur de forme par taille relative horizontale, consultez Word. RelativeSize. Pour une forme inline ou enfant, elle ne peut pas être définie. |
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
allowOverlap
Spécifie si une forme donnée peut chevaucher d’autres formes.
allowOverlap?: boolean;
Valeur de propriété
boolean
Remarques
altTextDescription
Spécifie une chaîne qui représente le texte de remplacement associé à la forme.
altTextDescription?: boolean;
Valeur de propriété
boolean
Remarques
body
Représente l’objet body de la forme. S’applique uniquement aux zones de texte et aux formes géométriques.
body?: Word.Interfaces.BodyLoadOptions;
Valeur de propriété
Remarques
canvas
Obtient le canevas associé à la forme. Un objet dont la isNullObject
propriété est définie true
sur est retourné si le type de forme n’est pas « Canvas ». Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
canvas?: Word.Interfaces.CanvasLoadOptions;
Valeur de propriété
Remarques
fill
Renvoie la mise en forme de remplissage de la forme.
fill?: Word.Interfaces.ShapeFillLoadOptions;
Valeur de propriété
Remarques
geometricShapeType
Type de forme géométrique de la forme. Elle sera null si n’est pas une forme géométrique.
geometricShapeType?: boolean;
Valeur de propriété
boolean
Remarques
height
Hauteur, en points, de la forme.
height?: boolean;
Valeur de propriété
boolean
Remarques
heightRelative
Pourcentage de hauteur de forme par taille relative verticale, voir Word. RelativeSize. Pour une forme inline ou enfant, elle ne peut pas être définie.
heightRelative?: boolean;
Valeur de propriété
boolean
Remarques
id
Obtient un entier qui représente l’identificateur de forme.
id?: boolean;
Valeur de propriété
boolean
Remarques
isChild
Vérifiez si cette forme est un enfant d’une forme de groupe ou d’une forme de canevas.
isChild?: boolean;
Valeur de propriété
boolean
Remarques
left
La distance, en points, entre le côté gauche de la forme et la position relative horizontale, voir Word. RelativeHorizontalPosition. Pour une forme inline, elle retourne 0 et ne peut pas être définie. Pour une forme enfant dans un canevas ou un groupe, elle est relative au coin supérieur gauche.
left?: boolean;
Valeur de propriété
boolean
Remarques
leftRelative
La position de gauche relative sous la forme d’un pourcentage entre le côté gauche de la forme et la position relative horizontale, voir Word. RelativeHorizontalPosition. Pour une forme inline ou enfant, elle retourne 0 et ne peut pas être définie.
leftRelative?: boolean;
Valeur de propriété
boolean
Remarques
lockAspectRatio
Spécifie si les proportions de cette forme sont verrouillées.
lockAspectRatio?: boolean;
Valeur de propriété
boolean
Remarques
name
Nom de la forme.
name?: boolean;
Valeur de propriété
boolean
Remarques
parentCanvas
Obtient la forme de canevas parent de niveau supérieur de cette forme enfant. Elle sera null s’il ne s’agit pas d’une forme enfant d’un canevas.
parentCanvas?: Word.Interfaces.ShapeLoadOptions;
Valeur de propriété
Remarques
parentGroup
Obtient la forme de groupe parent de niveau supérieur de cette forme enfant. Il sera null s’il ne s’agit pas d’une forme enfant d’un groupe.
parentGroup?: Word.Interfaces.ShapeLoadOptions;
Valeur de propriété
Remarques
relativeHorizontalPosition
Position horizontale relative de la forme. Pour une forme inline, elle ne peut pas être définie. Pour plus d’informations, consultez Word. RelativeHorizontalPosition.
relativeHorizontalPosition?: boolean;
Valeur de propriété
boolean
Remarques
relativeHorizontalSize
Taille horizontale relative de la forme. Pour une forme inline ou enfant, elle ne peut pas être définie. Pour plus d’informations, consultez Word. RelativeHorizontalPosition.
relativeHorizontalSize?: boolean;
Valeur de propriété
boolean
Remarques
relativeVerticalPosition
Position verticale relative de la forme. Pour une forme inline, elle ne peut pas être définie. Pour plus d’informations, consultez Word. RelativeVerticalPosition.
relativeVerticalPosition?: boolean;
Valeur de propriété
boolean
Remarques
relativeVerticalSize
Taille verticale relative de la forme. Pour une forme inline ou enfant, elle ne peut pas être définie. Pour plus d’informations, consultez Word. RelativeHorizontalPosition.
relativeVerticalSize?: boolean;
Valeur de propriété
boolean
Remarques
rotation
Spécifie la rotation, en degrés, de la forme. Non applicable à la forme Canevas.
rotation?: boolean;
Valeur de propriété
boolean
Remarques
shapeGroup
Obtient le groupe de formes associé à la forme. Un objet dont la isNullObject
propriété est définie true
sur est retourné si le type de forme n’est pas « GroupShape ». Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;
Valeur de propriété
Remarques
textFrame
Obtient l’objet de cadre de texte de la forme.
textFrame?: Word.Interfaces.TextFrameLoadOptions;
Valeur de propriété
Remarques
textWrap
Retourne la mise en forme de habillage du texte de la forme.
textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;
Valeur de propriété
Remarques
top
La distance, en points, entre le bord supérieur de la forme et la position relative verticale, voir Word. RelativeVerticalPosition. Pour une forme inline, elle retourne 0 et ne peut pas être définie. Pour une forme enfant dans un canevas ou un groupe, elle est relative au coin supérieur gauche.
top?: boolean;
Valeur de propriété
boolean
Remarques
topRelative
La position supérieure relative sous la forme d’un pourcentage entre le bord supérieur de la forme et la position relative verticale, voir Word. RelativeVerticalPosition. Pour une forme inline ou enfant, elle retourne 0 et ne peut pas être définie.
topRelative?: boolean;
Valeur de propriété
boolean
Remarques
type
Obtient le type de forme. Actuellement, seules les formes suivantes sont prises en charge : zones de texte, formes géométriques, groupes, images et canevas.
type?: boolean;
Valeur de propriété
boolean
Remarques
visible
Spécifie si la forme est visible. Non applicable aux formes insérées.
visible?: boolean;
Valeur de propriété
boolean
Remarques
width
Largeur, en points, de la forme.
width?: boolean;
Valeur de propriété
boolean
Remarques
widthRelative
Pourcentage de largeur de forme par taille relative horizontale, consultez Word. RelativeSize. Pour une forme inline ou enfant, elle ne peut pas être définie.
widthRelative?: boolean;
Valeur de propriété
boolean