Excel.Interfaces.GroupShapeCollectionLoadOptions interface

Paquete:

excel

Representa la colección de formas dentro de un grupo de formas.

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Propiedades

$all	Si se $all especifica para LoadOptions, se cargan todas las propiedades escalares (por ejemplo, Range.address) pero no las propiedades de navegación (por ejemplo, Range.format.fill.color).
altTextDescription	Para CADA ELEMENTO de la colección: especifica el texto de descripción alternativo de un Shape objeto.
altTextTitle	Para CADA ELEMENTO de la colección: especifica el texto de título alternativo de un Shape objeto.
connectionSiteCount	Para CADA ELEMENTO de la colección: devuelve el número de sitios de conexión de esta forma.
displayName	Para CADA ELEMENTO de la colección: obtiene el nombre para mostrar de la forma. Una forma recién creada tiene un nombre generado que está localizado y puede que no coincida con su name. En este escenario, puede usar esta API para obtener el nombre que se muestra en la interfaz de usuario.
fill	Para CADA ELEMENTO de la colección: devuelve el formato de relleno de esta forma.
geometricShape	Para CADA ELEMENTO de la colección: devuelve la forma geométrica asociada a la forma. Produce un error si el tipo de forma no es "GeometricShape".
geometricShapeType	Para CADA ELEMENTO de la colección: especifica el tipo de forma geométrica de esta forma geométrica. Vea Excel.GeometricShapeType para más información. Devuelve null si el tipo de forma no es "GeometricShape".
group	Para CADA ELEMENTO de la colección: devuelve el grupo de formas asociado a la forma. Produce un error si el tipo de forma no es "GroupShape".
height	Para CADA ELEMENTO de la colección: especifica el alto, en puntos, de la forma. Produce una InvalidArgument excepción cuando se establece con un valor negativo o cero como entrada.
id	Para CADA ELEMENTO de la colección: especifica el identificador de forma.
image	Para CADA ELEMENTO de la colección: devuelve la imagen asociada a la forma. Produce un error si el tipo de forma no es "Image".
left	Para CADA ELEMENTO de la colección: la distancia, en puntos, desde el lado izquierdo de la forma hasta el lado izquierdo de la hoja de cálculo. Produce una InvalidArgument excepción cuando se establece con un valor negativo como entrada.
level	Para CADA ELEMENTO de la colección: especifica el nivel de la forma especificada. Por ejemplo, un nivel de 0 significa que la forma no es parte de ningún grupo, un nivel de 1 significa que la forma es parte de un grupo del nivel superior y un nivel 2 significa que la forma es parte de un grupo secundario del nivel superior.
line	Para CADA ELEMENTO de la colección: devuelve la línea asociada a la forma. Produce un error si el tipo de forma no es "Line".
lineFormat	Para CADA ELEMENTO de la colección: devuelve el formato de línea de esta forma.
lockAspectRatio	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.
parentGroup	Para CADA ELEMENTO de la colección: especifica el grupo primario de esta forma.
placement	Para CADA ELEMENTO de la colección: representa cómo se adjunta el objeto a las celdas debajo de él.
rotation	Para CADA ELEMENTO de la colección: especifica la rotación, en grados, de la forma.
textFrame	Para CADA ELEMENTO de la colección: devuelve el objeto de marco de texto de esta forma.
top	Para CADA ELEMENTO de la colección: la distancia, en puntos, desde el borde superior de la forma hasta el borde superior de la hoja de cálculo. Produce una InvalidArgument excepción cuando se establece con un valor negativo como entrada.
type	Para CADA ELEMENTO de la colección: devuelve el tipo de esta forma. Vea Excel.ShapeType para más información.
visible	Para CADA ELEMENTO de la colección: especifica si la forma está visible.
width	Para CADA ELEMENTO de la colección: especifica el ancho, en puntos, de la forma. Produce una InvalidArgument excepción cuando se establece con un valor negativo o cero como entrada.
zOrderPosition	Para CADA ELEMENTO de la colección: devuelve la posición de la forma especificada en el orden Z, con 0 que representa la parte inferior de la pila de pedidos.

Detalles de las propiedades

$all

Si se $all especifica para LoadOptions, se cargan todas las propiedades escalares (por ejemplo, Range.address) pero no las propiedades de navegación (por ejemplo, Range.format.fill.color).

$all?: boolean;

Valor de propiedad

boolean

altTextDescription

Para CADA ELEMENTO de la colección: especifica el texto de descripción alternativo de un Shape objeto.

altTextDescription?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

altTextTitle

Para CADA ELEMENTO de la colección: especifica el texto de título alternativo de un Shape objeto.

altTextTitle?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

connectionSiteCount

Para CADA ELEMENTO de la colección: devuelve el número de sitios de conexión de esta forma.

connectionSiteCount?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

