Compartir a través de

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

  • Artículo

El WordApiDesktop conjunto de requisitos es un conjunto de requisitos especial 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 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 WordApiDesktop conjunto de requisitos se admiten en 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 etiquetadas en este WordApiDesktop conjunto de requisitos. Para 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 de solo 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 de solo escritorio en una plataforma no admitida.

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

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

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 Word incluidas actualmente en el conjunto de WordApiDesktop 1.2 requisitos. Para obtener una lista completa de todas las API de JavaScript Word (incluidas WordApiDesktop 1.2 las API y las API publicadas anteriormente), consulte todas las API de JavaScript Word.

Clase Campos Descripción
Cuerpo shapes Obtiene la colección de objetos de forma en el cuerpo, incluidas las formas insertadas y flotantes.
Canvas id Obtiene un entero que representa el identificador del lienzo.
shape Obtiene el objeto Shape asociado al lienzo.
shapes Obtiene la colección de 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 para el documento.
InsertShapeOptions height Representa el alto de la forma que se va a insertar.
left Representa la posición izquierda de la forma que se va a insertar.
top Representa la posición superior de la forma que se va a insertar.
width Representa el ancho de la forma que se va a insertar.
Page getNext() Obtiene la página siguiente del panel.
getNextOrNullObject() Obtiene la página siguiente.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | "Entero" | "Iniciar" | "End") Obtiene toda la página, o el punto inicial o final de la página, como un intervalo.
height Obtiene el alto, en puntos, del papel definido 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 panel siguiente de la ventana.
getNextOrNullObject() Obtiene el panel siguiente.
pages Obtiene la colección de páginas del panel.
pagesEnclosingViewport Obtiene el que PageCollection se muestra en la ventanilla del panel.
PaneCollection 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 objetos de forma delimitados en el párrafo, incluidas las formas insertadas y flotantes.
Rango insertCanvas(insertShapeOptions?: Word. InsertShapeOptions) Inserta un lienzo flotante delante del texto con su delimitador al principio del intervalo.
insertGeometricShape(geometricShapeType: Word. GeometricShapeType, insertShapeOptions?: Word. InsertShapeOptions) Inserta una forma geométrica delante del texto con su delimitador al principio del intervalo.
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word. InsertShapeOptions) Inserta una imagen flotante delante del texto con su delimitador al principio del intervalo.
insertTextBox(text?: string, insertShapeOptions?: Word. InsertShapeOptions) Inserta un cuadro de texto flotante delante del texto con su delimitador al principio del intervalo.
pages Obtiene la colección de páginas del intervalo.
shapes Obtiene la colección de objetos de forma delimitados en el intervalo, incluidas las formas insertadas y flotantes.
Shape allowOverlap Especifica si una forma determinada puede superponerse a otras formas.
altTextDescription Especifica una cadena que representa el texto alternativo asociado a la forma.
body Representa el objeto de cuerpo de la forma.
lona Obtiene el lienzo asociado a la forma.
delete() Elimina la forma y su contenido.
fill Devuelve el formato de relleno de la forma.
geometricShapeType Tipo de forma geométrica de la forma.
height Alto, en puntos, de la forma.
heightRelative El porcentaje de altura de la forma en tamaño relativo vertical, consulte Word. RelativeSize.
id Obtiene un entero que representa el identificador de forma.
isChild Compruebe si esta forma es secundaria de una forma de grupo o de lienzo.
left La distancia, en puntos, desde el lado izquierdo de la forma hasta la posición relativa horizontal, vea Word. RelativeHorizontalPosition.
leftRelative La posición relativa izquierda como porcentaje desde el lado izquierdo de la forma hasta la posición relativa horizontal, vea Word. RelativeHorizontalPosition.
lockAspectRatio Especifica si la relación de aspecto de esta forma está bloqueada.
moveHorizontally(distance: number) Mueve la forma horizontalmente por el número de puntos.
moveVertically(distance: number) Mueve la forma verticalmente por el número de puntos.
name Nombre de la forma.
parentCanvas Obtiene la forma del lienzo primario de nivel superior de esta forma secundaria.
parentGroup Obtiene la forma de grupo primario de nivel superior de esta forma secundaria.
relativeHorizontalPosition Posición horizontal relativa de la forma.
relativeHorizontalSize Tamaño horizontal relativo de la forma.
relativeVerticalPosition Posición vertical relativa de la forma.
relativeVerticalSize Tamaño vertical relativo de la forma.
rotation Especifica la rotación, 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.
shapeGroup Obtiene el grupo de formas asociado a la forma.
textFrame Obtiene el objeto de marco de texto de la forma.
textWrap Devuelve el formato de ajuste de texto de la forma.
top La distancia, en puntos, desde el borde superior de la forma hasta la posición relativa vertical, vea Word. RelativeVerticalPosition.
topRelative La posición superior relativa como un porcentaje desde el borde superior de la forma hasta la posición relativa vertical, vea Word. RelativeVerticalPosition.
type Obtiene el tipo de forma.
visible Especifica si la forma está visible.
width Ancho, en puntos, de la forma.
widthRelative El porcentaje de ancho de forma a tamaño relativo horizontal, consulte Word. RelativeSize.
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() Se omitirán las formas flotantes de grupos de esta colección.
items Obtiene los elementos secundarios cargados en esta colección.
ShapeFill backgroundColor Especifica el color de fondo de relleno de forma.
clear() Borra el formato de relleno de esta forma y la Word.ShapeFillType.NoFillestablece en ;
foregroundColor Especifica el color de primer plano del relleno de formas.
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 de 0,0 (opaco) a 1,0 (claro).
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 objeto Shape asociado al grupo.
shapes Obtiene la colección de objetos Shape.
ungroup() Desagrupa las formas agrupadas en el grupo de formas especificado.
ShapeTextWrap bottomDistance Especifica la distancia (en puntos) entre el texto del documento y el borde inferior del área sin texto que rodea la forma especificada.
leftDistance Especifica la distancia (en puntos) entre el texto del documento y el borde izquierdo del área sin texto que rodea 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.
lado Especifica si el texto del documento debe ajustarse a ambos lados de la forma especificada, solo en el lado izquierdo o derecho, o en el lado de la forma más alejada 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 la forma especificada.
type Especifica el tipo de ajuste de texto alrededor de la forma.
TextFrame autoSizeSetting La configuración de ajuste de tamaño automático para el marco de texto.
bottomMargin Indica el margen inferior, en puntos, del marco de texto.
hasText Especifica si el marco de texto contiene texto.
leftMargin Indica el margen izquierdo, en puntos, del marco de texto.
noTextRotation Devuelve True si el texto del marco de texto no debe girar cuando se gira la forma.
orientation Representa el ángulo al que está orientado el texto para el marco de texto.
rightMargin Indica el margen derecho, en puntos, del marco de texto.
topMargin Indica el margen superior, en puntos, del marco de texto.
verticalAlignment Indica la alineación vertical del marco de texto.
wordWrap Determina si las líneas se interrumpen 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 de 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