Word.Shape class

Paquet:

word

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.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Propriétés

allowOverlap	Spécifie si une forme donnée peut chevaucher d’autres formes.
altTextDescription	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 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.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
fill	Renvoie la mise en forme de remplissage de la forme.
geometricShapeType	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.
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.
id	Obtient un entier qui représente l’identificateur de forme.
isChild	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.
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.
lockAspectRatio	Spécifie si les proportions de cette forme sont verrouillées.
name	Nom de la forme.
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.
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.
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.
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.
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.
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.
rotation	Spécifie la rotation, en degrés, de la forme. Non applicable à la forme Canevas.
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.
textFrame	Obtient l’objet de cadre de texte de la forme.
textWrap	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.
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.
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.
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.

Méthodes

delete()	Supprime la forme et son contenu.
load(options)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
moveHorizontally(distance)	Déplace la forme horizontalement selon le nombre de points.
moveVertically(distance)	Déplace la forme verticalement en fonction du nombre de points.
scaleHeight(scaleFactor, scaleType, scaleFrom)	Met la hauteur de la forme à l’échelle en utilisant un facteur spécifié. Pour des images, vous pouvez indiquer si vous souhaitez mettre la forme à l’échelle par rapport à la taille d’origine ou la taille actuelle. Les formes autres que des images sont toujours mis à l’échelle par rapport à leur hauteur actuelle.
scaleHeight(scaleFactor, scaleTypeString, scaleFromString)	Met la hauteur de la forme à l’échelle en utilisant un facteur spécifié. Pour des images, vous pouvez indiquer si vous souhaitez mettre la forme à l’échelle par rapport à la taille d’origine ou la taille actuelle. Les formes autres que des images sont toujours mis à l’échelle par rapport à leur hauteur actuelle.
scaleWidth(scaleFactor, scaleType, scaleFrom)	Met la largeur de la forme à l’échelle en utilisant un facteur spécifié. Pour des images, vous pouvez indiquer si vous souhaitez mettre la forme à l’échelle par rapport à la taille d’origine ou la taille actuelle. Les formes autres que des images sont toujours mis à l’échelle par rapport à leur hauteur actuelle.
scaleWidth(scaleFactor, scaleTypeString, scaleFromString)	Met la largeur de la forme à l’échelle en utilisant un facteur spécifié. Pour des images, vous pouvez indiquer si vous souhaitez mettre la forme à l’échelle par rapport à la taille d’origine ou la taille actuelle. Les formes autres que des images sont toujours mis à l’échelle par rapport à leur hauteur actuelle.
select(selectMultipleShapes)	Sélectionne la forme.
set(properties, options)	Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties)	Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
toJSON()	Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.Shape est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.ShapeDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
track()	Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.
untrack()	Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

Détails de la propriété

allowOverlap

Spécifie si une forme donnée peut chevaucher d’autres formes.

allowOverlap: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

altTextDescription

Spécifie une chaîne qui représente le texte de remplacement associé à la forme.

altTextDescription: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

body

Représente l’objet body de la forme. S’applique uniquement aux zones de texte et aux formes géométriques.

readonly body: Word.Body;

Valeur de propriété

Word.Body

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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.

readonly canvas: Word.Canvas;

Valeur de propriété

Word.Canvas

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Word.RequestContext

fill

Renvoie la mise en forme de remplissage de la forme.

readonly fill: Word.ShapeFill;

Valeur de propriété

Word.ShapeFill

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

geometricShapeType

Type de forme géométrique de la forme. Elle sera null si n’est pas une forme géométrique.

geometricShapeType: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";

Valeur de propriété

Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

height

Hauteur, en points, de la forme.

height: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

id

Obtient un entier qui représente l’identificateur de forme.

readonly id: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

isChild

Vérifiez si cette forme est un enfant d’une forme de groupe ou d’une forme de canevas.

readonly isChild: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

lockAspectRatio

Spécifie si les proportions de cette forme sont verrouillées.

lockAspectRatio: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

name

Nom de la forme.

name: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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.

readonly parentCanvas: Word.Shape;

Valeur de propriété

Word.Shape

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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.

readonly parentGroup: Word.Shape;

Valeur de propriété

Word.Shape

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";

Valeur de propriété

Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

Valeur de propriété

Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

Valeur de propriété

Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

Valeur de propriété

Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

rotation

Spécifie la rotation, en degrés, de la forme. Non applicable à la forme Canevas.

rotation: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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.

readonly shapeGroup: Word.ShapeGroup;

Valeur de propriété

Word.ShapeGroup

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

textFrame

Obtient l’objet de cadre de texte de la forme.

readonly textFrame: Word.TextFrame;

Valeur de propriété

Word.TextFrame

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

textWrap

Retourne la mise en forme de habillage du texte de la forme.

readonly textWrap: Word.ShapeTextWrap;

Valeur de propriété

Word.ShapeTextWrap

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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.

readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas";

Valeur de propriété

Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

visible

Spécifie si la forme est visible. Non applicable aux formes insérées.

visible: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

width

Largeur, en points, de la forme.

width: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Détails de la méthode

delete()

Supprime la forme et son contenu.

delete(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Word.Interfaces.ShapeLoadOptions): Word.Shape;

Paramètres

options

Word.Interfaces.ShapeLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Word.Shape

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Word.Shape;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Word.Shape

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Shape;

Paramètres

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Word.Shape

moveHorizontally(distance)

Déplace la forme horizontalement selon le nombre de points.

moveHorizontally(distance: number): void;

