Visio.Page class
Representa la clase Page.
- Extends
Comentarios
Propiedades
| all |
Todas las formas de la página, incluidas las subformas. |
| comments | Devuelve la colección de comentarios. |
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| height | Devuelve el alto de la página. |
| index | Índice de la página. |
| is |
Si la página es una página de fondo o no. |
| name | Nombre de la página. |
| shapes | Todas las formas de nivel superior de la página. |
| view | Devuelve la vista de la página. |
| width | Devuelve el ancho de la página. |
Métodos
| activate() | Establece la página como Página activa del documento. |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| set(properties, options) | Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente. |
| toJSON() | Invalida el método JavaScript |
Detalles de las propiedades
allShapes
Todas las formas de la página, incluidas las subformas.
readonly allShapes: Visio.ShapeCollection;Valor de propiedad
Comentarios
comments
Devuelve la colección de comentarios.
readonly comments: Visio.CommentCollection;Valor de propiedad
Comentarios
context
Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
height
Devuelve el alto de la página.
readonly height: number;Valor de propiedad
number
Comentarios
index
Índice de la página.
readonly index: number;Valor de propiedad
number
Comentarios
isBackground
Si la página es una página de fondo o no.
readonly isBackground: boolean;Valor de propiedad
boolean
Comentarios
name
Nombre de la página.
readonly name: string;Valor de propiedad
string
Comentarios
shapes
Todas las formas de nivel superior de la página.
readonly shapes: Visio.ShapeCollection;Valor de propiedad
Comentarios
view
Devuelve la vista de la página.
readonly view: Visio.PageView;Valor de propiedad
Comentarios
width
Devuelve el ancho de la página.
readonly width: number;Valor de propiedad
number
Comentarios
Detalles del método
activate()
Establece la página como Página activa del documento.
activate(): void;Devoluciones
void
Comentarios
load(options)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(options?: Visio.Interfaces.PageLoadOptions): Visio.Page;Parámetros
- options
- Visio.Interfaces.PageLoadOptions
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames?: string | string[]): Visio.Page;Parámetros
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
Devoluciones
load(propertyNamesAndPaths)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Visio.Page;Parámetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
set(properties, options)
Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties: Interfaces.PageUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Visio.Interfaces.PageUpdateData
Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.
- options
- OfficeExtension.UpdateOptions
Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.
Devoluciones
void
set(properties)
Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
set(properties: Visio.Page): void;Parámetros
- properties
- Visio.Page
Devoluciones
void
toJSON()
Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Visio.Page original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Visio.Interfaces.PageData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Visio.Interfaces.PageData;