Excel.Interfaces.ShapeLoadOptions interface

Paquete:

excel

Representa un objeto de forma genérico en la hoja de cálculo. Una forma podría ser una forma geométrica, una línea, un grupo de formas, etc. Para obtener más información sobre el modelo de objetos de formas, lea Trabajar con formas mediante la API de JavaScript de Excel.

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Propiedades

$all	$all Al especificar para las opciones de carga, se cargan todas las propiedades escalares (comoRange.address ), pero no las propiedades de navegación (como Range.format.fill.color).
altTextDescription	Especifica el texto de descripción alternativo de un Shape objeto.
altTextTitle	Especifica el texto de título alternativo de un Shape objeto.
connectionSiteCount	Devuelve el número de sitios de conexión en esta forma.
displayName	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	Devuelve el formato de relleno de esta forma.
geometricShape	Devuelve la forma geométrica asociada con la forma. Produce un error si el tipo de forma no es "GeometricShape".
geometricShapeType	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	Devuelve el grupo de forma asociado con la forma. Produce un error si el tipo de forma no es "GroupShape".
height	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	Especifica el identificador de forma.
image	Devuelve la imagen asociada con la forma. Produce un error si el tipo de forma no es "Image".
left	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	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	Devuelve la línea asociada con la forma. Produce un error si el tipo de forma no es "Line".
lineFormat	Devuelve el formato de línea de esta forma.
lockAspectRatio	Especifica si la relación de aspecto de esta forma está bloqueada.
name	Especifica el nombre de la forma.
parentGroup	Especifica el grupo primario de esta forma.
placement	Representa cómo está asociado el objeto a las celdas inferiores.
rotation	Especifica la rotación, en grados, de la forma.
textFrame	Devuelve el objeto de marco de texto de esta forma.
top	La distancia, en puntos, desde el borde superior de la forma al borde superior de la hoja de cálculo. Produce una InvalidArgument excepción cuando se establece con un valor negativo como entrada.
type	Devuelve el tipo de esta forma. Vea Excel.ShapeType para más información.
visible	Especifica si la forma está visible.
width	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	Devuelve la posición de la forma especificada en el orden z, siendo 0 la parte inferior de la pila del orden.

Detalles de las propiedades

$all

$all Al especificar para las opciones de carga, se cargan todas las propiedades escalares (comoRange.address ), pero no las propiedades de navegación (como Range.format.fill.color).

$all?: boolean;

Valor de propiedad

boolean

altTextDescription

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

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

Devuelve el número de sitios de conexión en esta forma.

connectionSiteCount?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

displayName

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

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

Devuelve la forma geométrica asociada con 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

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

Devuelve el grupo de forma asociado con 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

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

Especifica el identificador de forma.

id?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

image

Devuelve la imagen asociada con 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

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

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

Devuelve la línea asociada con 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

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

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

Especifica el nombre de la forma.

name?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

parentGroup

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

Representa cómo está asociado el objeto a las celdas inferiores.

placement?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

rotation

Especifica la rotación, en grados, de la forma.

rotation?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

textFrame

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

La distancia, en puntos, desde el borde superior de la forma al 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

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

Especifica si la forma está visible.

visible?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

width

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

Devuelve la posición de la forma especificada en el orden z, siendo 0 la parte inferior de la pila del orden.

zOrderPosition?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]