Conjunto de requisitos de solo escritorio de la API de JavaScript de Word 1.2

El WordApiDesktop conjunto de requisitos es un conjunto de requisitos especiales que incluye características que solo están disponibles para Word en Windows, Mac y iPad. Las API de este conjunto de requisitos se consideran API de producción para la aplicación de Word en Windows, en Mac y en iPad. Siguen las directivas de soporte técnico para desarrolladores de Microsoft 365. WordApiDesktop Las API se consideran API de "versión preliminar" para otras plataformas (web) y es posible que no sean compatibles con ninguna de esas plataformas.

Cuando las API del conjunto de WordApiDesktop requisitos sean compatibles con todas las plataformas, se agregarán al siguiente conjunto de requisitos publicado (WordApi 1.[NEXT]). Una vez que el nuevo conjunto de requisitos sea público, esas API también seguirán etiquetándose en este WordApiDesktop conjunto de requisitos. Para obtener más información sobre los requisitos específicos de la plataforma en general, consulte Descripción de los conjuntos de requisitos específicos de la plataforma.

Importante

WordApiDesktop 1.2 es un conjunto de requisitos solo para escritorio. Es un superconjunto de WordApi 1.9 y WordApiDesktop 1.1.

Dado que las WordApiDesktop 1.2 API solo son compatibles con Word en Windows, en Mac y en iPad, el complemento debe comprobar si el conjunto de requisitos es compatible antes de llamar a estas API. Esto evita cualquier intento de usar API solo de escritorio en una plataforma no compatible.

if (Office.context.requirements.isSetSupported("WordApiDesktop", "1.2")) {
   // Any API exclusive to this WordApiDesktop requirement set.
}

Una vez que la API está en un conjunto de requisitos multiplataforma, debe quitar o editar la isSetSupported comprobación. Esto habilitará la característica del complemento en otras plataformas. Al realizar este cambio, asegúrate de probar la característica en esas plataformas.

Importante

El manifiesto no se puede especificar WordApiDesktop 1.2 como requisito de activación. No es un valor válido para usar en el elemento Set.

Lista de API

En la tabla siguiente se enumeran las API de JavaScript de Word incluidas actualmente en el conjunto de WordApiDesktop 1.2 requisitos. Para obtener una lista completa de todas las API de JavaScript de Word (incluidas las API y WordApiDesktop 1.2 las API publicadas anteriormente), consulte todas las API de JavaScript de Word.

