Word.Interfaces.ShapeCollectionLoadOptions interface

Pacote:

word

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

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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).
allowOverlap	Para CADA ITEM na coleção: especifica se uma determinada forma pode sobrepor-se a outras formas.
altTextDescription	Para CADA ITEM na coleção: especifica uma cadeia que representa o texto alternativo associado à forma.
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.
canvas	Para CADA ITEM na coleção: obtém a tela associada à forma. Um objeto com a respetiva isNullObject propriedade definida como true será devolvido se o tipo de forma não for "Tela". Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
fill	Para CADA ITEM na coleção: Devolve a formatação de preenchimento da forma.
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.
heightRelative	Para CADA ITEM na coleção: a percentagem da altura da forma para o tamanho relativo vertical, veja Word. RelativeSize. Para uma forma inline ou subordinada, não pode ser definida.
id	Para CADA ITEM na coleção: obtém um número inteiro que representa o identificador da forma.
isChild	Para CADA ITEM na coleção: verifique se esta forma é subordinada de uma forma de grupo ou de uma forma de tela.
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. Para uma forma subordinada numa tela ou grupo, é relativa ao canto superior esquerdo.
leftRelative	Para CADA ITEM na coleção: a posição relativa esquerda como uma percentagem do lado esquerdo da forma para a posição relativa horizontal, veja Word. RelativeHorizontalPosition. Para uma forma inline ou subordinada, irá devolver 0 e não pode ser definida.
lockAspectRatio	Para CADA ITEM na coleção: especifica se a proporção desta forma está bloqueada.
name	Para CADA ITEM na coleção: o nome da forma.
parentCanvas	Para CADA ITEM na coleção: obtém a forma de tela principal de nível superior desta forma subordinada. Será nulo se não for uma forma subordinada de uma tela.
parentGroup	Para CADA ITEM na coleção: obtém a forma de grupo principal de nível superior desta forma subordinada. Será nulo se não for uma forma subordinada de um grupo.
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.
relativeHorizontalSize	Para CADA ITEM na coleção: o tamanho horizontal relativo da forma. Para uma forma inline ou subordinada, 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.
relativeVerticalSize	Para CADA ITEM na coleção: o tamanho vertical relativo da forma. Para uma forma inline ou subordinada, não pode ser definida. Para obter detalhes, consulte Word. RelativeHorizontalPosition.
rotation	Para CADA ITEM na coleção: especifica a rotação, em graus, da forma. Não aplicável à forma Tela.
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).
textFrame	Para CADA ITEM na coleção: obtém o objeto de moldura de texto da forma.
textWrap	Para CADA ITEM na coleção: Devolve a formatação de moldagem de texto da forma.
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. Para uma forma subordinada numa tela ou grupo, é relativa ao canto superior esquerdo.
topRelative	Para CADA ITEM na coleção: a posição superior relativa como uma percentagem da margem superior da forma para a posição relativa vertical, veja Word. RelativeVerticalPosition. Para uma forma inline ou subordinada, 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, formas geométricas, grupos, imagens e telas.
visible	Para CADA ITEM na coleção: especifica se a forma está visível. Não aplicável a formas inline.
width	Para CADA ITEM na coleção: a largura, em pontos, da forma.
widthRelative	Para CADA ITEM na coleção: a percentagem de largura da forma para o tamanho relativo horizontal, veja Word. RelativeSize. Para uma forma inline ou subordinada, não pode ser definida.

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

allowOverlap

Para CADA ITEM na coleção: especifica se uma determinada forma pode sobrepor-se a outras formas.

allowOverlap?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

altTextDescription

Para CADA ITEM na coleção: especifica uma cadeia que representa o texto alternativo associado à forma.

altTextDescription?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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.

body?: Word.Interfaces.BodyLoadOptions;

Valor da propriedade

Word.Interfaces.BodyLoadOptions

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

canvas

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

canvas?: Word.Interfaces.CanvasLoadOptions;

