Word.View class

Contiene los atributos de vista (por ejemplo, mostrar todos, sombreado de campo y cuadrículas de tabla) de una ventana o de un panel.

Extends

Propiedades

areAllNonprintingCharactersDisplayed

Especifica si se muestran todos los caracteres no imprimibles.

areBackgroundsDisplayed

Obtiene si se muestran colores e imágenes de fondo cuando el documento se muestra en la vista de diseño de impresión.

areBookmarksIndicated

Obtiene si se muestran corchetes al principio y al final de cada marcador.

areCommentsDisplayed

Especifica si Microsoft Word muestra los comentarios en el documento.

areConnectingLinesToRevisionsBalloonDisplayed

Especifica si Microsoft Word muestra las líneas de conexión del texto a los globos de revisión y comentarios.

areCropMarksDisplayed

Obtiene si las marcas de recorte se muestran en las esquinas de las páginas para indicar dónde se encuentran los márgenes.

areDrawingsDisplayed

Obtiene si los objetos creados con las herramientas de dibujo se muestran en la vista Diseño de impresión.

areEditableRangesShaded

Especifica si se aplica sombreado a los rangos del documento que los usuarios tienen permiso para modificar.

areFieldCodesDisplayed

Especifica si se muestran los códigos de campo.

areFormatChangesDisplayed

Especifica si Microsoft Word muestra los cambios de formato realizados en el documento con el control de cambios habilitado.

areInkAnnotationsDisplayed

Especifica si se muestran u ocultan las anotaciones manuscritas con lápiz.

areInsertionsAndDeletionsDisplayed

Especifica si Microsoft Word muestra las inserciones y eliminaciones realizadas en el documento con el control de cambios habilitado.

areLinesWrappedToWindow

Obtiene si las líneas se ajustan en el borde derecho de la ventana del documento en lugar de en el margen derecho o en el límite de la columna derecha.

areObjectAnchorsDisplayed

Obtiene si los delimitadores de objetos se muestran junto a los elementos que se pueden colocar en la vista de diseño de impresión.

areOptionalBreaksDisplayed

Obtiene si Microsoft Word muestra saltos de línea opcionales.

areOptionalHyphensDisplayed

Obtiene si se muestran guiones opcionales.

areOtherAuthorsVisible

Obtiene si la presencia de otros autores debe ser visible en el documento.

arePageBoundariesDisplayed

Obtiene si se muestran los márgenes superior e inferior y el área gris entre las páginas del documento.

areParagraphsMarksDisplayed

Obtiene si se muestran las marcas de párrafo.

arePicturePlaceholdersDisplayed

Obtiene si se muestran cuadros en blanco como marcadores de posición para las imágenes.

areRevisionsAndCommentsDisplayed

Especifica si Microsoft Word muestra las revisiones y los comentarios realizados en el documento con el control de cambios habilitado.

areSpacesIndicated

Obtiene si se muestran caracteres de espacio.

areTableGridlinesDisplayed

Especifica si se muestran las líneas de cuadrícula de la tabla.

areTabsDisplayed

Obtiene si se muestran los caracteres de tabulación.

areTextBoundariesDisplayed

Obtiene si se muestran líneas de puntos alrededor de los márgenes de página, las columnas de texto, los objetos y los marcos en la vista diseño de impresión.

columnWidth

Especifica el ancho de columna en modo de lectura.

context

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

fieldShading

Obtiene sombreado en pantalla para los campos.

isDraft

Especifica si todo el texto de una ventana se muestra en la misma fuente sin serifa con un formato mínimo para acelerar la visualización.

isFirstLineOnlyDisplayed

Especifica si solo se muestra la primera línea del texto de cuerpo en la vista Esquema.

isFormatDisplayed

Especifica si el formato de caracteres está visible en la vista Esquema.

isFullScreen

Especifica si la ventana está en vista de pantalla completa.

isHiddenTextDisplayed

Obtiene si se muestra texto con formato de texto oculto.

isHighlightingDisplayed

Obtiene si el formato de resaltado se muestra e imprime con el documento.

isInConflictMode

Especifica si el documento está en la vista de modo de conflicto.

isInPanning

Especifica si Microsoft Word está en modo de movimiento panorámico.

isInReadingLayout

Especifica si el documento se está visualizando en la vista Diseño de lectura.

isMailMergeDataView

Especifica si se muestran datos de combinación de correspondencia en lugar de campos de combinación de correspondencia.

isMainTextLayerVisible

Especifica si el texto del documento está visible cuando se muestran las áreas de encabezado y pie de página.

isPointerShownAsMagnifier

Especifica si el puntero se muestra como una lupa en la vista previa de impresión.

isReadingLayoutActualView

Especifica si las páginas mostradas en la vista diseño de lectura se muestran con el mismo diseño que las páginas impresas.

