Word.View class

Содержит атрибуты представления (например, показать все, затенение полей и линии сетки таблицы) для окна или области.

Extends

Комментарии

Набор API: WordApiDesktop 1.4

Используется

Свойства

areAllNonprintingCharactersDisplayed

Указывает, отображаются ли все непечатные символы.

areBackgroundsDisplayed

Возвращает значение, указывающее, отображаются ли цвета фона и изображения при отображении документа в режиме печати.

areBookmarksIndicated

Возвращает значение, указывающее, отображаются ли квадратные скобки в начале и конце каждой закладки.

areCommentsDisplayed

Указывает, отображает ли microsoft Word примечания в документе.

areConnectingLinesToRevisionsBalloonDisplayed

Указывает, отображает ли Microsoft Word соединительные строки из текста с выносками редакции и комментариев.

areCropMarksDisplayed

Возвращает значение, указывающее, отображаются ли метки обрезки в углах страниц, чтобы указать, где находятся поля.

areDrawingsDisplayed

Возвращает значение, указывающее, отображаются ли в режиме макета печати объекты, созданные с помощью инструментов рисования.

areEditableRangesShaded

Указывает, применяется ли затенение к диапазонам в документе, которые пользователи имеют разрешение на изменение.

areFieldCodesDisplayed

Указывает, отображаются ли коды полей.

areFormatChangesDisplayed

Указывает, отображает ли Microsoft Word изменения форматирования, внесенные в документ с включенным отслеживанием изменений.

areInkAnnotationsDisplayed

Указывает, отображаются или скрыты рукописные заметки.

areInsertionsAndDeletionsDisplayed

Указывает, отображает ли Microsoft Word вставки и удаления, сделанные в документе с включенным отслеживанием изменений.

areLinesWrappedToWindow

Возвращает значение, указывающее, является ли строка оболочкой правого края окна документа, а не правого поля или правой границы столбца.

areObjectAnchorsDisplayed

Возвращает значение, указывающее, отображаются ли привязки объектов рядом с элементами, которые можно разместить в режиме макета печати.

areOptionalBreaksDisplayed

Возвращает значение, указывающее, отображает ли Microsoft Word необязательные разрывы строк.

areOptionalHyphensDisplayed

Возвращает значение, указывающее, отображаются ли необязательные дефисы.

areOtherAuthorsVisible

Возвращает значение, указывающее, должно ли в документе отображаться присутствие других авторов.

arePageBoundariesDisplayed

Возвращает значение, указывающее, отображаются ли верхние и нижние поля и серая область между страницами в документе.

areParagraphsMarksDisplayed

Возвращает значение, указывающее, отображаются ли знаки абзаца.

arePicturePlaceholdersDisplayed

Возвращает значение, указывающее, отображаются ли пустые поля в качестве заполнителей для рисунков.

areRevisionsAndCommentsDisplayed

Указывает, отображает ли microsoft Word исправления и комментарии к документу с включенным отслеживанием изменений.

areSpacesIndicated

Возвращает значение, указывающее, отображаются ли пробелы.

areTableGridlinesDisplayed

Указывает, отображаются ли линии сетки таблицы.

areTabsDisplayed

Возвращает значение, указывающее, отображаются ли символы табуляции.

areTextBoundariesDisplayed

Возвращает значение, указывающее, отображаются ли пунктирные линии вокруг полей страницы, текстовых столбцов, объектов и кадров в режиме макета печати.

columnWidth

Задает ширину столбца в режиме чтения.

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

fieldShading

Получает затенение на экране для полей.

isDraft

Указывает, отображается ли весь текст в окне тем же шрифтом без засечек с минимальным форматированием для ускорения отображения.

isFirstLineOnlyDisplayed

Указывает, отображается ли только первая строка основного текста в режиме структуры.

isFormatDisplayed

Указывает, отображается ли форматирование символов в режиме структуры.

isFullScreen

Указывает, находится ли окно в полноэкранном режиме.

isHiddenTextDisplayed

Возвращает значение, указывающее, отображается ли текст, отформатированный как скрытый.

isHighlightingDisplayed

Возвращает значение, указывающее, отображается ли форматирование выделения и выводится на печать вместе с документом.

isInConflictMode

Указывает, находится ли документ в режиме конфликта.

isInPanning

Указывает, находится ли microsoft Word в режиме сдвига.

isInReadingLayout

Указывает, просматривается ли документ в режиме макета чтения.

