Word.Interfaces.ShapeUpdateData interface

Interface permettant de mettre à jour les données sur l’objet Shape , à utiliser dans shape.set({ ... }).

Remarques

Utilisateur

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

Obtient 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.

fill

Renvoie la mise en forme de remplissage de la forme.

geometricShapeType

Spécifie le type de forme géométrique de la forme. Elle sera null si n’est pas une forme géométrique.

height

Spécifie la hauteur, en points, de la forme.

heightRelative

Spécifie le pourcentage de hauteur de la forme par rapport à la taille verticale relative (autrement dit, la relativeVerticalSize propriété ). Pour une forme inline ou enfant, elle ne peut pas être définie.

left

Spécifie la distance, en points, entre le côté gauche de la forme et la position horizontale relative (autrement dit, la relativeHorizontalPosition propriété ). 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

Spécifie la position gauche relative sous la forme d’un pourcentage à partir du côté gauche de la forme jusqu’à la position horizontale relative (autrement dit, la relativeHorizontalalPosition propriété ). 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

Spécifie le 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

Spécifie la 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

Spécifie la taille horizontale relative de la forme. Utilisez avec la widthRelative propriété . Pour une forme inline ou enfant, elle ne peut pas être définie.

relativeVerticalPosition

Spécifie la 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

Spécifie la taille verticale relative de la forme. Utilisez avec la heightRelative propriété . Pour une forme inline ou enfant, elle ne peut pas être définie.

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 TextFrame de la forme.

textWrap

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

top

Spécifie la distance, en points, entre le bord supérieur de la forme et la position verticale relative (autrement dit, la relativeVerticalPosition propriété ). 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

Spécifie la position supérieure relative sous la forme d’un pourcentage entre le bord supérieur de la forme et la position verticale relative (autrement dit, la relativeVerticalPosition propriété ). Pour une forme inline ou enfant, elle retourne 0 et ne peut pas être définie.

visible

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

width

Spécifie la largeur, en points, de la forme.

widthRelative

Spécifie le pourcentage de largeur de la forme par rapport à la taille horizontale relative (autrement dit, la relativeHorizontalSize propriété ). Pour une forme inline ou enfant, elle ne peut pas être définie.

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

Obtient l’objet Body de la forme. S’applique uniquement aux zones de texte et aux formes géométriques.

body?: Word.Interfaces.BodyUpdateData;

Valeur de propriété

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.

canvas?: Word.Interfaces.CanvasUpdateData;

Valeur de propriété

Remarques

Ensemble d’API : WordApiDesktop 1.2

fill

Renvoie la mise en forme de remplissage de la forme.

fill?: Word.Interfaces.ShapeFillUpdateData;

Valeur de propriété

Remarques

Ensemble d’API : WordApiDesktop 1.2

geometricShapeType

Spécifie le 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

Spécifie la hauteur, en points, de la forme.

height?: number;

Valeur de propriété

number

Remarques

Ensemble d’API : WordApiDesktop 1.2

heightRelative

Spécifie le pourcentage de hauteur de la forme par rapport à la taille verticale relative (autrement dit, la relativeVerticalSize propriété ). 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

left

Spécifie la distance, en points, entre le côté gauche de la forme et la position horizontale relative (autrement dit, la relativeHorizontalPosition propriété ). 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

Spécifie la position gauche relative sous la forme d’un pourcentage à partir du côté gauche de la forme jusqu’à la position horizontale relative (autrement dit, la relativeHorizontalalPosition propriété ). 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

Spécifie le 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.

parentCanvas?: Word.Interfaces.ShapeUpdateData;

Valeur de propriété

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.

parentGroup?: Word.Interfaces.ShapeUpdateData;

Valeur de propriété

Remarques

Ensemble d’API : WordApiDesktop 1.2

relativeHorizontalPosition

Spécifie la 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

Spécifie la taille horizontale relative de la forme. Utilisez avec la widthRelative propriété . Pour une forme inline ou enfant, elle ne peut pas être définie.

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

Spécifie la 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

Spécifie la taille verticale relative de la forme. Utilisez avec la heightRelative propriété . Pour une forme inline ou enfant, elle ne peut pas être définie.

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.

shapeGroup?: Word.Interfaces.ShapeGroupUpdateData;

Valeur de propriété

Remarques

Ensemble d’API : WordApiDesktop 1.2

textFrame

Obtient l’objet TextFrame de la forme.

textFrame?: Word.Interfaces.TextFrameUpdateData;

Valeur de propriété

Remarques

Ensemble d’API : WordApiDesktop 1.2

textWrap

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

textWrap?: Word.Interfaces.ShapeTextWrapUpdateData;

Valeur de propriété

Remarques

Ensemble d’API : WordApiDesktop 1.2

top

Spécifie la distance, en points, entre le bord supérieur de la forme et la position verticale relative (autrement dit, la relativeVerticalPosition propriété ). 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

Spécifie la position supérieure relative sous la forme d’un pourcentage entre le bord supérieur de la forme et la position verticale relative (autrement dit, la relativeVerticalPosition propriété ). 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

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

Spécifie la largeur, en points, de la forme.

width?: number;

Valeur de propriété

number

Remarques

Ensemble d’API : WordApiDesktop 1.2

widthRelative

Spécifie le pourcentage de largeur de la forme par rapport à la taille horizontale relative (autrement dit, la relativeHorizontalSize propriété ). 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