Valor da propriedade

Word.Interfaces.CanvasLoadOptions

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

fill

Para CADA ITEM na coleção: Devolve a formatação de preenchimento da forma.

fill?: Word.Interfaces.ShapeFillLoadOptions;

Valor da propriedade

Word.Interfaces.ShapeFillLoadOptions

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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.

geometricShapeType?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

height

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

height?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

heightRelative

Para CADA ITEM na coleção: a percentagem da altura da forma para o tamanho relativo vertical, veja Word. RelativeSize. Para uma forma inline ou subordinada, não pode ser definida.

heightRelative?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

id

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: WordApiDesktop 1.2 ]

isChild

Para CADA ITEM na coleção: verifique se esta forma é subordinada de uma forma de grupo ou de uma forma de tela.

isChild?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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. Para uma forma subordinada numa tela ou grupo, é relativa ao canto superior esquerdo.

left?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

leftRelative

Para CADA ITEM na coleção: a posição relativa esquerda como uma percentagem do lado esquerdo da forma para a posição relativa horizontal, veja Word. RelativeHorizontalPosition. Para uma forma inline ou subordinada, irá devolver 0 e não pode ser definida.

leftRelative?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

lockAspectRatio

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

lockAspectRatio?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

name

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

name?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

parentCanvas

Para CADA ITEM na coleção: obtém a forma de tela principal de nível superior desta forma subordinada. Será nulo se não for uma forma subordinada de uma tela.

parentCanvas?: Word.Interfaces.ShapeLoadOptions;

Valor da propriedade

Word.Interfaces.ShapeLoadOptions

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

parentGroup

Para CADA ITEM na coleção: obtém a forma de grupo principal de nível superior desta forma subordinada. Será nulo se não for uma forma subordinada de um grupo.

parentGroup?: Word.Interfaces.ShapeLoadOptions;

Valor da propriedade

Word.Interfaces.ShapeLoadOptions

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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.

relativeHorizontalPosition?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

relativeHorizontalSize

Para CADA ITEM na coleção: o tamanho horizontal relativo da forma. Para uma forma inline ou subordinada, não pode ser definida. Para obter detalhes, consulte Word. RelativeHorizontalPosition.

relativeHorizontalSize?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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.

relativeVerticalPosition?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

relativeVerticalSize

Para CADA ITEM na coleção: o tamanho vertical relativo da forma. Para uma forma inline ou subordinada, não pode ser definida. Para obter detalhes, consulte Word. RelativeHorizontalPosition.

relativeVerticalSize?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

rotation

Para CADA ITEM na coleção: especifica a rotação, em graus, da forma. Não aplicável à forma Tela.

rotation?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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

shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;

Valor da propriedade

Word.Interfaces.ShapeGroupLoadOptions

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

textFrame

Para CADA ITEM na coleção: obtém o objeto de moldura de texto da forma.

textFrame?: Word.Interfaces.TextFrameLoadOptions;

Valor da propriedade

Word.Interfaces.TextFrameLoadOptions

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

textWrap

Para CADA ITEM na coleção: Devolve a formatação de moldagem de texto da forma.

textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;

Valor da propriedade

Word.Interfaces.ShapeTextWrapLoadOptions

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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. Para uma forma subordinada numa tela ou grupo, é relativa ao canto superior esquerdo.

top?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

topRelative

Para CADA ITEM na coleção: a posição superior relativa como uma percentagem da margem superior da forma para a posição relativa vertical, veja Word. RelativeVerticalPosition. Para uma forma inline ou subordinada, irá devolver 0 e não pode ser definida.

topRelative?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

type

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

type?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

visible

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

visible?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

width

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

width?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

widthRelative

Para CADA ITEM na coleção: a percentagem de largura da forma para o tamanho relativo horizontal, veja Word. RelativeSize. Para uma forma inline ou subordinada, não pode ser definida.

widthRelative?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]