Word.Shape class

Pacote:

word

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.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

Propriedades

allowOverlap	Especifica se uma determinada forma pode sobrepor-se a outras formas.
altTextDescription	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 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).
context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
fill	Devolve a formatação de preenchimento da forma.
geometricShapeType	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.
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.
id	Obtém um número inteiro que representa o identificador da forma.
isChild	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.
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.
lockAspectRatio	Especifica se a proporção desta forma está bloqueada.
name	O nome da forma.
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.
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.
relativeHorizontalPosition	A posição horizontal relativa da forma. Para uma forma inline, não pode ser definida. Para obter detalhes, consulte Word. RelativeHorizontalPosition.
relativeHorizontalSize	O tamanho horizontal relativo da forma. Para uma forma inline ou subordinada, não pode ser definida. Para obter detalhes, consulte Word. RelativeHorizontalPosition.
relativeVerticalPosition	A posição vertical relativa da forma. Para uma forma inline, não pode ser definida. Para obter detalhes, consulte Word. RelativeVerticalPosition.
relativeVerticalSize	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.
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).
textFrame	Obtém o objeto de moldura de texto da forma.
textWrap	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.
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.
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.
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.

Métodos

delete()	Elimina a forma e o respetivo conteúdo.
load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
moveHorizontally(distance)	Move a forma horizontalmente pelo número de pontos.
moveVertically(distance)	Move a forma verticalmente pelo número de pontos.
scaleHeight(scaleFactor, scaleType, scaleFrom)	Dimensiona a altura da forma por um fator especificado. Para imagens, é possível indicar se você deseja dimensionar a forma em relação ao tamanho original ou ao tamanho atual. As formas que não são figuras serão sempre dimensionadas em relação à sua altura atual.
scaleHeight(scaleFactor, scaleTypeString, scaleFromString)	Dimensiona a altura da forma por um fator especificado. Para imagens, é possível indicar se você deseja dimensionar a forma em relação ao tamanho original ou ao tamanho atual. As formas que não são figuras serão sempre dimensionadas em relação à sua altura atual.
scaleWidth(scaleFactor, scaleType, scaleFrom)	Dimensiona a largura da forma por um fator especificado. Para imagens, é possível indicar se você deseja dimensionar a forma em relação ao tamanho original ou ao tamanho atual. As formas que não são figuras serão sempre dimensionadas em relação à sua altura atual.
scaleWidth(scaleFactor, scaleTypeString, scaleFromString)	Dimensiona a largura da forma por um fator especificado. Para imagens, é possível indicar se você deseja dimensionar a forma em relação ao tamanho original ou ao tamanho atual. As formas que não são figuras serão sempre dimensionadas em relação à sua altura atual.
select(selectMultipleShapes)	Seleciona a forma.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
toJSON()	Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.Shape é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.ShapeData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
track()	Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.
untrack()	Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

Detalhes da propriedade

allowOverlap

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

Especifica uma cadeia que representa o texto alternativo associado à forma.

altTextDescription: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

body

Representa o objeto do corpo da forma. Aplica-se apenas a caixas de texto e formas geométricas.

readonly body: Word.Body;

Valor da propriedade

Word.Body

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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

readonly canvas: Word.Canvas;

Valor da propriedade

Word.Canvas

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Word.RequestContext

fill

Devolve a formatação de preenchimento da forma.

readonly fill: Word.ShapeFill;

Valor da propriedade

Word.ShapeFill

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

geometricShapeType

O tipo de forma geométrica da forma. Será nulo se não for uma forma geométrica.

geometricShapeType: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";

Valor da propriedade

Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

height

A altura, em pontos, da forma.

height: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

id

Obtém um número inteiro que representa o identificador da forma.

readonly id: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

isChild

Verifique se esta forma é subordinada de uma forma de grupo ou de uma forma de tela.

readonly isChild: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

lockAspectRatio

Especifica se a proporção desta forma está bloqueada.

lockAspectRatio: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

name

O nome da forma.

name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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.

readonly parentCanvas: Word.Shape;

Valor da propriedade

Word.Shape

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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.

readonly parentGroup: Word.Shape;

Valor da propriedade

Word.Shape

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

relativeHorizontalPosition

A posição horizontal relativa da forma. Para uma forma inline, não pode ser definida. Para obter detalhes, consulte Word. RelativeHorizontalPosition.

relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";

Valor da propriedade

Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

Valor da propriedade

Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

relativeVerticalPosition

A posição vertical relativa da forma. Para uma forma inline, não pode ser definida. Para obter detalhes, consulte Word. RelativeVerticalPosition.

relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

Valor da propriedade

Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

Valor da propriedade

Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

rotation

Especifica a rotação, em graus, da forma. Não aplicável à forma Tela.

rotation: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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

readonly shapeGroup: Word.ShapeGroup;

Valor da propriedade

Word.ShapeGroup

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

textFrame

Obtém o objeto de moldura de texto da forma.

readonly textFrame: Word.TextFrame;

Valor da propriedade

Word.TextFrame

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

textWrap

Devolve a formatação de moldagem do texto da forma.

readonly textWrap: Word.ShapeTextWrap;

Valor da propriedade

Word.ShapeTextWrap

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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.

readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas";

Valor da propriedade

Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

visible

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

A largura, em pontos, da forma.

width: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

Detalhes do método

delete()

