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
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 | Obtém o |
| canvas | Obtém a tela associada à forma. Um objeto com a respetiva |
| fill | Devolve a formatação de preenchimento da forma. |
| geometric |
Especifica o tipo de forma geométrica da forma. Será nulo se não for uma forma geométrica. |
| height | Especifica a altura, em pontos, da forma. |
| height |
Especifica a percentagem de altura da forma para o tamanho vertical relativo (ou seja, a |
| 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 | Especifica a distância, em pontos, do lado esquerdo da forma para a posição horizontal relativa (ou seja, a |
| left |
Especifica a posição relativa à esquerda como uma percentagem do lado esquerdo da forma para a posição horizontal relativa (ou seja, a |
| lock |
Especifica se a proporção desta forma está bloqueada. |
| name | Especifica 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 |
Especifica a posição horizontal relativa da forma. Para uma forma inline, não pode ser definida. Para obter detalhes, consulte Word. RelativeHorizontalPosition. |
| relative |
Especifica o tamanho horizontal relativo da forma. Utilize com a |
| relative |
Especifica a posição vertical relativa da forma. Para uma forma inline, não pode ser definida. Para obter detalhes, consulte Word. RelativeVerticalPosition. |
| relative |
Especifica o tamanho vertical relativo da forma. Utilize com a |
| 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 |
| text |
Devolve a formatação de moldagem do texto da forma. |
| top | Especifica a distância, em pontos, desde a margem superior da forma até à posição vertical relativa (ou seja, a |
| top |
Especifica a posição superior relativa como uma percentagem da margem superior da forma para a posição vertical relativa (ou seja, a |
| 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 | Especifica a largura, em pontos, da forma. |
| width |
Especifica a percentagem de largura da forma para o tamanho horizontal relativo (ou seja, a |
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
Obtém o Body objeto 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 canvasfor . 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
Especifica 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
Especifica a altura, em pontos, da forma.
height?: boolean;
Valor da propriedade
boolean
Comentários
heightRelative
Especifica a percentagem de altura da forma para o tamanho vertical relativo (ou seja, a relativeVerticalSize propriedade). 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
Especifica a distância, em pontos, do lado esquerdo da forma para a posição horizontal relativa (ou seja, a relativeHorizontalPosition propriedade). 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
Especifica a posição relativa à esquerda como uma percentagem do lado esquerdo da forma para a posição horizontal relativa (ou seja, a relativeHorizontalalPosition propriedade). 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
Especifica 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
Especifica 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
Especifica o tamanho horizontal relativo da forma. Utilize com a widthRelative propriedade . Para uma forma inline ou subordinada, não pode ser definida.
relativeHorizontalSize?: boolean;
Valor da propriedade
boolean
Comentários
relativeVerticalPosition
Especifica 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
Especifica o tamanho vertical relativo da forma. Utilize com a heightRelative propriedade . Para uma forma inline ou subordinada, não pode ser definida.
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 groupShapefor . 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 TextFrame objeto 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
Especifica a distância, em pontos, desde a margem superior da forma até à posição vertical relativa (ou seja, a relativeVerticalPosition propriedade). 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
Especifica a posição superior relativa como uma percentagem da margem superior da forma para a posição vertical relativa (ou seja, a relativeVerticalPosition propriedade). 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
Especifica a largura, em pontos, da forma.
width?: boolean;
Valor da propriedade
boolean
Comentários
widthRelative
Especifica a percentagem de largura da forma para o tamanho horizontal relativo (ou seja, a relativeHorizontalSize propriedade). Para uma forma inline ou subordinada, não pode ser definida.
widthRelative?: boolean;
Valor da propriedade
boolean