Word.View class

Contém os atributos de exibição (como mostrar tudo, sombreamento de campo e linhas de grade de tabela) para uma janela ou um painel.

Extends

Propriedades

areAllNonprintingCharactersDisplayed

Especifica se todos os caracteres não imprimíveis são exibidos.

areBackgroundsDisplayed

Obtém se as cores e imagens da tela de fundo são mostradas quando o documento é exibido no modo de exibição de layout de impressão.

areBookmarksIndicated

Obtém se os colchetes são exibidos no início e no final de cada indicador.

areCommentsDisplayed

Especifica se o Microsoft Word exibe os comentários no documento.

areConnectingLinesToRevisionsBalloonDisplayed

Especifica se o Microsoft Word exibe linhas de conexão do texto para os balões de revisão e comentário.

areCropMarksDisplayed

Obtém se as marcas de corte são mostradas nos cantos das páginas para indicar onde as margens estão localizadas.

areDrawingsDisplayed

Obtém se os objetos criados com as ferramentas de desenho são exibidos no modo de exibição de layout de impressão.

areEditableRangesShaded

Especifica se o sombreamento é aplicado aos intervalos no documento que os usuários têm permissão para modificar.

areFieldCodesDisplayed

Especifica se os códigos de campo são exibidos.

areFormatChangesDisplayed

Especifica se o Microsoft Word exibe as alterações de formatação feitas no documento com o recurso Controlar Alterações habilitado.

areInkAnnotationsDisplayed

Especifica se as anotações à tinta manuscritas são mostradas ou ocultas.

areInsertionsAndDeletionsDisplayed

Especifica se o Microsoft Word exibe inserções e exclusões feitas no documento com o recurso Controlar Alterações habilitado.

areLinesWrappedToWindow

Obtém se as linhas quebram na borda direita da janela do documento, em vez de na margem direita ou no limite da coluna direita.

areObjectAnchorsDisplayed

Obtém se as âncoras de objeto são exibidas ao lado de itens que podem ser posicionados no modo de exibição de layout de impressão.

areOptionalBreaksDisplayed

Determina se o Microsoft Word exibe quebras de linha opcionais.

areOptionalHyphensDisplayed

Obtém se hifens opcionais são exibidos.

areOtherAuthorsVisible

Determina se a presença de outros autores deve estar visível no documento.

arePageBoundariesDisplayed

Obtém se as margens superior e inferior e a área cinza entre as páginas do documento são exibidas.

areParagraphsMarksDisplayed

Obtém se as marcas de parágrafo são exibidas.

arePicturePlaceholdersDisplayed

Determina se as caixas em branco são exibidas como espaços reservados para imagens.

areRevisionsAndCommentsDisplayed

Especifica se o Microsoft Word exibe revisões e comentários feitos no documento com o recurso Controlar Alterações habilitado.

areSpacesIndicated

Obtém se os caracteres de espaço são exibidos.

areTableGridlinesDisplayed

Especifica se as linhas de grade da tabela são exibidas.

areTabsDisplayed

Obtém se os caracteres de tabulação são exibidos.

areTextBoundariesDisplayed

Obtém se as linhas pontilhadas são exibidas ao redor das margens da página, colunas de texto, objetos e quadros no modo de exibição de layout de impressão.

columnWidth

Especifica a largura da coluna no modo de Leitura.

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

fieldShading

Obtém sombreamento na tela para campos.

isDraft

Especifica se todo o texto em uma janela é exibido na mesma fonte sem serifa com formatação mínima para acelerar a exibição.

isFirstLineOnlyDisplayed

Especifica se apenas a primeira linha do corpo do texto é mostrada no modo de exibição de estrutura de tópicos.

isFormatDisplayed

Especifica se a formatação de caracteres é visível no modo de exibição de estrutura de tópicos.

isFullScreen

Especifica se a janela está no modo de exibição de tela inteira.

isHiddenTextDisplayed

Obtém se o texto formatado como texto oculto é exibido.

isHighlightingDisplayed

Obtém se a formatação de destaque é exibida e impressa com o documento.

isInConflictMode

Especifica se o documento está no modo de exibição de conflito.

isInPanning

Especifica se o Microsoft Word está no modo Movimento panorâmico.

isInReadingLayout