Paramètres

distance

number

Obligatoire. Spécifie en points la distance de déplacement horizontal. Utilisez une valeur positive pour déplacer la forme vers la droite. Utilisez une valeur négative pour déplacer la forme vers la gauche.

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

moveVertically(distance)

Déplace la forme verticalement en fonction du nombre de points.

moveVertically(distance: number): void;

Paramètres

distance

number

Obligatoire. Spécifie en points la distance de décalage vertical de la forme. Utilisez une valeur positive pour déplacer la forme vers le haut. Utilisez une valeur négative pour déplacer la forme vers le bas.

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

scaleHeight(scaleFactor, scaleType, scaleFrom)

Met la hauteur de la forme à l’échelle en utilisant un facteur spécifié. Pour des images, vous pouvez indiquer si vous souhaitez mettre la forme à l’échelle par rapport à la taille d’origine ou la taille actuelle. Les formes autres que des images sont toujours mis à l’échelle par rapport à leur hauteur actuelle.

scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void;

Paramètres

scaleFactor

number

Indique le rapport entre la hauteur de la forme redimensionnée et sa hauteur actuelle ou originale.

scaleType

Word.ShapeScaleType

Spécifie si la forme est mise à l’échelle par rapport à sa taille d’origine ou actuelle. L’option de mise à l’échelle de taille d’origine fonctionne uniquement pour les images.

scaleFrom

Word.ShapeScaleFrom

Facultatif. Spécifie la partie de la forme qui conserve sa position lorsque le forme est mise à l'échelle. S’il est omis, il indique que le coin supérieur gauche de la forme conserve sa position.

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

scaleHeight(scaleFactor, scaleTypeString, scaleFromString)

Met la hauteur de la forme à l’échelle en utilisant un facteur spécifié. Pour des images, vous pouvez indiquer si vous souhaitez mettre la forme à l’échelle par rapport à la taille d’origine ou la taille actuelle. Les formes autres que des images sont toujours mis à l’échelle par rapport à leur hauteur actuelle.

scaleHeight(scaleFactor: number, scaleTypeString: "CurrentSize" | "OriginalSize", scaleFromString?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;

Paramètres

scaleFactor

number

Indique le rapport entre la hauteur de la forme redimensionnée et sa hauteur actuelle ou originale.

scaleTypeString

"CurrentSize" | "OriginalSize"

Spécifie si la forme est mise à l’échelle par rapport à sa taille d’origine ou actuelle. L’option de mise à l’échelle de taille d’origine fonctionne uniquement pour les images.

scaleFromString

"ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"

Facultatif. Spécifie la partie de la forme qui conserve sa position lorsque le forme est mise à l'échelle. S’il est omis, il indique que le coin supérieur gauche de la forme conserve sa position.

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

scaleWidth(scaleFactor, scaleType, scaleFrom)

Met la largeur de la forme à l’échelle en utilisant un facteur spécifié. Pour des images, vous pouvez indiquer si vous souhaitez mettre la forme à l’échelle par rapport à la taille d’origine ou la taille actuelle. Les formes autres que des images sont toujours mis à l’échelle par rapport à leur hauteur actuelle.

scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void;

Paramètres

scaleFactor

number

Indique le rapport de la largeur de la forme redimensionnée sur sa largeur actuelle ou originale.

scaleType

Word.ShapeScaleType

Spécifie si la forme est mise à l’échelle par rapport à sa taille d’origine ou actuelle. L’option de mise à l’échelle de taille d’origine fonctionne uniquement pour les images.

scaleFrom

Word.ShapeScaleFrom

Facultatif. Spécifie la partie de la forme qui conserve sa position lorsque le forme est mise à l'échelle. S’il est omis, il indique que le coin supérieur gauche de la forme conserve sa position.

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

scaleWidth(scaleFactor, scaleTypeString, scaleFromString)

Met la largeur de la forme à l’échelle en utilisant un facteur spécifié. Pour des images, vous pouvez indiquer si vous souhaitez mettre la forme à l’échelle par rapport à la taille d’origine ou la taille actuelle. Les formes autres que des images sont toujours mis à l’échelle par rapport à leur hauteur actuelle.

scaleWidth(scaleFactor: number, scaleTypeString: "CurrentSize" | "OriginalSize", scaleFromString?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;

Paramètres

scaleFactor

number

Indique le rapport de la largeur de la forme redimensionnée sur sa largeur actuelle ou originale.

scaleTypeString

"CurrentSize" | "OriginalSize"

Spécifie si la forme est mise à l’échelle par rapport à sa taille d’origine ou actuelle. L’option de mise à l’échelle de taille d’origine fonctionne uniquement pour les images.

scaleFromString

"ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"

Facultatif. Spécifie la partie de la forme qui conserve sa position lorsque le forme est mise à l'échelle. S’il est omis, il indique que le coin supérieur gauche de la forme conserve sa position.

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

select(selectMultipleShapes)

Sélectionne la forme.

select(selectMultipleShapes?: boolean): void;

Paramètres

selectMultipleShapes

boolean

Facultatif. Indique s’il faut sélectionner plusieurs formes flottantes. La valeur par défaut est false.

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties

Word.Interfaces.ShapeUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options

OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.Shape): void;

Paramètres

properties

Word.Shape

Retours

void

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.Shape est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.ShapeDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.ShapeData;

Retours

Word.Interfaces.ShapeData

track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.Shape;

Retours

Word.Shape

untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

untrack(): Word.Shape;

Retours

Word.Shape