displayName

Para CADA ELEMENTO de la colección: obtiene el nombre para mostrar de la forma. Una forma recién creada tiene un nombre generado que está localizado y puede que no coincida con su name. En este escenario, puede usar esta API para obtener el nombre que se muestra en la interfaz de usuario.

displayName?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.15 ]

fill

Para CADA ELEMENTO de la colección: devuelve el formato de relleno de esta forma.

fill?: Excel.Interfaces.ShapeFillLoadOptions;

Valor de propiedad

Excel.Interfaces.ShapeFillLoadOptions

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

geometricShape

Para CADA ELEMENTO de la colección: devuelve la forma geométrica asociada a la forma. Produce un error si el tipo de forma no es "GeometricShape".

geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions;

Valor de propiedad

Excel.Interfaces.GeometricShapeLoadOptions

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

geometricShapeType

Para CADA ELEMENTO de la colección: especifica el tipo de forma geométrica de esta forma geométrica. Vea Excel.GeometricShapeType para más información. Devuelve null si el tipo de forma no es "GeometricShape".

geometricShapeType?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

group

Para CADA ELEMENTO de la colección: devuelve el grupo de formas asociado a la forma. Produce un error si el tipo de forma no es "GroupShape".

group?: Excel.Interfaces.ShapeGroupLoadOptions;

Valor de propiedad

Excel.Interfaces.ShapeGroupLoadOptions

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

height

Para CADA ELEMENTO de la colección: especifica el alto, en puntos, de la forma. Produce una InvalidArgument excepción cuando se establece con un valor negativo o cero como entrada.

height?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

id

Para CADA ELEMENTO de la colección: especifica el identificador de forma.

id?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

image

Para CADA ELEMENTO de la colección: devuelve la imagen asociada a la forma. Produce un error si el tipo de forma no es "Image".

image?: Excel.Interfaces.ImageLoadOptions;

Valor de propiedad

Excel.Interfaces.ImageLoadOptions

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

left

Para CADA ELEMENTO de la colección: la distancia, en puntos, desde el lado izquierdo de la forma hasta el lado izquierdo de la hoja de cálculo. Produce una InvalidArgument excepción cuando se establece con un valor negativo como entrada.

left?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

level

Para CADA ELEMENTO de la colección: especifica el nivel de la forma especificada. Por ejemplo, un nivel de 0 significa que la forma no es parte de ningún grupo, un nivel de 1 significa que la forma es parte de un grupo del nivel superior y un nivel 2 significa que la forma es parte de un grupo secundario del nivel superior.

level?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

line

Para CADA ELEMENTO de la colección: devuelve la línea asociada a la forma. Produce un error si el tipo de forma no es "Line".

line?: Excel.Interfaces.LineLoadOptions;

Valor de propiedad

Excel.Interfaces.LineLoadOptions

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

lineFormat

Para CADA ELEMENTO de la colección: devuelve el formato de línea de esta forma.

lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;

Valor de propiedad

Excel.Interfaces.ShapeLineFormatLoadOptions

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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

[ Conjunto de API: ExcelApi 1.9 ]

name

Para CADA ELEMENTO de la colección: especifica el nombre de la forma.

name?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

parentGroup

Para CADA ELEMENTO de la colección: especifica el grupo primario de esta forma.

parentGroup?: Excel.Interfaces.ShapeLoadOptions;

Valor de propiedad

Excel.Interfaces.ShapeLoadOptions

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

placement

Para CADA ELEMENTO de la colección: representa cómo se adjunta el objeto a las celdas debajo de él.

placement?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

rotation

Para CADA ELEMENTO de la colección: especifica la rotación, en grados, de la forma.

rotation?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

textFrame

Para CADA ELEMENTO de la colección: devuelve el objeto de marco de texto de esta forma.

textFrame?: Excel.Interfaces.TextFrameLoadOptions;

Valor de propiedad

Excel.Interfaces.TextFrameLoadOptions

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

top

Para CADA ELEMENTO de la colección: la distancia, en puntos, desde el borde superior de la forma hasta el borde superior de la hoja de cálculo. Produce una InvalidArgument excepción cuando se establece con un valor negativo como entrada.

top?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

type

Para CADA ELEMENTO de la colección: devuelve el tipo de esta forma. Vea Excel.ShapeType para más información.

type?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

visible

Para CADA ELEMENTO de la colección: especifica si la forma está visible.

visible?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

width

Para CADA ELEMENTO de la colección: especifica el ancho, en puntos, de la forma. Produce una InvalidArgument excepción cuando se establece con un valor negativo o cero como entrada.

width?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

zOrderPosition

Para CADA ELEMENTO de la colección: devuelve la posición de la forma especificada en el orden Z, con 0 que representa la parte inferior de la pila de pedidos.

zOrderPosition?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]