Especifica se o documento está sendo exibido no modo de exibição de layout de leitura.

isMailMergeDataView

Especifica se os dados de mala direta são exibidos em vez de campos de mala direta.

isMainTextLayerVisible

Especifica se o texto no documento fica visível quando as áreas de cabeçalho e rodapé são exibidas.

isPointerShownAsMagnifier

Especifica se o ponteiro é exibido como uma lupa na visualização de impressão.

isReadingLayoutActualView

Especifica se as páginas exibidas no modo de exibição de layout de leitura são exibidas usando o mesmo layout das páginas impressas.

isXmlMarkupVisible

Especifica se as marcas XML estão visíveis no documento.

markupMode

Especifica o modo de exibição das alterações controladas.

pageColor

Especifica a cor da página no modo de Leitura.

pageMovementType

Especifica o tipo de movimento da página.

readingLayoutTruncateMargins

Especifica se as margens são visíveis ou ocultas quando o documento é exibido no modo de exibição de Leitura de Tela Inteira.

revisionsBalloonSide

Determina se o Word exibe balões de revisão na margem esquerda ou direita do documento.

revisionsBalloonWidth

Especifica a largura dos balões de revisão.

revisionsBalloonWidthType

Especifica como o Microsoft Word mede a largura dos balões de revisão.

revisionsFilter

Obtém a instância de um RevisionsFilter objeto.

seekView

Especifica o elemento do documento exibido no modo de exibição layout de impressão.

splitSpecial

Especifica o painel de janela ativo.

type

Especifica o tipo do modo de exibição.

Métodos

collapseAllHeadings()

Recolhe todos os títulos no documento.

collapseOutline(range)

Recolhe em um nível de título o texto da seleção ou o intervalo especificado.

expandAllHeadings()

Expande todos os títulos no documento.

expandOutline(range)

Expanda o texto sob a seleção por um nível de cabeçalho.

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

nextHeaderFooter()

Move para o próximo cabeçalho ou rodapé, dependendo se um cabeçalho ou rodapé é exibido na tela.

previousHeaderFooter()

Move para o cabeçalho ou rodapé anterior, dependendo se um cabeçalho ou rodapé é exibido na tela.

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

showAllHeadings()

Alterna entre mostrar todo o texto (títulos e corpo de texto) e mostrar somente os títulos.

showHeading(level)

Mostra todos os títulos até o nível de título especificado e oculta o corpo de texto e os títulos subordinados.

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Word.View é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.ViewData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará ligar context.sync() antes que a liberação de memória entre em vigor.

Detalhes da propriedade

areAllNonprintingCharactersDisplayed

Especifica se todos os caracteres não imprimíveis são exibidos.

areAllNonprintingCharactersDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areBackgroundsDisplayed

Obtém se as cores e imagens da tela de fundo são mostradas quando o documento é exibido no modo de exibição de layout de impressão.

areBackgroundsDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areBookmarksIndicated

Obtém se os colchetes são exibidos no início e no final de cada indicador.

readonly areBookmarksIndicated: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areCommentsDisplayed

Especifica se o Microsoft Word exibe os comentários no documento.

areCommentsDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areConnectingLinesToRevisionsBalloonDisplayed

Especifica se o Microsoft Word exibe linhas de conexão do texto para os balões de revisão e comentário.

areConnectingLinesToRevisionsBalloonDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areCropMarksDisplayed

Obtém se as marcas de corte são mostradas nos cantos das páginas para indicar onde as margens estão localizadas.

readonly areCropMarksDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areDrawingsDisplayed

Obtém se os objetos criados com as ferramentas de desenho são exibidos no modo de exibição de layout de impressão.

readonly areDrawingsDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areEditableRangesShaded

Especifica se o sombreamento é aplicado aos intervalos no documento que os usuários têm permissão para modificar.

areEditableRangesShaded: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areFieldCodesDisplayed

Especifica se os códigos de campo são exibidos.

areFieldCodesDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areFormatChangesDisplayed

Especifica se o Microsoft Word exibe as alterações de formatação feitas no documento com o recurso Controlar Alterações habilitado.

areFormatChangesDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areInkAnnotationsDisplayed

Especifica se as anotações à tinta manuscritas são mostradas ou ocultas.

areInkAnnotationsDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areInsertionsAndDeletionsDisplayed

Especifica se o Microsoft Word exibe inserções e exclusões feitas no documento com o recurso Controlar Alterações habilitado.

areInsertionsAndDeletionsDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areLinesWrappedToWindow

Obtém se as linhas quebram na borda direita da janela do documento, em vez de na margem direita ou no limite da coluna direita.

readonly areLinesWrappedToWindow: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areObjectAnchorsDisplayed

Obtém se as âncoras de objeto são exibidas ao lado de itens que podem ser posicionados no modo de exibição de layout de impressão.

readonly areObjectAnchorsDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areOptionalBreaksDisplayed

Determina se o Microsoft Word exibe quebras de linha opcionais.

readonly areOptionalBreaksDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areOptionalHyphensDisplayed

Obtém se hifens opcionais são exibidos.

readonly areOptionalHyphensDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areOtherAuthorsVisible

Determina se a presença de outros autores deve estar visível no documento.

areOtherAuthorsVisible: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

arePageBoundariesDisplayed

Obtém se as margens superior e inferior e a área cinza entre as páginas do documento são exibidas.

readonly arePageBoundariesDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areParagraphsMarksDisplayed

Obtém se as marcas de parágrafo são exibidas.

readonly areParagraphsMarksDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

arePicturePlaceholdersDisplayed

Determina se as caixas em branco são exibidas como espaços reservados para imagens.

readonly arePicturePlaceholdersDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areRevisionsAndCommentsDisplayed

Especifica se o Microsoft Word exibe revisões e comentários feitos no documento com o recurso Controlar Alterações habilitado.

areRevisionsAndCommentsDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areSpacesIndicated

Obtém se os caracteres de espaço são exibidos.

readonly areSpacesIndicated: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areTableGridlinesDisplayed

Especifica se as linhas de grade da tabela são exibidas.

areTableGridlinesDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areTabsDisplayed

Obtém se os caracteres de tabulação são exibidos.

readonly areTabsDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areTextBoundariesDisplayed

Obtém se as linhas pontilhadas são exibidas ao redor das margens da página, colunas de texto, objetos e quadros no modo de exibição de layout de impressão.

readonly areTextBoundariesDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

columnWidth

Especifica a largura da coluna no modo de Leitura.

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

Valor da propriedade

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

Comentários

Conjunto de APIs: WordApiDesktop 1.4

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

fieldShading

Obtém sombreamento na tela para campos.

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

Valor da propriedade

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

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isDraft

Especifica se todo o texto em uma janela é exibido na mesma fonte sem serifa com formatação mínima para acelerar a exibição.

isDraft: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isFirstLineOnlyDisplayed

Especifica se apenas a primeira linha do corpo do texto é mostrada no modo de exibição de estrutura de tópicos.

isFirstLineOnlyDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isFormatDisplayed

Especifica se a formatação de caracteres é visível no modo de exibição de estrutura de tópicos.

isFormatDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isFullScreen

Especifica se a janela está no modo de exibição de tela inteira.

isFullScreen: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isHiddenTextDisplayed

Obtém se o texto formatado como texto oculto é exibido.

readonly isHiddenTextDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isHighlightingDisplayed

Obtém se a formatação de destaque é exibida e impressa com o documento.

readonly isHighlightingDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isInConflictMode

Especifica se o documento está no modo de exibição de conflito.

isInConflictMode: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isInPanning

Especifica se o Microsoft Word está no modo Movimento panorâmico.

isInPanning: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isInReadingLayout

Especifica se o documento está sendo exibido no modo de exibição de layout de leitura.

isInReadingLayout: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isMailMergeDataView

Especifica se os dados de mala direta são exibidos em vez de campos de mala direta.

isMailMergeDataView: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isMainTextLayerVisible

Especifica se o texto no documento fica visível quando as áreas de cabeçalho e rodapé são exibidas.

isMainTextLayerVisible: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isPointerShownAsMagnifier

Especifica se o ponteiro é exibido como uma lupa na visualização de impressão.

isPointerShownAsMagnifier: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isReadingLayoutActualView

Especifica se as páginas exibidas no modo de exibição de layout de leitura são exibidas usando o mesmo layout das páginas impressas.

isReadingLayoutActualView: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isXmlMarkupVisible

