Visio.Page class

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

Свойства

allShapes	Все фигуры на странице, включая вложенные формы.
comments	Возвращает коллекцию Comments.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
height	Возвращает высоту страницы.
index	Индекс объекта Page.
isBackground	Определяет, является ли страница фоновой.
name	Имя страницы.
shapes	Все фигуры верхнего уровня на странице.
view	Возвращает представление страницы.
width	Возвращает ширину страницы.

Методы

activate()	Задает страницу как активную страницу документа.
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.Page является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Visio.Interfaces.PageData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

allShapes

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

readonly allShapes: Visio.ShapeCollection;

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

Visio.ShapeCollection

comments

Возвращает коллекцию Comments.

readonly comments: Visio.CommentCollection;

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

Visio.CommentCollection

context

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

context: RequestContext;

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

Visio.RequestContext

height

Возвращает высоту страницы.

readonly height: number;

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

number

index

Индекс объекта Page.

readonly index: number;

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

number

isBackground

Определяет, является ли страница фоновой.

readonly isBackground: boolean;

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

boolean

name

Имя страницы.

readonly name: string;

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

string

shapes

Все фигуры верхнего уровня на странице.

readonly shapes: Visio.ShapeCollection;

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

Visio.ShapeCollection

view

Возвращает представление страницы.

readonly view: Visio.PageView;

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

Visio.PageView

width

Возвращает ширину страницы.

readonly width: number;

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

number

activate()

Задает страницу как активную страницу документа.

activate(): void;

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

void

load(options)

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

load(options?: Visio.Interfaces.PageLoadOptions): Visio.Page;

Параметры

options: Visio.Interfaces.PageLoadOptions

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

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

Visio.Page

load(propertyNames)

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

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

Параметры

propertyNames: string | string[]

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

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

Visio.Page

load(propertyNamesAndPaths)

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

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

Параметры

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

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

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

Visio.Page

set(properties, options)

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

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

Параметры

properties: Visio.Interfaces.PageUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Visio.Page): void;

Параметры

properties: Visio.Page

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

void

toJSON()

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

toJSON(): Visio.Interfaces.PageData;

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

Visio.Interfaces.PageData

Комментарии

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

Свойства

Методы

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

allShapes

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

Комментарии

comments

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

Комментарии

context

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

height

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

Комментарии

index

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

Комментарии

isBackground

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

Комментарии

name

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

Комментарии

shapes

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

Комментарии

view

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

Комментарии

width

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

Комментарии

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

activate()

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

toJSON()

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

Обратная связь