Visio.Application class

  • Referência
Pacote:
visio

Representa o Aplicativo.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: 1.1 ]

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.
showBorders

Mostra ou oculta os limites da aplicação iframe.
showToolbars

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 context.sync() antes de ler as propriedades.
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(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
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.
showToolbar(id, show)

Define a visibilidade de uma barra de ferramentas específica na aplicação.
showToolbar(idString, show)

Define a visibilidade de uma barra de ferramentas específica na aplicação.
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.

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

Visio.RequestContext

showBorders

Mostra ou oculta os limites da aplicação iframe.

showBorders: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: 1.1 ]

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

[ Conjunto de API: 1.1 ]

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

options
Visio.Interfaces.ApplicationLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Visio.Application

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

Visio.Application

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

Visio.Application

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

id
Visio.ToolBarType

O tipo da Barra de Ferramentas.

show

boolean

Se a barra de ferramentas está visível ou não.

Retornos

void

Comentários

[ Conjunto de API: 1.1 ]

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

[ Conjunto de API: 1.1 ]

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;

Retornos

Visio.Interfaces.ApplicationData