Visio.Application class

Пакет:

visio

Представляет Application.

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: 1.1

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

• Visio.Document: приложение

Свойства

context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
showBorders	Показывает или скрывает границы приложения iframe.
showToolbars	Отображение или скрытие стандартных панелей инструментов.

Методы

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

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

context

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

context: RequestContext;

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

Visio.RequestContext

showBorders

Показывает или скрывает границы приложения iframe.

showBorders: boolean;

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

boolean

Комментарии

Набор API: 1.1

Примеры

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

showToolbars

Отображение или скрытие стандартных панелей инструментов.

showToolbars: boolean;

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

boolean

Комментарии

Набор API: 1.1

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

load(options)

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

load(options?: Visio.Interfaces.ApplicationLoadOptions): Visio.Application;

Параметры

options

Visio.Interfaces.ApplicationLoadOptions

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

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

Visio.Application

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Visio.Application

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Visio.Application

set(properties, options)

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

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

Параметры

properties

Visio.Interfaces.ApplicationUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Visio.Application): void;

Параметры

properties

Visio.Application

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

void

showToolbar(id, show)

Устанавливает видимость определенной панели инструментов в приложении.

showToolbar(id: Visio.ToolBarType, show: boolean): void;

Параметры

id

Visio.ToolBarType

Тип панели инструментов.

show

boolean

Отображается ли панель инструментов.

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

void

Комментарии

Набор API: 1.1

showToolbar(id, show)

Устанавливает видимость определенной панели инструментов в приложении.

showToolbar(id: "CommandBar" | "PageNavigationBar" | "StatusBar", show: boolean): void;

Параметры

id

"CommandBar" | "PageNavigationBar" | "StatusBar"

Тип панели инструментов.

show

boolean

Отображается ли панель инструментов.

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

void

Комментарии

Набор API: 1.1

toJSON()

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

toJSON(): Visio.Interfaces.ApplicationData;

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

Visio.Interfaces.ApplicationData