isXmlMarkupVisible

Especifica si las etiquetas XML están visibles en el documento.

markupMode

Especifica el modo de presentación para realizar seguimientos de cambios.

pageColor

Especifica el color de página en modo de lectura.

pageMovementType

Especifica el tipo de movimiento de página.

readingLayoutTruncateMargins

Especifica si los márgenes están visibles u ocultos cuando el documento se visualiza en la vista Lectura de pantalla completa.

revisionsBalloonSide

Obtiene si Word muestra globos de revisión en el margen izquierdo o derecho del documento.

revisionsBalloonWidth

Especifica el ancho de los globos de revisión.

revisionsBalloonWidthType

Especifica cómo mide Microsoft Word el ancho de los globos de revisión.

revisionsFilter

Obtiene la instancia de un RevisionsFilter objeto.

seekView

Especifica el elemento de documento que se muestra en la vista de diseño de impresión.

splitSpecial

Especifica el panel de la ventana activa.

type

Especifica el tipo de vista.

Métodos

collapseAllHeadings()

Contrae todos los títulos del documento.

collapseOutline(range)

Contrae un nivel de título el texto de la selección o del intervalo especificado.

expandAllHeadings()

Expande todos los títulos del documento.

expandOutline(range)

Expande un nivel de título el texto de la selección.

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

nextHeaderFooter()

Se desplaza al encabezado o pie de página siguiente, dependiendo de si en la vista se está mostrando un encabezado o pie de página.

previousHeaderFooter()

Se desplaza al encabezado o pie de página anterior, dependiendo de si en la vista se está mostrando un encabezado o pie de página.

set(properties, options)

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

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.

showAllHeadings()

Pasa de mostrar todo el texto (títulos y texto independiente) a sólo los títulos.

showHeading(level)

Muestra todos los títulos hasta el nivel especificado y oculta los títulos subordinados y el texto independiente.

toJSON()

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Word.View es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Word.Interfaces.ViewData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura de context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe 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 objeto 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.

untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es la abreviatura de 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. Deberá llamar context.sync() antes de que la liberación de memoria surta efecto.

Detalles de las propiedades

areAllNonprintingCharactersDisplayed

Especifica si se muestran todos los caracteres no imprimibles.

areAllNonprintingCharactersDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areBackgroundsDisplayed

Obtiene si se muestran colores e imágenes de fondo cuando el documento se muestra en la vista de diseño de impresión.

areBackgroundsDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areBookmarksIndicated

Obtiene si se muestran corchetes al principio y al final de cada marcador.

readonly areBookmarksIndicated: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areCommentsDisplayed

Especifica si Microsoft Word muestra los comentarios en el documento.

areCommentsDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areConnectingLinesToRevisionsBalloonDisplayed

Especifica si Microsoft Word muestra las líneas de conexión del texto a los globos de revisión y comentarios.

areConnectingLinesToRevisionsBalloonDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areCropMarksDisplayed

Obtiene si las marcas de recorte se muestran en las esquinas de las páginas para indicar dónde se encuentran los márgenes.

readonly areCropMarksDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areDrawingsDisplayed

Obtiene si los objetos creados con las herramientas de dibujo se muestran en la vista Diseño de impresión.

readonly areDrawingsDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areEditableRangesShaded

Especifica si se aplica sombreado a los rangos del documento que los usuarios tienen permiso para modificar.

areEditableRangesShaded: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areFieldCodesDisplayed

Especifica si se muestran los códigos de campo.

areFieldCodesDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areFormatChangesDisplayed

Especifica si Microsoft Word muestra los cambios de formato realizados en el documento con el control de cambios habilitado.

areFormatChangesDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areInkAnnotationsDisplayed

Especifica si se muestran u ocultan las anotaciones manuscritas con lápiz.

areInkAnnotationsDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areInsertionsAndDeletionsDisplayed

Especifica si Microsoft Word muestra las inserciones y eliminaciones realizadas en el documento con el control de cambios habilitado.

areInsertionsAndDeletionsDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areLinesWrappedToWindow

Obtiene si las líneas se ajustan en el borde derecho de la ventana del documento en lugar de en el margen derecho o en el límite de la columna derecha.

readonly areLinesWrappedToWindow: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areObjectAnchorsDisplayed

Obtiene si los delimitadores de objetos se muestran junto a los elementos que se pueden colocar en la vista de diseño de impresión.

readonly areObjectAnchorsDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areOptionalBreaksDisplayed

Obtiene si Microsoft Word muestra saltos de línea opcionales.

readonly areOptionalBreaksDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areOptionalHyphensDisplayed

Obtiene si se muestran guiones opcionales.

readonly areOptionalHyphensDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areOtherAuthorsVisible