Elimina a forma e o respetivo conteúdo.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Word.Interfaces.ShapeLoadOptions): Word.Shape;

Parâmetros

options

Word.Interfaces.ShapeLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Word.Shape

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): Word.Shape;

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Word.Shape

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Shape;

Parâmetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Word.Shape

moveHorizontally(distance)

Move a forma horizontalmente pelo número de pontos.

moveHorizontally(distance: number): void;

Parâmetros

distance

number

Obrigatório. Especifica o quanto a forma deve ser movida horizontalmente, em pontos. Utilize um valor positivo para mover a forma para a direita. Utilize um valor negativo para mover a forma para a esquerda.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

moveVertically(distance)

Move a forma verticalmente pelo número de pontos.

moveVertically(distance: number): void;

Parâmetros

distance

number

Obrigatório. Especifica o quanto a forma deve ser movida verticalmente, em pontos. Utilize um valor positivo para mover a forma para cima. Utilize um valor negativo para mover a forma para baixo.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

scaleHeight(scaleFactor, scaleType, scaleFrom)

Dimensiona a altura da forma por um fator especificado. Para imagens, é possível indicar se você deseja dimensionar a forma em relação ao tamanho original ou ao tamanho atual. As formas que não são figuras serão sempre dimensionadas em relação à sua altura atual.

scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void;

Parâmetros

scaleFactor

number

Especifica a proporção entre a altura da forma após você redimensioná-la e a altura atual ou original.

scaleType

Word.ShapeScaleType

Especifica se a forma é dimensionada relativamente ao respetivo tamanho original ou atual. A opção de dimensionamento do tamanho original só funciona para imagens.

scaleFrom

Word.ShapeScaleFrom

Opcional. Especifica qual parte da forma mantém sua posição quando a forma é dimensionada. Se for omitido, significa que o canto superior esquerdo da forma mantém a sua posição.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

scaleHeight(scaleFactor, scaleTypeString, scaleFromString)

Dimensiona a altura da forma por um fator especificado. Para imagens, é possível indicar se você deseja dimensionar a forma em relação ao tamanho original ou ao tamanho atual. As formas que não são figuras serão sempre dimensionadas em relação à sua altura atual.

scaleHeight(scaleFactor: number, scaleTypeString: "CurrentSize" | "OriginalSize", scaleFromString?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;

Parâmetros

scaleFactor

number

Especifica a proporção entre a altura da forma após você redimensioná-la e a altura atual ou original.

scaleTypeString

"CurrentSize" | "OriginalSize"

Especifica se a forma é dimensionada relativamente ao respetivo tamanho original ou atual. A opção de dimensionamento do tamanho original só funciona para imagens.

scaleFromString

"ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"

Opcional. Especifica qual parte da forma mantém sua posição quando a forma é dimensionada. Se for omitido, significa que o canto superior esquerdo da forma mantém a sua posição.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

scaleWidth(scaleFactor, scaleType, scaleFrom)

Dimensiona a largura da forma por um fator especificado. Para imagens, é possível indicar se você deseja dimensionar a forma em relação ao tamanho original ou ao tamanho atual. As formas que não são figuras serão sempre dimensionadas em relação à sua altura atual.

scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void;

Parâmetros

scaleFactor

number

Especifica a proporção entre a largura da forma após você redimensioná-la e a largura atual ou original.

scaleType

Word.ShapeScaleType

Especifica se a forma é dimensionada relativamente ao respetivo tamanho original ou atual. A opção de dimensionamento do tamanho original só funciona para imagens.

scaleFrom

Word.ShapeScaleFrom

Opcional. Especifica qual parte da forma mantém sua posição quando a forma é dimensionada. Se for omitido, significa que o canto superior esquerdo da forma mantém a sua posição.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

scaleWidth(scaleFactor, scaleTypeString, scaleFromString)

Dimensiona a largura da forma por um fator especificado. Para imagens, é possível indicar se você deseja dimensionar a forma em relação ao tamanho original ou ao tamanho atual. As formas que não são figuras serão sempre dimensionadas em relação à sua altura atual.

scaleWidth(scaleFactor: number, scaleTypeString: "CurrentSize" | "OriginalSize", scaleFromString?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;

Parâmetros

scaleFactor

number

Especifica a proporção entre a largura da forma após você redimensioná-la e a largura atual ou original.

scaleTypeString

"CurrentSize" | "OriginalSize"

Especifica se a forma é dimensionada relativamente ao respetivo tamanho original ou atual. A opção de dimensionamento do tamanho original só funciona para imagens.

scaleFromString

"ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"

Opcional. Especifica qual parte da forma mantém sua posição quando a forma é dimensionada. Se for omitido, significa que o canto superior esquerdo da forma mantém a sua posição.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

select(selectMultipleShapes)

Seleciona a forma.

select(selectMultipleShapes?: boolean): void;

Parâmetros

selectMultipleShapes

boolean

Opcional. Se pretende selecionar múltiplas formas flutuantes. O valor padrão é falso.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties

Word.Interfaces.ShapeUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options

OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Word.Shape): void;

Parâmetros

properties

Word.Shape

Retornos

void

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.Shape é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.ShapeData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.ShapeData;

Retornos

Word.Interfaces.ShapeData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.

track(): Word.Shape;

Retornos

Word.Shape

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): Word.Shape;

Retornos

Word.Shape