Visio.Application class
Representa la aplicación.
- Extends
Comentarios
Propiedades
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| show |
Muestra u oculta los bordes de la aplicación iframe. |
| show |
Muestra u oculta las barras de herramientas estándar. |
Métodos
| 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. |
| show |
Establece la visibilidad de una barra de herramientas específica en la aplicación. |
| show |
Establece la visibilidad de una barra de herramientas específica en la aplicación. |
| toJSON() | Invalida el método JavaScript |
Detalles de las propiedades
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
showBorders
Muestra u oculta los bordes de la aplicación iframe.
showBorders: boolean;Valor de propiedad
boolean
Comentarios
Ejemplos
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
Muestra u oculta las barras de herramientas estándar.
showToolbars: boolean;Valor de propiedad
boolean
Comentarios
Detalles del método
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.ApplicationLoadOptions): Visio.Application;Parámetros
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.Application;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.Application;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.ApplicationUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Visio.Interfaces.ApplicationUpdateData
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.Application): void;Parámetros
- properties
- Visio.Application
Devoluciones
void
showToolbar(id, show)
Establece la visibilidad de una barra de herramientas específica en la aplicación.
showToolbar(id: Visio.ToolBarType, show: boolean): void;Parámetros
Tipo de la barra de herramientas.
- show
-
boolean
Si la barra de herramientas está visible o no.
Devoluciones
void
Comentarios
showToolbar(idString, show)
Establece la visibilidad de una barra de herramientas específica en la aplicación.
showToolbar(idString: "CommandBar" | "PageNavigationBar" | "StatusBar", show: boolean): void;Parámetros
- idString
-
"CommandBar" | "PageNavigationBar" | "StatusBar"
Tipo de la barra de herramientas.
- show
-
boolean
Si la barra de herramientas está visible o no.
Devoluciones
void
Comentarios
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.Application original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Visio.Interfaces.ApplicationData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Visio.Interfaces.ApplicationData;