Especifica se as marcas XML estão visíveis no documento.

isXmlMarkupVisible: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

markupMode

Especifica o modo de exibição das alterações controladas.

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

Valor da propriedade

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

Comentários

Conjunto de APIs: WordApiDesktop 1.4

pageColor

Especifica a cor da página no modo de Leitura.

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

Valor da propriedade

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

Comentários

Conjunto de APIs: WordApiDesktop 1.4

pageMovementType

Especifica o tipo de movimento da página.

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

Valor da propriedade

Word.PageMovementType | "Vertical" | "SideToSide"

Comentários

Conjunto de APIs: WordApiDesktop 1.4

readingLayoutTruncateMargins

Especifica se as margens são visíveis ou ocultas quando o documento é exibido no modo de exibição de Leitura de Tela Inteira.

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

Valor da propriedade

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

Comentários

Conjunto de APIs: WordApiDesktop 1.4

revisionsBalloonSide

Determina se o Word exibe balões de revisão na margem esquerda ou direita do documento.

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

Valor da propriedade

Word.RevisionsBalloonMargin | "Left" | "Right"

Comentários

Conjunto de APIs: WordApiDesktop 1.4

revisionsBalloonWidth

Especifica a largura dos balões de revisão.

revisionsBalloonWidth: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApiDesktop 1.4

revisionsBalloonWidthType

Especifica como o Microsoft Word mede a largura dos balões de revisão.

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

Valor da propriedade

Word.RevisionsBalloonWidthType | "Percent" | "Points"

Comentários

Conjunto de APIs: WordApiDesktop 1.4

revisionsFilter

Obtém a instância de um RevisionsFilter objeto.

readonly revisionsFilter: Word.RevisionsFilter;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.4

seekView

Especifica o elemento do documento exibido no modo de exibição layout de impressão.

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

Valor da propriedade

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

Comentários

Conjunto de APIs: WordApiDesktop 1.4

splitSpecial

Especifica o painel de janela ativo.

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 da propriedade

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

Comentários

Conjunto de APIs: WordApiDesktop 1.4

type

Especifica o tipo do modo de exibição.

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

Valor da propriedade

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

Comentários

Conjunto de APIs: WordApiDesktop 1.4

Detalhes do método

collapseAllHeadings()

Recolhe todos os títulos no documento.

collapseAllHeadings(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

collapseOutline(range)

Recolhe em um nível de título o texto da seleção ou o intervalo especificado.

collapseOutline(range: Word.Range): void;

Parâmetros

range
Word.Range

Um Range objeto que especifica o intervalo a ser recolhido.

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

expandAllHeadings()

Expande todos os títulos no documento.

expandAllHeadings(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

expandOutline(range)

Expanda o texto sob a seleção por um nível de cabeçalho.

expandOutline(range: Word.Range): void;

Parâmetros

range
Word.Range

Um Range objeto que especifica o intervalo a ser expandido.

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Word.Interfaces.ViewLoadOptions): Word.View;

Parâmetros

options
Word.Interfaces.ViewLoadOptions

Fornece opções para quais propriedades do objeto devem ser carregadas.

Retornos

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames

string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.

Retornos

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.

Retornos

nextHeaderFooter()

Move para o próximo cabeçalho ou rodapé, dependendo se um cabeçalho ou rodapé é exibido na tela.

nextHeaderFooter(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

previousHeaderFooter()

Move para o cabeçalho ou rodapé anterior, dependendo se um cabeçalho ou rodapé é exibido na tela.

previousHeaderFooter(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

properties
Word.Interfaces.ViewUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Word.View): void;

Parâmetros

properties
Word.View

Retornos

void

showAllHeadings()

Alterna entre mostrar todo o texto (títulos e corpo de texto) e mostrar somente os títulos.

showAllHeadings(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

showHeading(level)

Mostra todos os títulos até o nível de título especificado e oculta o corpo de texto e os títulos subordinados.

showHeading(level: number): void;

Parâmetros

level

number

O nível do título a ser mostrado.

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Word.View é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.ViewData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.ViewData;

Retornos

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.

track(): Word.View;

Retornos

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará ligar context.sync() antes que a liberação de memória entre em vigor.

untrack(): Word.View;

Retornos