Word.Shape class
Representa una forma en el encabezado, pie de página o cuerpo del documento. Actualmente, solo se admiten las formas siguientes: cuadros de texto, formas geométricas, grupos, imágenes y lienzos.
- Extends
Comentarios
[ Conjunto de API: WordApiDesktop 1.2 ]
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 |
context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
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. |
Métodos
delete() | Elimina la forma y su contenido. |
load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
move |
Mueve la forma horizontalmente por el número de puntos. |
move |
Mueve la forma verticalmente por el número de puntos. |
scale |
Cambia el alto de la forma en un factor especificado. Para imágenes, puede indicar si desea aplicar una escala a la forma respecto al tamaño original o al actual. El tamaño de las formas distintas de imágenes siempre se ajusta en relación con su alto actual. |
scale |
Cambia el alto de la forma en un factor especificado. Para imágenes, puede indicar si desea aplicar una escala a la forma respecto al tamaño original o al actual. El tamaño de las formas distintas de imágenes siempre se ajusta en relación con su alto actual. |
scale |
Cambia el ancho de la forma en un factor especificado. Para imágenes, puede indicar si desea aplicar una escala a la forma respecto al tamaño original o al actual. El tamaño de las formas distintas de imágenes siempre se ajusta en relación con su alto actual. |
scale |
Cambia el ancho de la forma en un factor especificado. Para imágenes, puede indicar si desea aplicar una escala a la forma respecto al tamaño original o al actual. El tamaño de las formas distintas de imágenes siempre se ajusta en relación con su alto actual. |
select(select |
Selecciona la forma. |
set(properties, options) | Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo. |
set(properties) | Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente. |
toJSON() | Invalida el método JavaScript |
track() | Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre |
untrack() | Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar |
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.
readonly body: Word.Body;
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).
readonly canvas: Word.Canvas;
Valor de propiedad
Comentarios
context
Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
context: RequestContext;
Valor de propiedad
fill
Devuelve el formato de relleno de la forma.
readonly fill: Word.ShapeFill;
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.
readonly id: number;
Valor de propiedad
number
Comentarios
isChild
Compruebe si esta forma es secundaria de una forma de grupo o de lienzo.
readonly 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.
readonly parentCanvas: Word.Shape;
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.
readonly parentGroup: Word.Shape;
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).
readonly shapeGroup: Word.ShapeGroup;
Valor de propiedad
Comentarios
textFrame
Obtiene el objeto de marco de texto de la forma.
readonly textFrame: Word.TextFrame;
Valor de propiedad
Comentarios
textWrap
Devuelve el formato de ajuste de texto de la forma.
readonly textWrap: Word.ShapeTextWrap;
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.
readonly 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
Comentarios
Detalles del método
delete()
Elimina la forma y su contenido.
delete(): void;
Devoluciones
void
Comentarios
load(options)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync()
antes de leer las propiedades.
load(options?: Word.Interfaces.ShapeLoadOptions): Word.Shape;
Parámetros
- options
- Word.Interfaces.ShapeLoadOptions
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync()
antes de leer las propiedades.
load(propertyNames?: string | string[]): Word.Shape;
Parámetros
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
Devoluciones
load(propertyNamesAndPaths)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync()
antes de leer las propiedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.Shape;
Parámetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand
es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
moveHorizontally(distance)
Mueve la forma horizontalmente por el número de puntos.
moveHorizontally(distance: number): void;
Parámetros
- distance
-
number
Obligatorio. Especifica cuánto se moverá la forma horizontalmente, en puntos. Use un valor positivo para mover la forma a la derecha. Use un valor negativo para mover la forma a la izquierda.
Devoluciones
void
Comentarios
moveVertically(distance)
Mueve la forma verticalmente por el número de puntos.
moveVertically(distance: number): void;
Parámetros
- distance
-
number
Obligatorio. Especifica cuánto se va a mover la forma verticalmente en puntos. Use un valor positivo para mover la forma hacia arriba. Use un valor negativo para bajar la forma.
Devoluciones
void
Comentarios
scaleHeight(scaleFactor, scaleType, scaleFrom)
Cambia el alto de la forma en un factor especificado. Para imágenes, puede indicar si desea aplicar una escala a la forma respecto al tamaño original o al actual. El tamaño de las formas distintas de imágenes siempre se ajusta en relación con su alto actual.
scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void;
Parámetros
- scaleFactor
-
number
Especifica la relación entre el alto de la forma después de cambiar su tamaño y el alto original o actual.
- scaleType
- Word.ShapeScaleType
Especifica si la forma se escala con respecto a su tamaño original o actual. La opción de escalado de tamaño original solo funciona para imágenes.
- scaleFrom
- Word.ShapeScaleFrom
Opcional. Especifica qué parte de la forma mantiene su posición cuando se ajusta el tamaño de la forma. Si se omite, representa que la esquina superior izquierda de la forma conserva su posición.
Devoluciones
void
Comentarios
scaleHeight(scaleFactor, scaleTypeString, scaleFromString)
Cambia el alto de la forma en un factor especificado. Para imágenes, puede indicar si desea aplicar una escala a la forma respecto al tamaño original o al actual. El tamaño de las formas distintas de imágenes siempre se ajusta en relación con su alto actual.
scaleHeight(scaleFactor: number, scaleTypeString: "CurrentSize" | "OriginalSize", scaleFromString?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;
Parámetros
- scaleFactor
-
number
Especifica la relación entre el alto de la forma después de cambiar su tamaño y el alto original o actual.
- scaleTypeString
-
"CurrentSize" | "OriginalSize"
Especifica si la forma se escala con respecto a su tamaño original o actual. La opción de escalado de tamaño original solo funciona para imágenes.
- scaleFromString
-
"ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"
Opcional. Especifica qué parte de la forma mantiene su posición cuando se ajusta el tamaño de la forma. Si se omite, representa que la esquina superior izquierda de la forma conserva su posición.
Devoluciones
void
Comentarios
scaleWidth(scaleFactor, scaleType, scaleFrom)
Cambia el ancho de la forma en un factor especificado. Para imágenes, puede indicar si desea aplicar una escala a la forma respecto al tamaño original o al actual. El tamaño de las formas distintas de imágenes siempre se ajusta en relación con su alto actual.
scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void;
Parámetros
- scaleFactor
-
number
Especifica la relación entre el ancho de la forma después de cambiar su tamaño y el ancho original o actual.
- scaleType
- Word.ShapeScaleType
Especifica si la forma se escala con respecto a su tamaño original o actual. La opción de escalado de tamaño original solo funciona para imágenes.
- scaleFrom
- Word.ShapeScaleFrom
Opcional. Especifica qué parte de la forma mantiene su posición cuando se ajusta el tamaño de la forma. Si se omite, representa que la esquina superior izquierda de la forma conserva su posición.
Devoluciones
void
Comentarios
scaleWidth(scaleFactor, scaleTypeString, scaleFromString)
Cambia el ancho de la forma en un factor especificado. Para imágenes, puede indicar si desea aplicar una escala a la forma respecto al tamaño original o al actual. El tamaño de las formas distintas de imágenes siempre se ajusta en relación con su alto actual.
scaleWidth(scaleFactor: number, scaleTypeString: "CurrentSize" | "OriginalSize", scaleFromString?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;
Parámetros
- scaleFactor
-
number
Especifica la relación entre el ancho de la forma después de cambiar su tamaño y el ancho original o actual.
- scaleTypeString
-
"CurrentSize" | "OriginalSize"
Especifica si la forma se escala con respecto a su tamaño original o actual. La opción de escalado de tamaño original solo funciona para imágenes.
- scaleFromString
-
"ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"
Opcional. Especifica qué parte de la forma mantiene su posición cuando se ajusta el tamaño de la forma. Si se omite, representa que la esquina superior izquierda de la forma conserva su posición.
Devoluciones
void
Comentarios
select(selectMultipleShapes)
Selecciona la forma.
select(selectMultipleShapes?: boolean): void;
Parámetros
- selectMultipleShapes
-
boolean
Opcional. Si se seleccionan varias formas flotantes. El valor predeterminado es False.
Devoluciones
void
Comentarios
set(properties, options)
Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parámetros
- properties
- Word.Interfaces.ShapeUpdateData
Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.
- options
- OfficeExtension.UpdateOptions
Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.
Devoluciones
void
set(properties)
Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
set(properties: Word.Shape): void;
Parámetros
- properties
- Word.Shape
Devoluciones
void
toJSON()
Invalida el método JavaScript toJSON()
para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify()
. (JSON.stringify
a su vez, llama al toJSON
método del objeto que se le pasa). Mientras que el objeto original Word.Shape
es un objeto de API, el toJSON
método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.ShapeData
) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Word.Interfaces.ShapeData;
Devoluciones
track()
Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync
llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.
track(): Word.Shape;
Devoluciones
untrack()
Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync()
a antes de que la versión de memoria surta efecto.
untrack(): Word.Shape;