Word.Interfaces.ShapeLoadOptions interface
Representa uma forma no cabeçalho, rodapé ou corpo do documento. 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 |
| allow |
Especifica se uma determinada forma pode sobrepor-se a outras formas. |
| alt |
Especifica uma cadeia que representa o texto alternativo associado à forma. |
| body | Representa o objeto do corpo da forma. Aplica-se apenas a caixas de texto e formas geométricas. |
| canvas | Obtém a tela associada à forma. Um objeto com a respetiva |
| fill | Devolve a formatação de preenchimento da forma. |
| geometric |
O tipo de forma geométrica da forma. Será nulo se não for uma forma geométrica. |
| height | A altura, em pontos, da forma. |
| height |
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 | Obtém um número inteiro que representa o identificador da forma. |
| is |
Verifique se esta forma é subordinada de uma forma de grupo ou de uma forma de tela. |
| left | 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 |
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. |
| lock |
Especifica se a proporção desta forma está bloqueada. |
| name | O nome da forma. |
| parent |
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. |
| parent |
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. |
| relative |
A posição horizontal relativa da forma. Para uma forma inline, não pode ser definida. Para obter detalhes, consulte Word. RelativeHorizontalPosition. |
| relative |
O tamanho horizontal relativo da forma. Para uma forma inline ou subordinada, não pode ser definida. Para obter detalhes, consulte Word. RelativeHorizontalPosition. |
| relative |
A posição vertical relativa da forma. Para uma forma inline, não pode ser definida. Para obter detalhes, consulte Word. RelativeVerticalPosition. |
| relative |
O tamanho vertical relativo da forma. Para uma forma inline ou subordinada, não pode ser definida. Para obter detalhes, consulte Word. RelativeHorizontalPosition. |
| rotation | Especifica a rotação, em graus, da forma. Não aplicável à forma Tela. |
| shape |
Obtém o grupo de formas associado à forma. Um objeto com a respetiva |
| text |
Obtém o objeto de moldura de texto da forma. |
| text |
Devolve a formatação de moldagem do texto da forma. |
| top | A distância, em pontos, desde a margem superior da forma até à posição relativa vertical, vê 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 |
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 | 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 | Especifica se a forma está visível. Não aplicável a formas inline. |
| width | A largura, em pontos, da forma. |
| width |
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
Especifica se uma determinada forma pode sobrepor-se a outras formas.
allowOverlap?: boolean;Valor da propriedade
boolean
Comentários
altTextDescription
Especifica uma cadeia que representa o texto alternativo associado à forma.
altTextDescription?: boolean;Valor da propriedade
boolean
Comentários
body
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
Comentários
canvas
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
Comentários
fill
Devolve a formatação de preenchimento da forma.
fill?: Word.Interfaces.ShapeFillLoadOptions;Valor da propriedade
Comentários
geometricShapeType
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
height
A altura, em pontos, da forma.
height?: boolean;Valor da propriedade
boolean
Comentários
heightRelative
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
id
Obtém um número inteiro que representa o identificador da forma.
id?: boolean;Valor da propriedade
boolean
Comentários
isChild
Verifique se esta forma é subordinada de uma forma de grupo ou de uma forma de tela.
isChild?: boolean;Valor da propriedade
boolean
Comentários
left
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
leftRelative
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
lockAspectRatio
Especifica se a proporção desta forma está bloqueada.
lockAspectRatio?: boolean;Valor da propriedade
boolean
Comentários
name
O nome da forma.
name?: boolean;Valor da propriedade
boolean
Comentários
parentCanvas
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
Comentários
parentGroup
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
Comentários
relativeHorizontalPosition
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
relativeHorizontalSize
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
relativeVerticalPosition
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
relativeVerticalSize
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
rotation
Especifica a rotação, em graus, da forma. Não aplicável à forma Tela.
rotation?: boolean;Valor da propriedade
boolean
Comentários
shapeGroup
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
Comentários
textFrame
Obtém o objeto de moldura de texto da forma.
textFrame?: Word.Interfaces.TextFrameLoadOptions;Valor da propriedade
Comentários
textWrap
Devolve a formatação de moldagem do texto da forma.
textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;Valor da propriedade
Comentários
top
A distância, em pontos, desde a margem superior da forma até à posição relativa vertical, vê 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
topRelative
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
type
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
visible
Especifica se a forma está visível. Não aplicável a formas inline.
visible?: boolean;Valor da propriedade
boolean
Comentários
width
A largura, em pontos, da forma.
width?: boolean;Valor da propriedade
boolean
Comentários
widthRelative
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