isMailMergeDataView

Указывает, отображаются ли данные слияния вместо полей слияния.

isMainTextLayerVisible

Указывает, отображается ли текст в документе при отображении областей верхнего и нижнего колонтитулов.

isPointerShownAsMagnifier

Указывает, отображается ли указатель в виде лупы при предварительном просмотре.

isReadingLayoutActualView

Указывает, отображаются ли страницы, отображаемые в режиме чтения, с использованием того же макета, что и печатные страницы.

isXmlMarkupVisible

Указывает, отображаются ли XML-теги в документе.

markupMode

Указывает режим отображения отслеживаемых изменений.

pageColor

Задает цвет страницы в режиме чтения.

pageMovementType

Указывает тип перемещения страницы.

readingLayoutTruncateMargins

Указывает, будут ли поля видимыми или скрытыми при просмотре документа в режиме полноэкранного чтения.

revisionsBalloonSide

Возвращает значение, указывающее, отображает ли Word всплывающие окна редакции в левом или правом поле документа.

revisionsBalloonWidth

Задает ширину всплывок редакции.

revisionsBalloonWidthType

Указывает, как Microsoft Word измеряет ширину выносок редакции.

revisionsFilter

Возвращает экземпляр RevisionsFilter объекта .

seekView

Указывает элемент документа, отображаемый в режиме макета печати.

splitSpecial

Указывает активную область окна.

type

Указывает тип представления.

Методы

collapseAllHeadings()

Сворачивает все заголовки в документе.

collapseOutline(range)

Сворачивает текст под выделенным фрагментом или заданным диапазоном на один уровень заголовка.

expandAllHeadings()

Разворачивает все заголовки в документе.

expandOutline(range)

Расширяет текст под выделенным фрагментом на один уровень заголовка.

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

nextHeaderFooter()

Перемещается в следующий верхний или нижний колонтитул в зависимости от того, отображается ли в представлении верхний или нижний колонтитул.

previousHeaderFooter()

Перемещается к предыдущему верхнему или нижнему колонтитулов в зависимости от того, отображается ли в представлении колонтитул.

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

showAllHeadings()

Переключается между отображением всего текста (заголовков и основного текста) и отображением только заголовков.

showHeading(level)

Отображает все заголовки до указанного уровня заголовка и скрывает подчиненные заголовки и основной текст.

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.View объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.ViewData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

Сведения о свойстве

areAllNonprintingCharactersDisplayed

Указывает, отображаются ли все непечатные символы.

areAllNonprintingCharactersDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areBackgroundsDisplayed

Возвращает значение, указывающее, отображаются ли цвета фона и изображения при отображении документа в режиме печати.

areBackgroundsDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areBookmarksIndicated

Возвращает значение, указывающее, отображаются ли квадратные скобки в начале и конце каждой закладки.

readonly areBookmarksIndicated: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areCommentsDisplayed

Указывает, отображает ли microsoft Word примечания в документе.

areCommentsDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areConnectingLinesToRevisionsBalloonDisplayed

Указывает, отображает ли Microsoft Word соединительные строки из текста с выносками редакции и комментариев.

areConnectingLinesToRevisionsBalloonDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areCropMarksDisplayed

Возвращает значение, указывающее, отображаются ли метки обрезки в углах страниц, чтобы указать, где находятся поля.

readonly areCropMarksDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areDrawingsDisplayed

Возвращает значение, указывающее, отображаются ли в режиме макета печати объекты, созданные с помощью инструментов рисования.

readonly areDrawingsDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areEditableRangesShaded

Указывает, применяется ли затенение к диапазонам в документе, которые пользователи имеют разрешение на изменение.

areEditableRangesShaded: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areFieldCodesDisplayed

Указывает, отображаются ли коды полей.

areFieldCodesDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areFormatChangesDisplayed

Указывает, отображает ли Microsoft Word изменения форматирования, внесенные в документ с включенным отслеживанием изменений.

areFormatChangesDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areInkAnnotationsDisplayed

Указывает, отображаются или скрыты рукописные заметки.

areInkAnnotationsDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areInsertionsAndDeletionsDisplayed

Указывает, отображает ли Microsoft Word вставки и удаления, сделанные в документе с включенным отслеживанием изменений.

areInsertionsAndDeletionsDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areLinesWrappedToWindow

Возвращает значение, указывающее, является ли строка оболочкой правого края окна документа, а не правого поля или правой границы столбца.

