Compartilhar via

Word.Interfaces.ShapeData interface

  • Referência
Pacote:
word

Uma interface que descreve os dados devolvidos ao chamar shape.toJSON().

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

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.

body?: Word.Interfaces.BodyData;

Valor da propriedade

Word.Interfaces.BodyData

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

canvas?: Word.Interfaces.CanvasData;

Valor da propriedade

Word.Interfaces.CanvasData

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

fill

Devolve a formatação de preenchimento da forma.

fill?: Word.Interfaces.ShapeFillData;

Valor da propriedade

Word.Interfaces.ShapeFillData

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.

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.

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.

parentCanvas?: Word.Interfaces.ShapeData;

Valor da propriedade

Word.Interfaces.ShapeData

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.

parentGroup?: Word.Interfaces.ShapeData;

Valor da propriedade

Word.Interfaces.ShapeData

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

shapeGroup?: Word.Interfaces.ShapeGroupData;

Valor da propriedade

Word.Interfaces.ShapeGroupData

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

textFrame

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

textFrame?: Word.Interfaces.TextFrameData;

Valor da propriedade

Word.Interfaces.TextFrameData

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

textWrap

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

textWrap?: Word.Interfaces.ShapeTextWrapData;

Valor da propriedade

Word.Interfaces.ShapeTextWrapData

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.

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 ]