Visio.Application class
Representa o Aplicativo.
- Extends
Comentários
Propriedades
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| show |
Mostra ou oculta os limites da aplicação iframe. |
| show |
Mostra ou oculta as barras de ferramentas padrão. |
Métodos
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente. |
| show |
Define a visibilidade de uma barra de ferramentas específica na aplicação. |
| show |
Define a visibilidade de uma barra de ferramentas específica na aplicação. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
context
O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
context: RequestContext;Valor da propriedade
showBorders
Mostra ou oculta os limites da aplicação iframe.
showBorders: boolean;Valor da propriedade
boolean
Comentários
Exemplos
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
Mostra ou oculta as barras de ferramentas padrão.
showToolbars: boolean;Valor da propriedade
boolean
Comentários
Detalhes do método
load(options)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(options?: Visio.Interfaces.ApplicationLoadOptions): Visio.Application;Parâmetros
Fornece opções para as propriedades do objeto a carregar.
Retornos
load(propertyNames)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames?: string | string[]): Visio.Application;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
load(propertyNamesAndPaths)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Visio.Application;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties: Interfaces.ApplicationUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Visio.Interfaces.ApplicationUpdateData
Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
set(properties: Visio.Application): void;Parâmetros
- properties
- Visio.Application
Retornos
void
showToolbar(id, show)
Define a visibilidade de uma barra de ferramentas específica na aplicação.
showToolbar(id: Visio.ToolBarType, show: boolean): void;Parâmetros
O tipo da Barra de Ferramentas.
- show
-
boolean
Se a barra de ferramentas está visível ou não.
Retornos
void
Comentários
showToolbar(idString, show)
Define a visibilidade de uma barra de ferramentas específica na aplicação.
showToolbar(idString: "CommandBar" | "PageNavigationBar" | "StatusBar", show: boolean): void;Parâmetros
- idString
-
"CommandBar" | "PageNavigationBar" | "StatusBar"
O tipo da Barra de Ferramentas.
- show
-
boolean
Se a barra de ferramentas está visível ou não.
Retornos
void
Comentários
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Visio.Application original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Visio.Interfaces.ApplicationData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Visio.Interfaces.ApplicationData;