Clase Campos Descripción
Cuerpo shapes Obtiene la colección de Shape objetos en el cuerpo, incluidas las formas en línea y flotantes.
Canvas id Obtiene un entero que representa el identificador de lienzo.
shape Obtiene el Shape objeto asociado al lienzo.
shapes Obtiene la colección de Word. Objetos Shape.
Documento activeWindow Obtiene la ventana activa del documento.
compareFromBase64(base64File: string, documentCompareOptions?: Word. DocumentCompareOptions) Muestra las marcas de revisión para indicar dónde están las diferencias entre ambos documentos.
Windows Obtiene la colección de Word.Window objetos del documento.
Font hidden Especifica si la fuente está etiquetada como oculta.
InsertShapeOptions height Si se proporciona, especifica la altura de la forma que se inserta.
left Si se proporciona, especifica la posición izquierda de la forma que se inserta.
top Si se proporciona, especifica la posición superior de la forma que se inserta.
width Si se proporciona, especifica el ancho de la forma que se inserta.
Page getNext() Obtiene la página siguiente en el panel.
getNextOrNullObject() Obtiene la página siguiente.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | "Todo" | "Inicio" | "Fin") Obtiene toda la página, o el punto inicial o final de la página, como un rango.
height Obtiene la altura, en puntos, del papel definida en el cuadro de diálogo Configurar página.
index Obtiene el índice de la página.
width Obtiene el ancho, en puntos, del papel definido en el cuadro de diálogo Configurar página.
PageCollection getFirst() Obtiene la primera página de esta colección.
getFirstOrNullObject() Obtiene la primera página de esta colección.
items Obtiene los elementos secundarios cargados en esta colección.
Panel getNext() Obtiene el siguiente panel de la ventana.
getNextOrNullObject() Obtiene el siguiente panel.
pages Obtiene la colección de páginas del panel.
pagesEnclosingViewport Obtiene lo que PageCollection se muestra en la ventanilla del panel.
PanelCollection getFirst() Obtiene el primer panel de esta colección.
getFirstOrNullObject() Obtiene el primer panel de esta colección.
items Obtiene los elementos secundarios cargados en esta colección.
Paragraph insertCanvas(insertShapeOptions?: Word. InsertShapeOptions) Inserta un lienzo flotante delante del texto con su delimitador al principio del párrafo.
insertGeometricShape(geometricShapeType: Word. GeometricShapeType, insertShapeOptions?: Word. InsertShapeOptions) Inserta una forma geométrica delante del texto con su delimitador al principio del párrafo.
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word. InsertShapeOptions) Inserta una imagen flotante delante del texto con su delimitador al principio del párrafo.
insertTextBox(text?: string, insertShapeOptions?: Word. InsertShapeOptions) Inserta un cuadro de texto flotante delante del texto con su delimitador al principio del párrafo.
shapes Obtiene la colección de Shape objetos anclados en el párrafo, incluidas las formas en línea y flotantes.
Rango insertCanvas(insertShapeOptions?: Word. InsertShapeOptions) Inserta un lienzo flotante delante del texto con su delimitador al principio del rango.
insertGeometricShape(geometricShapeType: Word. GeometricShapeType, insertShapeOptions?: Word. InsertShapeOptions) Inserta una forma geométrica delante del texto con su delimitador al principio del rango.
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word. InsertShapeOptions) Inserta una imagen flotante delante del texto con su delimitador al principio del rango.
insertTextBox(text?: string, insertShapeOptions?: Word. InsertShapeOptions) Inserta un cuadro de texto flotante delante del texto con su delimitador al principio del rango.
pages Obtiene la colección de páginas del intervalo.
shapes Obtiene la colección de Shape objetos anclados en el rango, incluidas las formas en línea y flotantes.
Shape allowOverlap Especifica si una forma determinada se puede superponer a otras formas.
altTextDescription Especifica una cadena que representa el texto alternativo asociado a la forma.
body Obtiene el Body objeto de la forma.
lienzo Obtiene el lienzo asociado a la forma.
delete() Elimina la forma y su contenido.
fill Devuelve el formato de relleno de la forma.
geometricShapeType Especifica el tipo de forma geométrica de la forma.
height Especifica la altura, en puntos, de la forma.
heightRelative Especifica el porcentaje de alto de la forma con respecto al tamaño vertical relativo (es decir, la relativeVerticalSize propiedad).
id Obtiene un entero que representa el identificador de forma.
isChild Compruebe si esta forma es un elemento secundario de una forma de grupo o una forma de lienzo.
left Especifica la distancia, en puntos, desde el lado izquierdo de la forma hasta la posición horizontal relativa (es decir, la relativeHorizontalPosition propiedad).
leftRelative Especifica la posición izquierda relativa como un porcentaje del lado izquierdo de la forma a la posición horizontal relativa (es decir, la relativeHorizontalalPosition propiedad).
lockAspectRatio Especifica si la relación de aspecto de esta forma está bloqueada.
moveHorizontally(distance: number) Mueve la forma horizontalmente por un número de puntos.
moveVertically(distance: number) Mueve la forma verticalmente por un número de puntos.
name Especifica el nombre de la forma.
parentCanvas Obtiene la forma de lienzo principal de nivel superior de esta forma secundaria.
parentGroup Obtiene la forma de grupo principal de nivel superior de esta forma secundaria.
relativeHorizontalPosition Especifica la posición horizontal relativa de la forma.
relativeHorizontalSize Especifica el tamaño horizontal relativo de la forma.
relativeVerticalPosition Especifica la posición vertical relativa de la forma.
relativeVerticalSize Especifica el tamaño vertical relativo de la forma.
rotation Especifica el giro, en grados, de la forma.
scaleHeight(scaleFactor: number, scaleType: Word. ShapeScaleType, scaleFrom?: Word. ShapeScaleFrom) Cambia el alto de la forma en un factor especificado.
scaleWidth(scaleFactor: number, scaleType: Word. ShapeScaleType, scaleFrom?: Word. ShapeScaleFrom) Cambia el ancho de la forma en un factor especificado.
select(selectMultipleShapes?: boolean) Selecciona la forma.
Grupo de formas Obtiene el grupo de formas asociado a la forma.
textFrame Obtiene el TextFrame objeto de la forma.
textWrap Devuelve el formato de ajuste de texto de la forma.
top Especifica la distancia, en puntos, desde el borde superior de la forma hasta la posición vertical relativa (es decir, la relativeVerticalPosition propiedad).
topRelative Especifica la posición superior relativa como un porcentaje desde el borde superior de la forma hasta la posición vertical relativa (es decir, la relativeVerticalPosition propiedad).
type Obtiene el tipo de forma.
visible Especifica si la forma está visible.
width Especifica el ancho, en puntos, de la forma.
widthRelative Especifica el porcentaje de ancho de forma con respecto al tamaño horizontal relativo (es decir, la relativeHorizontalSize propiedad).
ShapeCollection getByGeometricTypes(types: Word. GeometricShapeType[]) Obtiene las formas que tienen los tipos geométricos especificados.
getById(id: number) Obtiene una forma por su identificador.
getByIdOrNullObject(id: number) Obtiene una forma por su identificador.
getByIds(ids: number[]) Obtiene las formas por los identificadores.
getByNames(names: string[]) Obtiene las formas que tienen los nombres especificados.
getByTypes(types: Word. ShapeType[]) Obtiene las formas que tienen los tipos especificados.
getFirst() Obtiene la primera forma de esta colección.
getFirstOrNullObject() Obtiene la primera forma de esta colección.
group() Grupos Formas flotantes En esta colección, se omitirán las formas en línea.
items Obtiene los elementos secundarios cargados en esta colección.
ShapeFill color de fondo Especifica el color de fondo del relleno de forma.
clear() Desactiva el formato de relleno de esta forma y la establece en Word.ShapeFillType.noFill.
foregroundColor Especifica el color de primer plano de relleno de forma.
setSolidColor(color: string) Establece el formato de relleno de la forma en un color uniforme.
transparency Especifica el porcentaje de transparencia del relleno como un valor entre 0,0 (opaco) y 1,0 (borrado).
type Devuelve el tipo de relleno de la forma.
ShapeGroup id Obtiene un entero que representa el identificador del grupo de formas.
shape Obtiene el Shape objeto asociado al grupo.
shapes Obtiene la colección de Shape objetos.
ungroup() Desagrupa las formas agrupadas en el grupo de formas especificado.
ShapeTextWrap inferiorDistancia Especifica la distancia (en puntos) entre el texto del documento y el borde inferior del área sin texto que rodea a la forma especificada.
leftDistance Especifica la distancia (en puntos) entre el texto del documento y el borde izquierdo del área sin texto que rodea a la forma especificada.
rightDistance Especifica la distancia (en puntos) entre el texto del documento y el borde derecho del área sin texto que rodea la forma especificada.
lateral Especifica si el texto del documento debe ajustarse en los dos lados de la forma especificada, en el lado izquierdo o derecho solamente, o en el lado de la forma que esté más alejado del margen de la página.
topDistance Especifica la distancia (en puntos) entre el texto del documento y el borde superior del área sin texto que rodea a la forma especificada.
type Especifica el tipo de ajuste de texto alrededor de la forma.
TextFrame autoSizeSetting Especifica la configuración automática de tamaño para el marco de texto.
bottomMargin Especifica el margen inferior, en puntos, del marco de texto.
hasText Devuelve true si el marco de texto contiene texto, de lo contrario, false.
leftMargin Especifica el margen izquierdo, en puntos, del marco de texto.
noTextRotation Especifica si el texto del marco de texto no debe girar cuando se gira la forma.
orientation Especifica el ángulo en el que se orienta el texto para el marco de texto.
rightMargin Especifica el margen derecho, en puntos, del marco de texto.
topMargin Especifica el margen superior, en puntos, del marco de texto.
verticalAlignment Especifica la alineación vertical del marco de texto.
Ajustar palabra Determina si las líneas se rompen automáticamente para ajustar el texto dentro de la forma.
Window ActivePane Obtiene el panel activo de la ventana.
Paneles Obtiene la colección de paneles en la ventana.
WindowCollection getFirst() Obtiene la primera ventana de esta colección.
getFirstOrNullObject() Obtiene la primera ventana de esta colección.
items Obtiene los elementos secundarios cargados en esta colección.

Vea también

  • Last updated on