Visio.DocumentView class

Пакет:

visio

Представляет класс DocumentView.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: 1.1 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
disableHyperlinks	Отключение гиперссылок.
disablePan	Отключение панорамирования.
disablePanZoomWindow	Отключите PanZoomWindow.
disableZoom	Отключение масштабирования.
hideDiagramBoundary	Скрыть границу диаграммы.

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Visio.DocumentView является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Visio.Interfaces.DocumentViewData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

context

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

context: RequestContext;

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

Visio.RequestContext

disableHyperlinks

Отключение гиперссылок.

disableHyperlinks: boolean;

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

boolean

Комментарии

[ Набор API: 1.1 ]

Примеры

Visio.run(session, function (ctx) {
    const documentView = ctx.document.view;
    documentView.disableHyperlinks();
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

disablePan

Отключение панорамирования.

disablePan: boolean;

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

boolean

Комментарии

[ Набор API: 1.1 ]

disablePanZoomWindow

Отключите PanZoomWindow.

disablePanZoomWindow: boolean;

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

boolean

Комментарии

[ Набор API: 1.1 ]

disableZoom

Отключение масштабирования.

disableZoom: boolean;

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

boolean

Комментарии

[ Набор API: 1.1 ]

hideDiagramBoundary

Скрыть границу диаграммы.

hideDiagramBoundary: boolean;

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

boolean

Комментарии

[ Набор API: 1.1 ]

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

load(options)

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

load(options?: Visio.Interfaces.DocumentViewLoadOptions): Visio.DocumentView;

Параметры

options

Visio.Interfaces.DocumentViewLoadOptions

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

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

Visio.DocumentView

load(propertyNames)

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

load(propertyNames?: string | string[]): Visio.DocumentView;

Параметры

propertyNames

string | string[]

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

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

Visio.DocumentView

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Visio.DocumentView;

Параметры

propertyNamesAndPaths

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

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

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

Visio.DocumentView

set(properties, options)

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

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

Параметры

properties

Visio.Interfaces.DocumentViewUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Visio.DocumentView): void;

Параметры

properties

Visio.DocumentView

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

void

toJSON()

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

toJSON(): Visio.Interfaces.DocumentViewData;

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

Visio.Interfaces.DocumentViewData