Excel.Interfaces.ShapeCollectionLoadOptions interface

Pacote:

excel

Representa uma coleção de todas as formas na planilha.

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Propriedades

$all	Especificar $all para o LoadOptions carrega todas as propriedades escalares (por exemplo: Range.address) mas não as propriedades de navegação (por exemplo: Range.format.fill.color).
altTextDescription	Para CADA ITEM na coleção: especifica o texto de descrição alternativo para um Shape objeto.
altTextTitle	Para CADA ITEM na coleção: especifica o texto de título alternativo para um Shape objeto.
connectionSiteCount	Para CADA ITEM na coleção: retorna o número de sites de conexão nessa forma.
displayName	Para CADA ITEM na coleção: obtém o nome de exibição da forma. Uma forma recém-criada tem um nome gerado que é localizado e pode não corresponder ao seu name. Nesse cenário, você pode usar essa API para obter o nome exibido na interface do usuário.
fill	Para CADA ITEM na coleção: retorna a formatação de preenchimento dessa forma.
geometricShape	Para CADA ITEM na coleção: retorna a forma geométrica associada à forma. Um erro será lançado, se o tipo de forma não for "GeometricShape".
geometricShapeType	Para CADA ITEM na coleção: especifica o tipo de forma geométrica dessa forma geométrica. Confira Excel.GeometricShapeType detalhes. Retorna null se o tipo de forma não for "GeometricShape".
group	Para CADA ITEM na coleção: retorna o grupo de formas associado à forma. Um erro será lançado, se o tipo de forma não for "GroupShape".
height	Para CADA ITEM na coleção: especifica a altura, em pontos, da forma. Gera uma exceção InvalidArgument quando definida com um valor negativo ou zero como uma entrada.
id	Para CADA ITEM na coleção: especifica o identificador de forma.
image	Para CADA ITEM na coleção: retorna a imagem associada à forma. Um erro será lançado, se o tipo de forma não for "Imagem".
left	Para CADA ITEM na coleção: a distância, em pontos, do lado esquerdo da forma até o lado esquerdo da planilha. Gera uma exceção InvalidArgument quando definida com um valor negativo como uma entrada.
level	Para CADA ITEM na coleção: 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	Para CADA ITEM na coleção: retorna a linha associada à forma. Um erro será lançado, se o tipo de forma não for "Linha".
lineFormat	Para CADA ITEM na coleção: retorna a formatação de linha dessa forma.
lockAspectRatio	Para CADA ITEM na coleção: especifica se a proporção dessa forma está bloqueada.
name	Para CADA ITEM na coleção: especifica o nome da forma.
parentGroup	Para CADA ITEM na coleção: especifica o grupo pai dessa forma.
placement	Para CADA ITEM na coleção: representa como o objeto é anexado às células abaixo dele.
rotation	Para CADA ITEM na coleção: especifica a rotação, em graus, da forma.
textFrame	Para CADA ITEM na coleção: retorna o objeto de quadro de texto dessa forma.
top	Para CADA ITEM na coleção: a distância, em pontos, da borda superior da forma até a borda superior da planilha. Gera uma exceção InvalidArgument quando definida com um valor negativo como uma entrada.
type	Para CADA ITEM na coleção: retorna o tipo dessa forma. Confira Excel.ShapeType detalhes.
visible	Para CADA ITEM na coleção: especifica se a forma está visível.
width	Para CADA ITEM na coleção: especifica a largura, em pontos, da forma. Gera uma exceção InvalidArgument quando definida com um valor negativo ou zero como uma entrada.
zOrderPosition	Para CADA ITEM na coleção: retorna a posição da forma especificada na ordem z, com 0 representando a parte inferior da pilha de pedidos.

Detalhes da propriedade

$all

Especificar $all para o LoadOptions carrega todas as propriedades escalares (por exemplo: Range.address) mas não as propriedades de navegação (por exemplo: Range.format.fill.color).

$all?: boolean;

Valor da propriedade

boolean

altTextDescription

Para CADA ITEM na coleção: especifica o texto de descrição alternativo para um Shape objeto.

altTextDescription?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

altTextTitle

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: retorna o número de sites de conexão nessa forma.

connectionSiteCount?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

displayName

Para CADA ITEM na coleção: obtém o nome de exibição da forma. Uma forma recém-criada tem um nome gerado que é localizado e pode não corresponder ao seu name. Nesse cenário, você pode usar essa API para obter o nome exibido na interface do usuário.

displayName?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.15 ]

fill

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: especifica o tipo de forma geométrica dessa forma geométrica. Confira Excel.GeometricShapeType detalhes. Retorna null se o tipo de forma não for "GeometricShape".

geometricShapeType?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

group

Para CADA ITEM na coleção: retorna o grupo de formas 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

Para CADA ITEM na coleção: especifica a altura, em pontos, da forma. Gera uma exceção InvalidArgument quando definida com um valor negativo ou zero como uma entrada.

height?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

id

Para CADA ITEM na coleção: especifica o identificador de forma.

id?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

image

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: a distância, em pontos, do lado esquerdo da forma até o lado esquerdo da planilha. Gera uma exceção InvalidArgument quando definida com um valor negativo como uma entrada.

left?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

level

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: retorna a formatação de linha dessa forma.

lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;

Valor da propriedade

Excel.Interfaces.ShapeLineFormatLoadOptions

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

lockAspectRatio

Para CADA ITEM na coleção: especifica se a proporção dessa forma está bloqueada.

lockAspectRatio?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

name

Para CADA ITEM na coleção: especifica o nome da forma.

name?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

parentGroup

Para CADA ITEM na coleção: especifica o grupo pai dessa forma.

parentGroup?: Excel.Interfaces.ShapeLoadOptions;

Valor da propriedade

Excel.Interfaces.ShapeLoadOptions

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

placement

Para CADA ITEM na coleção: representa como o objeto é anexado às células abaixo dele.

placement?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

rotation

Para CADA ITEM na coleção: especifica a rotação, em graus, da forma.

rotation?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

textFrame

Para CADA ITEM na coleção: retorna o objeto de quadro de texto dessa forma.

textFrame?: Excel.Interfaces.TextFrameLoadOptions;

Valor da propriedade

Excel.Interfaces.TextFrameLoadOptions

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

top

Para CADA ITEM na coleção: a distância, em pontos, da borda superior da forma até a borda superior da planilha. Gera uma exceção InvalidArgument quando definida com um valor negativo como uma entrada.

top?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

type

Para CADA ITEM na coleção: retorna o tipo dessa forma. Confira Excel.ShapeType detalhes.

type?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

visible

Para CADA ITEM na coleção: especifica se a forma está visível.

visible?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

width

Para CADA ITEM na coleção: especifica a largura, em pontos, da forma. Gera uma exceção InvalidArgument quando definida com um valor negativo ou zero como uma entrada.

width?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

zOrderPosition

Para CADA ITEM na coleção: retorna a posição da forma especificada na ordem z, com 0 representando a parte inferior da pilha de pedidos.

zOrderPosition?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]