Visio.Application class

Pacote:

visio

Representa o Aplicativo.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: 1.1 ]

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
showBorders	Mostra ou oculta as bordas do aplicativo 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. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
setMockData(data)	Definir dados simulados
showToolbar(id, show)	Define a visibilidade de uma barra de ferramentas específica no aplicativo.
showToolbar(idString, show)	Define a visibilidade de uma barra de ferramentas específica no aplicativo.
toJSON()	Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Visio.Application original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Visio.Interfaces.ApplicationData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Visio.RequestContext

showBorders

Mostra ou oculta as bordas do aplicativo 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 quais propriedades do objeto 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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Visio.Application

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas 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 estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options

OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Visio.Application): void;

Parâmetros

properties

Visio.Application

Retornos

void

setMockData(data)

Definir dados simulados

setMockData(data: Visio.Interfaces.ApplicationData): void;

Parâmetros

data

Visio.Interfaces.ApplicationData

Retornos

void

showToolbar(id, show)

Define a visibilidade de uma barra de ferramentas específica no aplicativo.

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 no aplicativo.

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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Visio.Application original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Visio.Interfaces.ApplicationData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Visio.Interfaces.ApplicationData;

Retornos

Visio.Interfaces.ApplicationData