Word.Interfaces.ShapeLoadOptions interface
Representa una forma en el encabezado, pie de página o cuerpo del documento. Actualmente, solo se admiten las siguientes formas: cuadros de texto, formas geométricas, grupos, imágenes y lienzos.
Propiedades
| $all | Al especificar |
| allow |
Especifica si una forma determinada se puede superponer a otras formas. |
| alt |
Especifica una cadena que representa el texto alternativo asociado a la forma. |
| body | Obtiene el |
| canvas | Obtiene el lienzo asociado a la forma. Se devolverá un objeto con su |
| fill | Devuelve el formato de relleno de la forma. |
| geometric |
Especifica el tipo de forma geométrica de la forma. Será null si no es una forma geométrica. |
| height | Especifica la altura, en puntos, de la forma. |
| height |
Especifica el porcentaje de alto de la forma con respecto al tamaño vertical relativo (es decir, la |
| id | Obtiene un entero que representa el identificador de forma. |
| is |
Compruebe si esta forma es un elemento secundario de una forma de grupo o una forma de lienzo. |
| left | Especifica la distancia, en puntos, desde el lado izquierdo de la forma hasta la posición horizontal relativa (es decir, la |
| left |
Especifica la posición izquierda relativa como un porcentaje del lado izquierdo de la forma a la posición horizontal relativa (es decir, la |
| lock |
Especifica si la relación de aspecto de esta forma está bloqueada. |
| name | Especifica el nombre de la forma. |
| parent |
Obtiene la forma de lienzo principal de nivel superior de esta forma secundaria. Será null si no es una forma secundaria de un lienzo. |
| parent |
Obtiene la forma de grupo principal de nivel superior de esta forma secundaria. Será null si no es una forma secundaria de un grupo. |
| relative |
Especifica la posición horizontal relativa de la forma. Para una forma incorporada, no se puede establecer. Para obtener más información, vea Word. RelativeHorizontalPosition. |
| relative |
Especifica el tamaño horizontal relativo de la forma. Usar con la |
| relative |
Especifica la posición vertical relativa de la forma. Para una forma incorporada, no se puede establecer. Para obtener más información, vea Word. RelativeVerticalPosition. |
| relative |
Especifica el tamaño vertical relativo de la forma. Usar con la |
| rotation | Especifica el giro, en grados, de la forma. No se aplica a la forma de lienzo. |
| shape |
Obtiene el grupo de formas asociado a la forma. Se devolverá un objeto con su |
| text |
Obtiene el |
| text |
Devuelve el formato de ajuste de texto de la forma. |
| top | Especifica la distancia, en puntos, desde el borde superior de la forma hasta la posición vertical relativa (es decir, la |
| top |
Especifica la posición superior relativa como un porcentaje desde el borde superior de la forma hasta la posición vertical relativa (es decir, la |
| type | Obtiene el tipo de forma. Actualmente, solo se admiten las siguientes formas: 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 | Especifica el ancho, en puntos, de la forma. |
| width |
Especifica el porcentaje de ancho de forma con respecto al tamaño horizontal relativo (es decir, la |
Detalles de las propiedades
$all
Al especificar $all las opciones de carga, se cargan todas las propiedades escalares (como Range.address) pero no las propiedades de navegación (como Range.format.fill.color).
$all?: boolean;Valor de propiedad
boolean
allowOverlap
Especifica si una forma determinada se puede superponer a otras formas.
allowOverlap?: boolean;Valor de propiedad
boolean
Comentarios
altTextDescription
Especifica una cadena que representa el texto alternativo asociado a la forma.
altTextDescription?: boolean;Valor de propiedad
boolean
Comentarios
body
Obtiene el Body objeto de la forma. Solo se aplica a cuadros de texto y formas geométricas.
body?: Word.Interfaces.BodyLoadOptions;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 canvases . Para obtener más información, vea los métodos y propiedades *OrNullObject.
canvas?: Word.Interfaces.CanvasLoadOptions;Valor de propiedad
Comentarios
fill
Devuelve el formato de relleno de la forma.
fill?: Word.Interfaces.ShapeFillLoadOptions;Valor de propiedad
Comentarios
geometricShapeType
Especifica el tipo de forma geométrica de la forma. Será null si no es una forma geométrica.
geometricShapeType?: boolean;Valor de propiedad
boolean
Comentarios
height
Especifica la altura, en puntos, de la forma.
height?: boolean;Valor de propiedad
boolean
Comentarios
heightRelative
Especifica el porcentaje de alto de la forma con respecto al tamaño vertical relativo (es decir, la relativeVerticalSize propiedad). Para una forma en línea o secundaria, no se puede establecer.
heightRelative?: boolean;Valor de propiedad
boolean
Comentarios
id
Obtiene un entero que representa el identificador de forma.
id?: boolean;Valor de propiedad
boolean
Comentarios
isChild
Compruebe si esta forma es un elemento secundario de una forma de grupo o una forma de lienzo.
isChild?: boolean;Valor de propiedad
boolean
Comentarios
left
Especifica la distancia, en puntos, desde el lado izquierdo de la forma hasta la posición horizontal relativa (es decir, la relativeHorizontalPosition propiedad). Para una forma en línea, devolverá 0 y no se puede establecer. Para una forma secundaria de un lienzo o grupo, es relativa a la esquina superior izquierda.
left?: boolean;Valor de propiedad
boolean
Comentarios
leftRelative
Especifica la posición izquierda relativa como un porcentaje del lado izquierdo de la forma a la posición horizontal relativa (es decir, la relativeHorizontalalPosition propiedad). Para una forma en línea o secundaria, devolverá 0 y no se puede establecer.
leftRelative?: boolean;Valor de propiedad
boolean
Comentarios
lockAspectRatio
Especifica si la relación de aspecto de esta forma está bloqueada.
lockAspectRatio?: boolean;Valor de propiedad
boolean
Comentarios
name
Especifica el nombre de la forma.
name?: boolean;Valor de propiedad
boolean
Comentarios
parentCanvas
Obtiene la forma de lienzo principal de nivel superior de esta forma secundaria. Será null si no es una forma secundaria de un lienzo.
parentCanvas?: Word.Interfaces.ShapeLoadOptions;Valor de propiedad
Comentarios
parentGroup
Obtiene la forma de grupo principal de nivel superior de esta forma secundaria. Será null si no es una forma secundaria de un grupo.
parentGroup?: Word.Interfaces.ShapeLoadOptions;Valor de propiedad
Comentarios
relativeHorizontalPosition
Especifica la posición horizontal relativa de la forma. Para una forma incorporada, no se puede establecer. Para obtener más información, vea Word. RelativeHorizontalPosition.
relativeHorizontalPosition?: boolean;Valor de propiedad
boolean
Comentarios
relativeHorizontalSize
Especifica el tamaño horizontal relativo de la forma. Usar con la widthRelative propiedad. Para una forma en línea o secundaria, no se puede establecer.
relativeHorizontalSize?: boolean;Valor de propiedad
boolean
Comentarios
relativeVerticalPosition
Especifica la posición vertical relativa de la forma. Para una forma incorporada, no se puede establecer. Para obtener más información, vea Word. RelativeVerticalPosition.
relativeVerticalPosition?: boolean;Valor de propiedad
boolean
Comentarios
relativeVerticalSize
Especifica el tamaño vertical relativo de la forma. Usar con la heightRelative propiedad. Para una forma en línea o secundaria, no se puede establecer.
relativeVerticalSize?: boolean;Valor de propiedad
boolean
Comentarios
rotation
Especifica el giro, en grados, de la forma. No se aplica a la forma de lienzo.
rotation?: boolean;Valor de propiedad
boolean
Comentarios
shapeGroup
Obtiene el grupo de formas asociado a la forma. Se devolverá un objeto con su isNullObject propiedad establecida en true si el tipo de forma no groupShapees . Para obtener más información, vea los métodos y propiedades *OrNullObject.
shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;Valor de propiedad
Comentarios
textFrame
Obtiene el TextFrame objeto de la forma.
textFrame?: Word.Interfaces.TextFrameLoadOptions;Valor de propiedad
Comentarios
textWrap
Devuelve el formato de ajuste de texto de la forma.
textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;Valor de propiedad
Comentarios
top
Especifica la distancia, en puntos, desde el borde superior de la forma hasta la posición vertical relativa (es decir, la relativeVerticalPosition propiedad). Para una forma en línea, devolverá 0 y no se puede establecer. Para una forma secundaria de un lienzo o grupo, es relativa a la esquina superior izquierda.
top?: boolean;Valor de propiedad
boolean
Comentarios
topRelative
Especifica la posición superior relativa como un porcentaje desde el borde superior de la forma hasta la posición vertical relativa (es decir, la relativeVerticalPosition propiedad). Para una forma en línea o secundaria, devolverá 0 y no se puede establecer.
topRelative?: boolean;Valor de propiedad
boolean
Comentarios
type
Obtiene el tipo de forma. Actualmente, solo se admiten las siguientes formas: cuadros de texto, formas geométricas, grupos, imágenes y lienzos.
type?: boolean;Valor de propiedad
boolean
Comentarios
visible
Especifica si la forma está visible. No se aplica a las formas insertadas.
visible?: boolean;Valor de propiedad
boolean
Comentarios
width
Especifica el ancho, en puntos, de la forma.
width?: boolean;Valor de propiedad
boolean
Comentarios
widthRelative
Especifica el porcentaje de ancho de forma con respecto al tamaño horizontal relativo (es decir, la relativeHorizontalSize propiedad). Para una forma en línea o secundaria, no se puede establecer.
widthRelative?: boolean;Valor de propiedad
boolean