Excel.Interfaces.ShapeLoadOptions interface

Pacote:

excel

Representa um objeto de forma genérico na folha de cálculo. Uma forma pode ser uma forma geométrica, uma linha, um grupo de formas, etc. Para saber mais sobre o modelo de objeto de forma, leia Trabalhar com formas com a API JavaScript do Excel.

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Propriedades

$all	Especificar $all para as opções de carga carrega todas as propriedades escalares (como Range.address) mas não as propriedades de navegação (como Range.format.fill.color).
altTextDescription	Especifica o texto de descrição alternativo de um Shape objeto.
altTextTitle	Especifica o texto de título alternativo para um Shape objeto.
connectionSiteCount	Retorna o número de locais de conexão nessa forma.
displayName	Obtém o nome a apresentar da forma. Uma forma recentemente criada tem um nome gerado que é localizado e pode não corresponder ao respetivo name. Neste cenário, pode utilizar esta API para obter o nome que é apresentado na IU.
fill	Retorna a formatação de preenchimento dessa forma.
geometricShape	Retorna a forma geométrica associada à forma. Um erro será lançado, se o tipo de forma não for "GeometricShape".
geometricShapeType	Especifica o tipo de forma geométrica desta forma geométrica. Veja Excel.GeometricShapeType para obter detalhes. Devolve null se o tipo de forma não for "Forma Geométrica".
group	Retorna o grupo de forma associado à forma. Um erro será lançado, se o tipo de forma não for "GroupShape".
height	Especifica a altura, em pontos, da forma. Gera uma exceção InvalidArgument quando definida com um valor negativo ou zero como entrada.
id	Especifica o identificador da forma.
image	Retorna a imagem associada à forma. Um erro será lançado, se o tipo de forma não for "Imagem".
left	A distância, em pontos, da lateral esquerda da forma do lado esquerdo da planilha. Lança uma exceção InvalidArgument quando definida com um valor negativo como entrada.
level	Especifica o nível da forma especificada. Por exemplo, um nível de 0 significa que a forma não faz parte de nenhum grupo, um nível de 1 significa que a forma é parte de um grupo de nível superior e um nível 2 significa que a forma faz parte de um subgrupo do nível superior.
line	Retorna a linha associada à forma. Um erro será lançado, se o tipo de forma não for "Linha".
lineFormat	Retorna a formatação de linha do objeto de forma.
lockAspectRatio	Especifica se a proporção desta forma está bloqueada.
name	Especifica o nome da forma.
parentGroup	Especifica o grupo principal desta forma.
placement	Representa como o objeto é anexado às células abaixo dela.
rotation	Especifica a rotação, em graus, da forma.
textFrame	Retorna o objeto text frame de uma forma.
top	A distância, em pontos, da borda superior da forma até a borda superior da planilha. Lança uma exceção InvalidArgument quando definida com um valor negativo como entrada.
type	Retorna o tipo dessa forma. Veja Excel.ShapeType para obter detalhes.
visible	Especifica se a forma está visível.
width	Especifica a largura, em pontos, da forma. Gera uma exceção InvalidArgument quando definida com um valor negativo ou zero como entrada.
zOrderPosition	Retorna a posição da forma especificada na ordem z, com 0 representando a parte inferior da pilha do pedido.

Detalhes da propriedade

$all

Especificar $all para as opções de carga carrega todas as propriedades escalares (como Range.address) mas não as propriedades de navegação (como Range.format.fill.color).

$all?: boolean;

Valor da propriedade

boolean

altTextDescription

Especifica o texto de descrição alternativo de um Shape objeto.

altTextDescription?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

altTextTitle

Especifica o texto de título alternativo para um Shape objeto.

altTextTitle?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

connectionSiteCount

Retorna o número de locais de conexão nessa forma.

connectionSiteCount?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

displayName

Obtém o nome a apresentar da forma. Uma forma recentemente criada tem um nome gerado que é localizado e pode não corresponder ao respetivo name. Neste cenário, pode utilizar esta API para obter o nome que é apresentado na IU.

displayName?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.15 ]

fill

Retorna a formatação de preenchimento dessa forma.

fill?: Excel.Interfaces.ShapeFillLoadOptions;

Valor da propriedade

Excel.Interfaces.ShapeFillLoadOptions

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

geometricShape

Retorna a forma geométrica associada à forma. Um erro será lançado, se o tipo de forma não for "GeometricShape".

geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions;

Valor da propriedade

Excel.Interfaces.GeometricShapeLoadOptions

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

geometricShapeType

Especifica o tipo de forma geométrica desta forma geométrica. Veja Excel.GeometricShapeType para obter detalhes. Devolve null se o tipo de forma não for "Forma Geométrica".

geometricShapeType?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

group

Retorna o grupo de forma associado à forma. Um erro será lançado, se o tipo de forma não for "GroupShape".

group?: Excel.Interfaces.ShapeGroupLoadOptions;

Valor da propriedade

Excel.Interfaces.ShapeGroupLoadOptions

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

height

Especifica a altura, em pontos, da forma. Gera uma exceção InvalidArgument quando definida com um valor negativo ou zero como entrada.

height?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

id

Especifica o identificador da forma.

id?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

image

Retorna a imagem associada à forma. Um erro será lançado, se o tipo de forma não for "Imagem".

image?: Excel.Interfaces.ImageLoadOptions;

Valor da propriedade

Excel.Interfaces.ImageLoadOptions

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

left

A distância, em pontos, da lateral esquerda da forma do lado esquerdo da planilha. Lança uma exceção InvalidArgument quando definida com um valor negativo como entrada.

left?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

level

Especifica o nível da forma especificada. Por exemplo, um nível de 0 significa que a forma não faz parte de nenhum grupo, um nível de 1 significa que a forma é parte de um grupo de nível superior e um nível 2 significa que a forma faz parte de um subgrupo do nível superior.

level?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

line

Retorna a linha associada à forma. Um erro será lançado, se o tipo de forma não for "Linha".

line?: Excel.Interfaces.LineLoadOptions;

Valor da propriedade

Excel.Interfaces.LineLoadOptions

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

lineFormat

Retorna a formatação de linha do objeto de forma.

lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;

Valor da propriedade

Excel.Interfaces.ShapeLineFormatLoadOptions

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

lockAspectRatio

Especifica se a proporção desta forma está bloqueada.

lockAspectRatio?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

name

Especifica o nome da forma.

name?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

parentGroup

Especifica o grupo principal desta forma.

parentGroup?: Excel.Interfaces.ShapeLoadOptions;

Valor da propriedade

Excel.Interfaces.ShapeLoadOptions

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

placement

Representa como o objeto é anexado às células abaixo dela.

placement?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

rotation

Especifica a rotação, em graus, da forma.

rotation?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

textFrame

Retorna o objeto text frame de uma forma.

textFrame?: Excel.Interfaces.TextFrameLoadOptions;

Valor da propriedade

Excel.Interfaces.TextFrameLoadOptions

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

top

A distância, em pontos, da borda superior da forma até a borda superior da planilha. Lança uma exceção InvalidArgument quando definida com um valor negativo como entrada.

top?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

type

Retorna o tipo dessa forma. Veja Excel.ShapeType para obter detalhes.

type?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

visible

Especifica se a forma está visível.

visible?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

width

Especifica a largura, em pontos, da forma. Gera uma exceção InvalidArgument quando definida com um valor negativo ou zero como entrada.

width?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

zOrderPosition

Retorna a posição da forma especificada na ordem z, com 0 representando a parte inferior da pilha do pedido.

zOrderPosition?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]