Obtiene si la presencia de otros autores debe ser visible en el documento.

areOtherAuthorsVisible: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

arePageBoundariesDisplayed

Obtiene si se muestran los márgenes superior e inferior y el área gris entre las páginas del documento.

readonly arePageBoundariesDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areParagraphsMarksDisplayed

Obtiene si se muestran las marcas de párrafo.

readonly areParagraphsMarksDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

arePicturePlaceholdersDisplayed

Obtiene si se muestran cuadros en blanco como marcadores de posición para las imágenes.

readonly arePicturePlaceholdersDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areRevisionsAndCommentsDisplayed

Especifica si Microsoft Word muestra las revisiones y los comentarios realizados en el documento con el control de cambios habilitado.

areRevisionsAndCommentsDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areSpacesIndicated

Obtiene si se muestran caracteres de espacio.

readonly areSpacesIndicated: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areTableGridlinesDisplayed

Especifica si se muestran las líneas de cuadrícula de la tabla.

areTableGridlinesDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areTabsDisplayed

Obtiene si se muestran los caracteres de tabulación.

readonly areTabsDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

areTextBoundariesDisplayed

Obtiene si se muestran líneas de puntos alrededor de los márgenes de página, las columnas de texto, los objetos y los marcos en la vista diseño de impresión.

readonly areTextBoundariesDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

columnWidth

Especifica el ancho de columna en modo de lectura.

columnWidth: Word.ColumnWidth | "Narrow" | "Default" | "Wide";

Valor de propiedad

Word.ColumnWidth | "Narrow" | "Default" | "Wide"

Comentarios

Conjunto de API: WordApiDesktop 1.4

context

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

fieldShading

Obtiene sombreado en pantalla para los campos.

readonly fieldShading: Word.FieldShading | "Never" | "Always" | "WhenSelected";

Valor de propiedad

Word.FieldShading | "Never" | "Always" | "WhenSelected"

Comentarios

Conjunto de API: WordApiDesktop 1.4

isDraft

Especifica si todo el texto de una ventana se muestra en la misma fuente sin serifa con un formato mínimo para acelerar la visualización.

isDraft: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

isFirstLineOnlyDisplayed

Especifica si solo se muestra la primera línea del texto de cuerpo en la vista Esquema.

isFirstLineOnlyDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

isFormatDisplayed

Especifica si el formato de caracteres está visible en la vista Esquema.

isFormatDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

isFullScreen

Especifica si la ventana está en vista de pantalla completa.

isFullScreen: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

isHiddenTextDisplayed

Obtiene si se muestra texto con formato de texto oculto.

readonly isHiddenTextDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

isHighlightingDisplayed

Obtiene si el formato de resaltado se muestra e imprime con el documento.

readonly isHighlightingDisplayed: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

isInConflictMode

Especifica si el documento está en la vista de modo de conflicto.

isInConflictMode: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

isInPanning

Especifica si Microsoft Word está en modo de movimiento panorámico.

isInPanning: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

isInReadingLayout

Especifica si el documento se está visualizando en la vista Diseño de lectura.

isInReadingLayout: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

isMailMergeDataView

Especifica si se muestran datos de combinación de correspondencia en lugar de campos de combinación de correspondencia.

isMailMergeDataView: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

isMainTextLayerVisible

Especifica si el texto del documento está visible cuando se muestran las áreas de encabezado y pie de página.

isMainTextLayerVisible: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

isPointerShownAsMagnifier

Especifica si el puntero se muestra como una lupa en la vista previa de impresión.

isPointerShownAsMagnifier: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

isReadingLayoutActualView

Especifica si las páginas mostradas en la vista diseño de lectura se muestran con el mismo diseño que las páginas impresas.

isReadingLayoutActualView: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

isXmlMarkupVisible

Especifica si las etiquetas XML están visibles en el documento.

isXmlMarkupVisible: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

markupMode

Especifica el modo de presentación para realizar seguimientos de cambios.

markupMode: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed";

Valor de propiedad

Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"

Comentarios

Conjunto de API: WordApiDesktop 1.4

pageColor

Especifica el color de página en modo de lectura.

pageColor: Word.PageColor | "None" | "Sepia" | "Inverse";

Valor de propiedad

Word.PageColor | "None" | "Sepia" | "Inverse"

Comentarios

Conjunto de API: WordApiDesktop 1.4

pageMovementType

Especifica el tipo de movimiento de página.

pageMovementType: Word.PageMovementType | "Vertical" | "SideToSide";

Valor de propiedad

Word.PageMovementType | "Vertical" | "SideToSide"

Comentarios

Conjunto de API: WordApiDesktop 1.4

readingLayoutTruncateMargins

