Word.Interfaces.ShapeCollectionLoadOptions interface
Contiene una colección de Word. Objetos Shape. Actualmente, solo se admiten las siguientes formas: cuadros de texto, formas geométricas, grupos, imágenes y lienzos.
Propiedades
| $all | Al especificar |
| allow |
Para CADA ELEMENTO de la colección: Especifica si una forma determinada se puede superponer a otras formas. |
| alt |
Para CADA ELEMENTO de la colección: Especifica una cadena que representa el texto alternativo asociado a la forma. |
| body | Para CADA ARTÍCULO de la colección: Obtiene el |
| canvas | Para CADA ARTÍCULO de la colección: Obtiene el lienzo asociado a la forma. Se devolverá un objeto con su |
| fill | Para CADA ELEMENTO de la colección: Devuelve el formato de relleno de la forma. |
| geometric |
Para CADA ARTÍCULO de la colección: Especifica el tipo de forma geométrica de la forma. Será null si no es una forma geométrica. |
| height | Para CADA ARTÍCULO de la colección: Especifica la altura, en puntos, de la forma. |
| height |
Para CADA ELEMENTO de la colección: Especifica el porcentaje de alto de la forma con respecto al tamaño vertical relativo (es decir, la |
| id | Para CADA ELEMENTO de la colección: Obtiene un entero que representa el identificador de forma. |
| is |
Para CADA ARTÍCULO de la colección: Compruebe si esta forma es un elemento secundario de una forma de grupo o una forma de lienzo. |
| left | Para CADA ELEMENTO de la colección: Especifica la distancia, en puntos, desde el lado izquierdo de la forma hasta la posición horizontal relativa (es decir, la |
| left |
Para CADA ELEMENTO de la colección: Especifica la posición izquierda relativa como un porcentaje desde el lado izquierdo de la forma hasta la posición horizontal relativa (es decir, la |
| lock |
Para CADA ELEMENTO de la colección: Especifica si la relación de aspecto de esta forma está bloqueada. |
| name | Para CADA ELEMENTO de la colección: Especifica el nombre de la forma. |
| parent |
Para CADA ARTÍCULO de la colección: 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 |
Para CADA ELEMENTO de la colección: 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 |
Para CADA ELEMENTO de la colección: 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 |
Para CADA ELEMENTO de la colección: Especifica el tamaño horizontal relativo de la forma. Usar con la |
| relative |
Para CADA ELEMENTO de la colección: 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 |
Para CADA ELEMENTO de la colección: Especifica el tamaño vertical relativo de la forma. Usar con la |
| rotation | Para CADA ELEMENTO de la colección: Especifica la rotación, en grados, de la forma. No se aplica a la forma de lienzo. |
| shape |
Para CADA ELEMENTO de la colección: Obtiene el grupo de formas asociado a la forma. Se devolverá un objeto con su |
| text |
Para CADA ARTÍCULO de la colección: Obtiene el |
| text |
Para CADA ELEMENTO de la colección: Devuelve el formato de ajuste de texto de la forma. |
| top | Para CADA ELEMENTO de la colección: Especifica la distancia, en puntos, desde el borde superior de la forma hasta la posición vertical relativa (es decir, la |
| top |
Para CADA ELEMENTO de la colección: 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 | Para CADA ARTÍCULO de la colección: Obtiene el tipo de forma. Actualmente, solo se admiten las siguientes formas: cuadros de texto, formas geométricas, grupos, imágenes y lienzos. |
| visible | Para CADA ELEMENTO de la colección: Especifica si la forma está visible. No se aplica a las formas insertadas. |
| width | Para CADA ELEMENTO de la colección: Especifica el ancho, en puntos, de la forma. |
| width |
Para CADA ELEMENTO de la colección: 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
Para CADA ELEMENTO de la colección: Especifica si una forma determinada se puede superponer a otras formas.
allowOverlap?: boolean;
Valor de propiedad
boolean
Comentarios
altTextDescription
Para CADA ELEMENTO de la colección: Especifica una cadena que representa el texto alternativo asociado a la forma.
altTextDescription?: boolean;
Valor de propiedad
boolean
Comentarios
body
Para CADA ARTÍCULO de la colección: 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
Conjunto de API: WordApiDesktop 1.2
Importante: Si la forma aún no contiene texto, obtener esta propiedad crea una historia de texto en la forma. Esto modifica el documento, lo marca como con cambios no guardados y agrega una entrada a la pila de deshacer. Para determinar si una forma contiene texto sin modificar el documento, obtenga la hasText propiedad de Word. TextFrame en su lugar.
canvas
Para CADA ARTÍCULO de la colección: 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
Para CADA ELEMENTO de la colección: Devuelve el formato de relleno de la forma.
fill?: Word.Interfaces.ShapeFillLoadOptions;
Valor de propiedad
Comentarios
geometricShapeType
Para CADA ARTÍCULO de la colección: 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
Para CADA ARTÍCULO de la colección: Especifica la altura, en puntos, de la forma.
height?: boolean;
Valor de propiedad
boolean
Comentarios
heightRelative
Para CADA ELEMENTO de la colección: 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
Para CADA ELEMENTO de la colección: Obtiene un entero que representa el identificador de forma.
id?: boolean;
Valor de propiedad
boolean
Comentarios
isChild
Para CADA ARTÍCULO de la colección: 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
Para CADA ELEMENTO de la colección: 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
Para CADA ELEMENTO de la colección: Especifica la posición izquierda relativa como un porcentaje desde el lado izquierdo de la forma hasta 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
Para CADA ELEMENTO de la colección: Especifica si la relación de aspecto de esta forma está bloqueada.
lockAspectRatio?: boolean;
Valor de propiedad
boolean
Comentarios
name
Para CADA ELEMENTO de la colección: Especifica el nombre de la forma.
name?: boolean;
Valor de propiedad
boolean
Comentarios
parentCanvas
Para CADA ARTÍCULO de la colección: 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
Para CADA ELEMENTO de la colección: 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
Para CADA ELEMENTO de la colección: 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
Para CADA ELEMENTO de la colección: 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
Para CADA ELEMENTO de la colección: 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
Para CADA ELEMENTO de la colección: 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
Para CADA ELEMENTO de la colección: Especifica la rotación, en grados, de la forma. No se aplica a la forma de lienzo.
rotation?: boolean;
Valor de propiedad
boolean
Comentarios
shapeGroup
Para CADA ELEMENTO de la colección: 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
Para CADA ARTÍCULO de la colección: Obtiene el TextFrame objeto de la forma.
textFrame?: Word.Interfaces.TextFrameLoadOptions;
Valor de propiedad
Comentarios
textWrap
Para CADA ELEMENTO de la colección: Devuelve el formato de ajuste de texto de la forma.
textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;
Valor de propiedad
Comentarios
top
Para CADA ELEMENTO de la colección: 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
Para CADA ELEMENTO de la colección: 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
Para CADA ARTÍCULO de la colección: 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
Para CADA ELEMENTO de la colección: Especifica si la forma está visible. No se aplica a las formas insertadas.
visible?: boolean;
Valor de propiedad
boolean
Comentarios
width
Para CADA ELEMENTO de la colección: Especifica el ancho, en puntos, de la forma.
width?: boolean;
Valor de propiedad
boolean
Comentarios
widthRelative
Para CADA ELEMENTO de la colección: 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