readonly areLinesWrappedToWindow: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areObjectAnchorsDisplayed

Возвращает значение, указывающее, отображаются ли привязки объектов рядом с элементами, которые можно разместить в режиме макета печати.

readonly areObjectAnchorsDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areOptionalBreaksDisplayed

Возвращает значение, указывающее, отображает ли Microsoft Word необязательные разрывы строк.

readonly areOptionalBreaksDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areOptionalHyphensDisplayed

Возвращает значение, указывающее, отображаются ли необязательные дефисы.

readonly areOptionalHyphensDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areOtherAuthorsVisible

Возвращает значение, указывающее, должно ли в документе отображаться присутствие других авторов.

areOtherAuthorsVisible: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

arePageBoundariesDisplayed

Возвращает значение, указывающее, отображаются ли верхние и нижние поля и серая область между страницами в документе.

readonly arePageBoundariesDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areParagraphsMarksDisplayed

Возвращает значение, указывающее, отображаются ли знаки абзаца.

readonly areParagraphsMarksDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

arePicturePlaceholdersDisplayed

Возвращает значение, указывающее, отображаются ли пустые поля в качестве заполнителей для рисунков.

readonly arePicturePlaceholdersDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areRevisionsAndCommentsDisplayed

Указывает, отображает ли microsoft Word исправления и комментарии к документу с включенным отслеживанием изменений.

areRevisionsAndCommentsDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areSpacesIndicated

Возвращает значение, указывающее, отображаются ли пробелы.

readonly areSpacesIndicated: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areTableGridlinesDisplayed

Указывает, отображаются ли линии сетки таблицы.

areTableGridlinesDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areTabsDisplayed

Возвращает значение, указывающее, отображаются ли символы табуляции.

readonly areTabsDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

areTextBoundariesDisplayed

Возвращает значение, указывающее, отображаются ли пунктирные линии вокруг полей страницы, текстовых столбцов, объектов и кадров в режиме макета печати.

readonly areTextBoundariesDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

columnWidth

Задает ширину столбца в режиме чтения.

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

Значение свойства

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

Комментарии

Набор API: WordApiDesktop 1.4

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

fieldShading

Получает затенение на экране для полей.

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

Значение свойства

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

Комментарии

Набор API: WordApiDesktop 1.4

isDraft

Указывает, отображается ли весь текст в окне тем же шрифтом без засечек с минимальным форматированием для ускорения отображения.

isDraft: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

isFirstLineOnlyDisplayed

Указывает, отображается ли только первая строка основного текста в режиме структуры.

isFirstLineOnlyDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

isFormatDisplayed

Указывает, отображается ли форматирование символов в режиме структуры.

isFormatDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

isFullScreen

Указывает, находится ли окно в полноэкранном режиме.

isFullScreen: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

isHiddenTextDisplayed

Возвращает значение, указывающее, отображается ли текст, отформатированный как скрытый.

readonly isHiddenTextDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

isHighlightingDisplayed

Возвращает значение, указывающее, отображается ли форматирование выделения и выводится на печать вместе с документом.

readonly isHighlightingDisplayed: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

isInConflictMode

Указывает, находится ли документ в режиме конфликта.

isInConflictMode: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

isInPanning

Указывает, находится ли microsoft Word в режиме сдвига.

isInPanning: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

isInReadingLayout

Указывает, просматривается ли документ в режиме макета чтения.

isInReadingLayout: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

isMailMergeDataView

Указывает, отображаются ли данные слияния вместо полей слияния.

isMailMergeDataView: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

isMainTextLayerVisible

Указывает, отображается ли текст в документе при отображении областей верхнего и нижнего колонтитулов.

isMainTextLayerVisible: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

isPointerShownAsMagnifier

Указывает, отображается ли указатель в виде лупы при предварительном просмотре.

isPointerShownAsMagnifier: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

isReadingLayoutActualView

Указывает, отображаются ли страницы, отображаемые в режиме чтения, с использованием того же макета, что и печатные страницы.

isReadingLayoutActualView: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

isXmlMarkupVisible

Указывает, отображаются ли XML-теги в документе.

isXmlMarkupVisible: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.4

markupMode

Указывает режим отображения отслеживаемых изменений.

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

Значение свойства

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

Комментарии

Набор API: WordApiDesktop 1.4

pageColor

Задает цвет страницы в режиме чтения.

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

Значение свойства

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

Комментарии

