Compartilhar via

Word.Interfaces.ShapeCollectionLoadOptions interface

  • Referência
Pacote:
word

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Contém uma coleção de Word. Objetos de forma. Atualmente, só são suportadas as seguintes formas: caixas de texto, geométricas, agrupadas e imagens.

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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).
body

Para CADA ITEM na coleção: representa o objeto do corpo da forma. Aplica-se apenas a caixas de texto e formas geométricas.
geometricShapeType

Para CADA ITEM na coleção: o tipo de forma geométrica da forma. Será nulo se não for uma forma geométrica.
height

Para CADA ITEM na coleção: a altura, em pontos, da forma.
id

Para CADA ITEM na coleção: obtém um número inteiro que representa o identificador da forma.
left

Para CADA ITEM na coleção: a distância, em pontos, desde o lado esquerdo da forma até à posição relativa horizontal, veja Word. RelativeHorizontalPosition. Para uma forma inline, irá devolver 0 e não pode ser definida.
name

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

Para CADA ITEM na coleção: a posição horizontal relativa da forma. Para uma forma inline, não pode ser definida. Para obter detalhes, consulte Word. RelativeHorizontalPosition.
relativeVerticalPosition

Para CADA ITEM na coleção: a posição vertical relativa da forma. Para uma forma inline, não pode ser definida. Para obter detalhes, consulte Word. RelativeVerticalPosition.
shapeGroup

Para CADA ITEM na coleção: obtém o grupo de formas associado à forma. Um objeto com a respetiva isNullObject propriedade definida como true será devolvido se o tipo de forma não for "GroupShape". Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
top

Para CADA ITEM na coleção: a distância, em pontos, desde a margem superior da forma até à posição relativa vertical, veja Word. RelativeVerticalPosition. Para uma forma inline, irá devolver 0 e não pode ser definida.
type

Para CADA ITEM na coleção: obtém o tipo de forma. Atualmente, só são suportadas as seguintes formas: caixas de texto, geométricas, agrupadas e imagens.
width

Para CADA ITEM na coleção: a largura, em pontos, da forma.

Detalhes da propriedade

$all

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

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

body

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Para CADA ITEM na coleção: representa o objeto do corpo da forma. Aplica-se apenas a caixas de texto e formas geométricas.

body?: Word.Interfaces.BodyLoadOptions;

Valor da propriedade

Word.Interfaces.BodyLoadOptions

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

geometricShapeType

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Para CADA ITEM na coleção: o tipo de forma geométrica da forma. Será nulo se não for uma forma geométrica.

geometricShapeType?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

height

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Para CADA ITEM na coleção: a altura, em pontos, da forma.

height?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

id

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Para CADA ITEM na coleção: obtém um número inteiro que representa o identificador da forma.

id?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

left

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Para CADA ITEM na coleção: a distância, em pontos, desde o lado esquerdo da forma até à posição relativa horizontal, veja Word. RelativeHorizontalPosition. Para uma forma inline, irá devolver 0 e não pode ser definida.

left?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

name

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

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

name?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

relativeHorizontalPosition

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Para CADA ITEM na coleção: a posição horizontal relativa da forma. Para uma forma inline, não pode ser definida. Para obter detalhes, consulte Word. RelativeHorizontalPosition.

relativeHorizontalPosition?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

relativeVerticalPosition

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Para CADA ITEM na coleção: a posição vertical relativa da forma. Para uma forma inline, não pode ser definida. Para obter detalhes, consulte Word. RelativeVerticalPosition.

relativeVerticalPosition?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

shapeGroup

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Para CADA ITEM na coleção: obtém o grupo de formas associado à forma. Um objeto com a respetiva isNullObject propriedade definida como true será devolvido se o tipo de forma não for "GroupShape". Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;

Valor da propriedade

Word.Interfaces.ShapeGroupLoadOptions

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

top

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Para CADA ITEM na coleção: a distância, em pontos, desde a margem superior da forma até à posição relativa vertical, veja Word. RelativeVerticalPosition. Para uma forma inline, irá devolver 0 e não pode ser definida.

top?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

type

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Para CADA ITEM na coleção: obtém o tipo de forma. Atualmente, só são suportadas as seguintes formas: caixas de texto, geométricas, agrupadas e imagens.

type?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

width

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Para CADA ITEM na coleção: a largura, em pontos, da forma.

width?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]