Word.Interfaces.ShapeData interface
Interfaz que describe los datos devueltos mediante una llamada a shape.toJSON()
.
Propiedades
allow |
Especifica si una forma determinada puede superponerse a otras formas. |
alt |
Especifica una cadena que representa el texto alternativo asociado a la forma. |
body | Representa el objeto de cuerpo de la forma. Solo se aplica a cuadros de texto y formas geométricas. |
canvas | Obtiene el lienzo asociado a la forma. Se devolverá un objeto con su |
fill | Devuelve el formato de relleno de la forma. |
geometric |
Tipo de forma geométrica de la forma. Será null si no es una forma geométrica. |
height | Alto, en puntos, de la forma. |
height |
El porcentaje de altura de la forma en tamaño relativo vertical, consulte Word. RelativeSize. Para una forma insertada o secundaria, no se puede establecer. |
id | Obtiene un entero que representa el identificador de forma. |
is |
Compruebe si esta forma es secundaria de una forma de grupo o de lienzo. |
left | La distancia, en puntos, desde el lado izquierdo de la forma hasta la posición relativa horizontal, vea Word. RelativeHorizontalPosition. Para una forma insertada, devolverá 0 y no se puede establecer. Para una forma secundaria en un lienzo o grupo, es relativa a la esquina superior izquierda. |
left |
La posición izquierda relativa como porcentaje desde el lado izquierdo de la forma hasta la posición relativa horizontal, vea Word. RelativeHorizontalPosition. Para una forma insertada o secundaria, devolverá 0 y no se puede establecer. |
lock |
Especifica si la relación de aspecto de esta forma está bloqueada. |
name | Nombre de la forma. |
parent |
Obtiene la forma del lienzo primario de nivel superior de esta forma secundaria. Será null si no es una forma secundaria de un lienzo. |
parent |
Obtiene la forma de grupo primario de nivel superior de esta forma secundaria. Será null si no es una forma secundaria de un grupo. |
relative |
Posición horizontal relativa de la forma. En el caso de una forma insertada, no se puede establecer. Para obtener más información, consulte Word. RelativeHorizontalPosition. |
relative |
Tamaño horizontal relativo de la forma. Para una forma insertada o secundaria, no se puede establecer. Para obtener más información, consulte Word. RelativeHorizontalPosition. |
relative |
Posición vertical relativa de la forma. En el caso de una forma insertada, no se puede establecer. Para obtener más información, consulte Word. RelativeVerticalPosition. |
relative |
Tamaño vertical relativo de la forma. Para una forma insertada o secundaria, no se puede establecer. Para obtener más información, consulte Word. RelativeHorizontalPosition. |
rotation | Especifica la rotación, en grados, de la forma. No se aplica a la forma Canvas. |
shape |
Obtiene el grupo de formas asociado a la forma. Un objeto con su |
text |
Obtiene el objeto de marco de texto de la forma. |
text |
Devuelve el formato de ajuste de texto de la forma. |
top | La distancia, en puntos, desde el borde superior de la forma hasta la posición relativa vertical, vea Word. RelativeVerticalPosition. Para una forma insertada, devolverá 0 y no se puede establecer. Para una forma secundaria en un lienzo o grupo, es relativa a la esquina superior izquierda. |
top |
La posición superior relativa como un porcentaje desde el borde superior de la forma hasta la posición relativa vertical, vea Word. RelativeVerticalPosition. Para una forma insertada o secundaria, devolverá 0 y no se puede establecer. |
type | Obtiene el tipo de forma. Actualmente, solo se admiten las formas siguientes: cuadros de texto, formas geométricas, grupos, imágenes y lienzos. |
visible | Especifica si la forma está visible. No se aplica a las formas insertadas. |
width | Ancho, en puntos, de la forma. |
width |
El porcentaje de ancho de forma con respecto al tamaño relativo horizontal, consulte Word. RelativeSize. Para una forma insertada o secundaria, no se puede establecer. |
Detalles de las propiedades
allowOverlap
Especifica si una forma determinada puede superponerse a otras formas.
allowOverlap?: boolean;
Valor de propiedad
boolean
Comentarios
altTextDescription
Especifica una cadena que representa el texto alternativo asociado a la forma.
altTextDescription?: string;
Valor de propiedad
string
Comentarios
body
Representa el objeto de cuerpo de la forma. Solo se aplica a cuadros de texto y formas geométricas.
body?: Word.Interfaces.BodyData;
Valor de propiedad
Comentarios
canvas
Obtiene el lienzo asociado a la forma. Se devolverá un objeto con su isNullObject
propiedad establecida en true
si el tipo de forma no es "Canvas". Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
canvas?: Word.Interfaces.CanvasData;
Valor de propiedad
Comentarios
fill
Devuelve el formato de relleno de la forma.
fill?: Word.Interfaces.ShapeFillData;
Valor de propiedad
Comentarios
geometricShapeType
Tipo de forma geométrica de la forma. Será null si no es una forma geométrica.
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";
Valor de propiedad
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"
Comentarios
height
Alto, en puntos, de la forma.
height?: number;
Valor de propiedad
number
Comentarios
heightRelative
El porcentaje de altura de la forma en tamaño relativo vertical, consulte Word. RelativeSize. Para una forma insertada o secundaria, no se puede establecer.
heightRelative?: number;
Valor de propiedad
number
Comentarios
id
Obtiene un entero que representa el identificador de forma.
id?: number;
Valor de propiedad
number
Comentarios
isChild
Compruebe si esta forma es secundaria de una forma de grupo o de lienzo.
isChild?: boolean;
Valor de propiedad
boolean
Comentarios
left
La distancia, en puntos, desde el lado izquierdo de la forma hasta la posición relativa horizontal, vea Word. RelativeHorizontalPosition. Para una forma insertada, devolverá 0 y no se puede establecer. Para una forma secundaria en un lienzo o grupo, es relativa a la esquina superior izquierda.
left?: number;
Valor de propiedad
number
Comentarios
leftRelative
La posición izquierda relativa como porcentaje desde el lado izquierdo de la forma hasta la posición relativa horizontal, vea Word. RelativeHorizontalPosition. Para una forma insertada o secundaria, devolverá 0 y no se puede establecer.
leftRelative?: number;
Valor de propiedad
number
Comentarios
lockAspectRatio
Especifica si la relación de aspecto de esta forma está bloqueada.
lockAspectRatio?: boolean;
Valor de propiedad
boolean
Comentarios
name
Nombre de la forma.
name?: string;
Valor de propiedad
string
Comentarios
parentCanvas
Obtiene la forma del lienzo primario de nivel superior de esta forma secundaria. Será null si no es una forma secundaria de un lienzo.
parentCanvas?: Word.Interfaces.ShapeData;
Valor de propiedad
Comentarios
parentGroup
Obtiene la forma de grupo primario de nivel superior de esta forma secundaria. Será null si no es una forma secundaria de un grupo.
parentGroup?: Word.Interfaces.ShapeData;
Valor de propiedad
Comentarios
relativeHorizontalPosition
Posición horizontal relativa de la forma. En el caso de una forma insertada, no se puede establecer. Para obtener más información, consulte Word. RelativeHorizontalPosition.
relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
Valor de propiedad
Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"
Comentarios
relativeHorizontalSize
Tamaño horizontal relativo de la forma. Para una forma insertada o secundaria, no se puede establecer. Para obtener más información, consulte Word. RelativeHorizontalPosition.
relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
Valor de propiedad
Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
Comentarios
relativeVerticalPosition
Posición vertical relativa de la forma. En el caso de una forma insertada, no se puede establecer. Para obtener más información, consulte Word. RelativeVerticalPosition.
relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
Valor de propiedad
Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
Comentarios
relativeVerticalSize
Tamaño vertical relativo de la forma. Para una forma insertada o secundaria, no se puede establecer. Para obtener más información, consulte Word. RelativeHorizontalPosition.
relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
Valor de propiedad
Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
Comentarios
rotation
Especifica la rotación, en grados, de la forma. No se aplica a la forma Canvas.
rotation?: number;
Valor de propiedad
number
Comentarios
shapeGroup
Obtiene el grupo de formas asociado a la forma. Un objeto con su isNullObject
propiedad establecida en true
se devolverá si el tipo de forma no es "GroupShape". Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
shapeGroup?: Word.Interfaces.ShapeGroupData;
Valor de propiedad
Comentarios
textFrame
Obtiene el objeto de marco de texto de la forma.
textFrame?: Word.Interfaces.TextFrameData;
Valor de propiedad
Comentarios
textWrap
Devuelve el formato de ajuste de texto de la forma.
textWrap?: Word.Interfaces.ShapeTextWrapData;
Valor de propiedad
Comentarios
top
La distancia, en puntos, desde el borde superior de la forma hasta la posición relativa vertical, vea Word. RelativeVerticalPosition. Para una forma insertada, devolverá 0 y no se puede establecer. Para una forma secundaria en un lienzo o grupo, es relativa a la esquina superior izquierda.
top?: number;
Valor de propiedad
number
Comentarios
topRelative
La posición superior relativa como un porcentaje desde el borde superior de la forma hasta la posición relativa vertical, vea Word. RelativeVerticalPosition. Para una forma insertada o secundaria, devolverá 0 y no se puede establecer.
topRelative?: number;
Valor de propiedad
number
Comentarios
type
Obtiene el tipo de forma. Actualmente, solo se admiten las formas siguientes: cuadros de texto, formas geométricas, grupos, imágenes y lienzos.
type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas";
Valor de propiedad
Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"
Comentarios
visible
Especifica si la forma está visible. No se aplica a las formas insertadas.
visible?: boolean;
Valor de propiedad
boolean
Comentarios
width
Ancho, en puntos, de la forma.
width?: number;
Valor de propiedad
number
Comentarios
widthRelative
El porcentaje de ancho de forma con respecto al tamaño relativo horizontal, consulte Word. RelativeSize. Para una forma insertada o secundaria, no se puede establecer.
widthRelative?: number;
Valor de propiedad
number