Visio.Page class
Представляет класс Page.
- Extends
Комментарии
[ Набор API: 1.1 ]
Свойства
| all |
Все фигуры на странице, включая вложенные формы. |
| comments | Возвращает коллекцию Comments. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| height | Возвращает высоту страницы. |
| index | Индекс объекта Page. |
| is |
Определяет, является ли страница фоновой. |
| name | Имя страницы. |
| shapes | Все фигуры верхнего уровня на странице. |
| view | Возвращает представление страницы. |
| width | Возвращает ширину страницы. |
Методы
| activate() | Задает страницу как активную страницу документа. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
allShapes
Все фигуры на странице, включая вложенные формы.
readonly allShapes: Visio.ShapeCollection;Значение свойства
Комментарии
[ Набор API: 1.1 ]
comments
Возвращает коллекцию Comments.
readonly comments: Visio.CommentCollection;Значение свойства
Комментарии
[ Набор API: 1.1 ]
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
height
Возвращает высоту страницы.
readonly height: number;Значение свойства
number
Комментарии
[ Набор API: 1.1 ]
index
Индекс объекта Page.
readonly index: number;Значение свойства
number
Комментарии
[ Набор API: 1.1 ]
isBackground
Определяет, является ли страница фоновой.
readonly isBackground: boolean;Значение свойства
boolean
Комментарии
[ Набор API: 1.1 ]
name
shapes
Все фигуры верхнего уровня на странице.
readonly shapes: Visio.ShapeCollection;Значение свойства
Комментарии
[ Набор API: 1.1 ]
view
Возвращает представление страницы.
readonly view: Visio.PageView;Значение свойства
Комментарии
[ Набор API: 1.1 ]
width
Возвращает ширину страницы.
readonly width: number;Значение свойства
number
Комментарии
[ Набор API: 1.1 ]
Сведения о методе
activate()
Задает страницу как активную страницу документа.
activate(): void;Возвращаемое значение
void
Комментарии
[ Набор API: 1.1 ]
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Visio.Interfaces.PageLoadOptions): Visio.Page;Параметры
- options
- Visio.Interfaces.PageLoadOptions
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Visio.Page;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Visio.Page;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
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;Возвращаемое значение
Office Add-ins