Especifica si los márgenes están visibles u ocultos cuando el documento se visualiza en la vista Lectura de pantalla completa.

readingLayoutTruncateMargins: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full";

Valor de propiedad

Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"

Comentarios

Conjunto de API: WordApiDesktop 1.4

revisionsBalloonSide

Obtiene si Word muestra globos de revisión en el margen izquierdo o derecho del documento.

readonly revisionsBalloonSide: Word.RevisionsBalloonMargin | "Left" | "Right";

Valor de propiedad

Word.RevisionsBalloonMargin | "Left" | "Right"

Comentarios

Conjunto de API: WordApiDesktop 1.4

revisionsBalloonWidth

Especifica el ancho de los globos de revisión.

revisionsBalloonWidth: number;

Valor de propiedad

number

Comentarios

Conjunto de API: WordApiDesktop 1.4

revisionsBalloonWidthType

Especifica cómo mide Microsoft Word el ancho de los globos de revisión.

revisionsBalloonWidthType: Word.RevisionsBalloonWidthType | "Percent" | "Points";

Valor de propiedad

Word.RevisionsBalloonWidthType | "Percent" | "Points"

Comentarios

Conjunto de API: WordApiDesktop 1.4

revisionsFilter

Obtiene la instancia de un RevisionsFilter objeto.

readonly revisionsFilter: Word.RevisionsFilter;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.4

seekView

Especifica el elemento de documento que se muestra en la vista de diseño de impresión.

seekView: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter";

Valor de propiedad

Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"

Comentarios

Conjunto de API: WordApiDesktop 1.4

splitSpecial

Especifica el panel de la ventana activa.

splitSpecial: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert";

Valor de propiedad

Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"

Comentarios

Conjunto de API: WordApiDesktop 1.4

type

Especifica el tipo de vista.

type: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict";

Valor de propiedad

Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"

Comentarios

Conjunto de API: WordApiDesktop 1.4

Detalles del método

collapseAllHeadings()

Contrae todos los títulos del documento.

collapseAllHeadings(): void;

Devoluciones

void

Comentarios

Conjunto de API: WordApiDesktop 1.4

collapseOutline(range)

Contrae un nivel de título el texto de la selección o del intervalo especificado.

collapseOutline(range: Word.Range): void;

Parámetros

range
Word.Range

Objeto Range que especifica el rango que se va a contraer.

Devoluciones

void

Comentarios

Conjunto de API: WordApiDesktop 1.4

expandAllHeadings()

Expande todos los títulos del documento.

expandAllHeadings(): void;

Devoluciones

void

Comentarios

Conjunto de API: WordApiDesktop 1.4

expandOutline(range)

Expande un nivel de título el texto de la selección.

expandOutline(range: Word.Range): void;

Parámetros

range
Word.Range

Objeto Range que especifica el rango que se va a expandir.

Devoluciones

void

Comentarios

Conjunto de API: WordApiDesktop 1.4

load(options)

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.ViewLoadOptions): Word.View;

Parámetros

options
Word.Interfaces.ViewLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

load(propertyNames)

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.View;

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

load(propertyNamesAndPaths)

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.View;

Parámetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

nextHeaderFooter()

Se desplaza al encabezado o pie de página siguiente, dependiendo de si en la vista se está mostrando un encabezado o pie de página.

nextHeaderFooter(): void;

Devoluciones

void

Comentarios

Conjunto de API: WordApiDesktop 1.4

previousHeaderFooter()

Se desplaza al encabezado o pie de página anterior, dependiendo de si en la vista se está mostrando un encabezado o pie de página.

previousHeaderFooter(): void;

Devoluciones

void

Comentarios

Conjunto de API: WordApiDesktop 1.4

set(properties, options)

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

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

Parámetros

properties
Word.Interfaces.ViewUpdateData

Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el que se llama al método.

options
OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.

set(properties: Word.View): void;

Parámetros

properties
Word.View

Devoluciones

void

showAllHeadings()

Pasa de mostrar todo el texto (títulos y texto independiente) a sólo los títulos.

showAllHeadings(): void;

Devoluciones

void

Comentarios

Conjunto de API: WordApiDesktop 1.4

showHeading(level)

Muestra todos los títulos hasta el nivel especificado y oculta los títulos subordinados y el texto independiente.

showHeading(level: number): void;

Parámetros

level

number

El nivel de título que se va a mostrar.

Devoluciones

void

Comentarios

Conjunto de API: WordApiDesktop 1.4

toJSON()

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Word.View es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Word.Interfaces.ViewData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Word.Interfaces.ViewData;

Devoluciones

track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura de context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe 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 objeto 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.View;

Devoluciones

untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es la abreviatura de 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. Deberá llamar context.sync() antes de que la liberación de memoria surta efecto.

untrack(): Word.View;

Devoluciones