Набор API: WordApiDesktop 1.4

pageMovementType

Указывает тип перемещения страницы.

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

Значение свойства

Word.PageMovementType | "Vertical" | "SideToSide"

Комментарии

Набор API: WordApiDesktop 1.4

readingLayoutTruncateMargins

Указывает, будут ли поля видимыми или скрытыми при просмотре документа в режиме полноэкранного чтения.

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

Значение свойства

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

Комментарии

Набор API: WordApiDesktop 1.4

revisionsBalloonSide

Возвращает значение, указывающее, отображает ли Word всплывающие окна редакции в левом или правом поле документа.

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

Значение свойства

Word.RevisionsBalloonMargin | "Left" | "Right"

Комментарии

Набор API: WordApiDesktop 1.4

revisionsBalloonWidth

Задает ширину всплывок редакции.

revisionsBalloonWidth: number;

Значение свойства

number

Комментарии

Набор API: WordApiDesktop 1.4

revisionsBalloonWidthType

Указывает, как Microsoft Word измеряет ширину выносок редакции.

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

Значение свойства

Word.RevisionsBalloonWidthType | "Percent" | "Points"

Комментарии

Набор API: WordApiDesktop 1.4

revisionsFilter

Возвращает экземпляр RevisionsFilter объекта .

readonly revisionsFilter: Word.RevisionsFilter;

Значение свойства

Комментарии

Набор API: WordApiDesktop 1.4

seekView

Указывает элемент документа, отображаемый в режиме макета печати.

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

Значение свойства

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

Комментарии

Набор API: WordApiDesktop 1.4

splitSpecial

Указывает активную область окна.

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

Значение свойства

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

Комментарии

Набор API: WordApiDesktop 1.4

type

Указывает тип представления.

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

Значение свойства

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

Комментарии

Набор API: WordApiDesktop 1.4

Сведения о методе

collapseAllHeadings()

Сворачивает все заголовки в документе.

collapseAllHeadings(): void;

Возвращаемое значение

void

Комментарии

Набор API: WordApiDesktop 1.4

collapseOutline(range)

Сворачивает текст под выделенным фрагментом или заданным диапазоном на один уровень заголовка.

collapseOutline(range: Word.Range): void;

Параметры

range
Word.Range

Объект Range , указывающий диапазон для сворачивания.

Возвращаемое значение

void

Комментарии

Набор API: WordApiDesktop 1.4

expandAllHeadings()

Разворачивает все заголовки в документе.

expandAllHeadings(): void;

Возвращаемое значение

void

Комментарии

Набор API: WordApiDesktop 1.4

expandOutline(range)

Расширяет текст под выделенным фрагментом на один уровень заголовка.

expandOutline(range: Word.Range): void;

Параметры

range
Word.Range

Объект Range , указывающий диапазон для расширения.

Возвращаемое значение

void

Комментарии

Набор API: WordApiDesktop 1.4

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

options
Word.Interfaces.ViewLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNamesAndPaths

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

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

nextHeaderFooter()

Перемещается в следующий верхний или нижний колонтитул в зависимости от того, отображается ли в представлении верхний или нижний колонтитул.

nextHeaderFooter(): void;

Возвращаемое значение

void

Комментарии

Набор API: WordApiDesktop 1.4

previousHeaderFooter()

Перемещается к предыдущему верхнему или нижнему колонтитулов в зависимости от того, отображается ли в представлении колонтитул.

previousHeaderFooter(): void;

Возвращаемое значение

void

Комментарии

Набор API: WordApiDesktop 1.4

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

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

Параметры

properties
Word.Interfaces.ViewUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options
OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Word.View): void;

Параметры

properties
Word.View

Возвращаемое значение

void

showAllHeadings()

Переключается между отображением всего текста (заголовков и основного текста) и отображением только заголовков.

showAllHeadings(): void;

Возвращаемое значение

void

Комментарии

Набор API: WordApiDesktop 1.4

showHeading(level)

Отображает все заголовки до указанного уровня заголовка и скрывает подчиненные заголовки и основной текст.

showHeading(level: number): void;

Параметры

level

number

Уровень заголовка для отображения.

Возвращаемое значение

void

Комментарии

Набор API: WordApiDesktop 1.4

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.View объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.ViewData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Word.Interfaces.ViewData;

Возвращаемое значение

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.

track(): Word.View;

Возвращаемое значение

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): Word.View;

Возвращаемое значение