Word.Shape class

Especifica si una forma determinada puede superponerse a otras formas.

allowOverlap: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Especifica una cadena que representa el texto alternativo asociado a la forma.

altTextDescription: string;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Representa el objeto de cuerpo de la forma. Solo se aplica a cuadros de texto y formas geométricas.

readonly body: Word.Body;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Obtiene el lienzo asociado a la forma. Se devolverá un objeto con su isNullObject propiedad establecida en true si el tipo de forma no es "Canvas". Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

readonly canvas: Word.Canvas;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Devuelve el formato de relleno de la forma.

readonly fill: Word.ShapeFill;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Tipo de forma geométrica de la forma. Será null si no es una 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 de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Alto, en puntos, de la forma.

height: number;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

El porcentaje de altura de la forma en tamaño relativo vertical, consulte Word. RelativeSize. Para una forma insertada o secundaria, no se puede establecer.

heightRelative: number;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Obtiene un entero que representa el identificador de forma.

readonly id: number;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Compruebe si esta forma es secundaria de una forma de grupo o de lienzo.

readonly isChild: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

La distancia, en puntos, desde el lado izquierdo de la forma hasta la posición relativa horizontal, vea Word. RelativeHorizontalPosition. Para una forma insertada, devolverá 0 y no se puede establecer. Para una forma secundaria en un lienzo o grupo, es relativa a la esquina superior izquierda.

left: number;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

La posición izquierda relativa como porcentaje desde el lado izquierdo de la forma hasta la posición relativa horizontal, vea Word. RelativeHorizontalPosition. Para una forma insertada o secundaria, devolverá 0 y no se puede establecer.

leftRelative: number;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Especifica si la relación de aspecto de esta forma está bloqueada.

lockAspectRatio: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Nombre de la forma.

name: string;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Obtiene la forma del lienzo primario de nivel superior de esta forma secundaria. Será null si no es una forma secundaria de un lienzo.

readonly parentCanvas: Word.Shape;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Obtiene la forma de grupo primario de nivel superior de esta forma secundaria. Será null si no es una forma secundaria de un grupo.

readonly parentGroup: Word.Shape;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Posición horizontal relativa de la forma. En el caso de una forma insertada, no se puede establecer. Para obtener más información, consulte Word. RelativeHorizontalPosition.

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

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Tamaño horizontal relativo de la forma. Para una forma insertada o secundaria, no se puede establecer. Para obtener más información, consulte Word. RelativeHorizontalPosition.

relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Posición vertical relativa de la forma. En el caso de una forma insertada, no se puede establecer. Para obtener más información, consulte Word. RelativeVerticalPosition.

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

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Tamaño vertical relativo de la forma. Para una forma insertada o secundaria, no se puede establecer. Para obtener más información, consulte Word. RelativeHorizontalPosition.

relativeVerticalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Especifica la rotación, en grados, de la forma. No se aplica a la forma Canvas.

rotation: number;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Obtiene el grupo de formas asociado a la forma. Un objeto con su isNullObject propiedad establecida en true se devolverá si el tipo de forma no es "GroupShape". Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

readonly shapeGroup: Word.ShapeGroup;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Obtiene el objeto de marco de texto de la forma.

readonly textFrame: Word.TextFrame;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Devuelve el formato de ajuste de texto de la forma.

readonly textWrap: Word.ShapeTextWrap;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

La distancia, en puntos, desde el borde superior de la forma hasta la posición relativa vertical, vea Word. RelativeVerticalPosition. Para una forma insertada, devolverá 0 y no se puede establecer. Para una forma secundaria en un lienzo o grupo, es relativa a la esquina superior izquierda.

top: number;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

La posición superior relativa como un porcentaje desde el borde superior de la forma hasta la posición relativa vertical, vea Word. RelativeVerticalPosition. Para una forma insertada o secundaria, devolverá 0 y no se puede establecer.

topRelative: number;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Obtiene el tipo de forma. Actualmente, solo se admiten las formas siguientes: cuadros de texto, formas geométricas, grupos, imágenes y lienzos.

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

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Especifica si la forma está visible. No se aplica a las formas insertadas.

visible: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Ancho, en puntos, de la forma.

width: number;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

El porcentaje de ancho de forma con respecto al tamaño relativo horizontal, consulte Word. RelativeSize. Para una forma insertada o secundaria, no se puede establecer.

widthRelative: number;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Elimina la forma y su contenido.

delete(): void;

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Mueve la forma horizontalmente por el número de puntos.

moveHorizontally(distance: number): void;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Mueve la forma verticalmente por el número de puntos.

moveVertically(distance: number): void;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Cambia el alto de la forma en un factor especificado. Para imágenes, puede indicar si desea aplicar una escala a la forma respecto al tamaño original o al actual. El tamaño de las formas distintas de imágenes siempre se ajusta en relación con su alto actual.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Cambia el alto de la forma en un factor especificado. Para imágenes, puede indicar si desea aplicar una escala a la forma respecto al tamaño original o al actual. El tamaño de las formas distintas de imágenes siempre se ajusta en relación con su alto actual.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Cambia el ancho de la forma en un factor especificado. Para imágenes, puede indicar si desea aplicar una escala a la forma respecto al tamaño original o al actual. El tamaño de las formas distintas de imágenes siempre se ajusta en relación con su alto actual.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Cambia el ancho de la forma en un factor especificado. Para imágenes, puede indicar si desea aplicar una escala a la forma respecto al tamaño original o al actual. El tamaño de las formas distintas de imágenes siempre se ajusta en relación con su alto actual.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Selecciona la forma.

select(selectMultipleShapes?: boolean): void;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

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

Parámetros

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Word.Shape): void;

Parámetros

Devoluciones

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Word.Shape es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.ShapeData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Word.Interfaces.ShapeData;

Devoluciones

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.

track(): Word.Shape;

Devoluciones

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

untrack(): Word.Shape;

Devoluciones