Excel.Interfaces.ShapeCollectionLoadOptions interface

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

Propriedades

$all

Especificar $all as opções de carga carrega todas as propriedades escalares (comoRange.address ), mas não as propriedades de navegação (como 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 está 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 desta 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. Consulte Excel.GeometricShapeType para obter 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. Lança uma InvalidArgument exceção quando definido com um valor negativo ou zero como entrada.

id

Para EACH 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. Lança uma InvalidArgument exceção quando definido com um valor negativo como 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 taxa de 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 EACH 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. Lança uma InvalidArgument exceção quando definido com um valor negativo como entrada.

type

Para CADA ITEM na coleção: Retorna o tipo dessa forma. Consulte Excel.ShapeType para obter detalhes.

visible

Para CADA ITEM na coleção: Especifica se a forma é visível.

width

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

zOrderPosition

Para EACH 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 as opções de carga carrega todas as propriedades escalares (comoRange.address ), mas não as propriedades de navegação (como 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 APIs: 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 APIs: 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 APIs: 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 está 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 APIs: ExcelApi 1.15

fill

Para CADA ITEM na coleção: retorna a formatação de preenchimento desta forma.

fill?: Excel.Interfaces.ShapeFillLoadOptions;

Valor da propriedade

Comentários

Conjunto de APIs: 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

Comentários

Conjunto de APIs: ExcelApi 1.9

geometricShapeType

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

geometricShapeType?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: 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

Comentários

Conjunto de APIs: ExcelApi 1.9

height

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

height?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.9

id

Para EACH ITEM na coleção: Especifica o identificador de forma.

id?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: 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

Comentários

Conjunto de APIs: 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. Lança uma InvalidArgument exceção quando definido com um valor negativo como entrada.

left?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: 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 APIs: 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

Comentários

Conjunto de APIs: 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

Comentários

Conjunto de APIs: ExcelApi 1.9

lockAspectRatio

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

lockAspectRatio?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: 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 APIs: ExcelApi 1.9

parentGroup

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

parentGroup?: Excel.Interfaces.ShapeLoadOptions;

Valor da propriedade

Comentários

Conjunto de APIs: 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 APIs: 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 APIs: ExcelApi 1.9

textFrame

Para EACH ITEM na coleção: Retorna o objeto de quadro de texto dessa forma.

textFrame?: Excel.Interfaces.TextFrameLoadOptions;

Valor da propriedade

Comentários

Conjunto de APIs: 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. Lança uma InvalidArgument exceção quando definido com um valor negativo como entrada.

top?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.9

type

Para CADA ITEM na coleção: Retorna o tipo dessa forma. Consulte Excel.ShapeType para obter detalhes.

type?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.9

visible

Para CADA ITEM na coleção: Especifica se a forma é visível.

visible?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.9

width

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

width?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.9

zOrderPosition

Para EACH 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 APIs: ExcelApi 1.9