Visio.Document class

Representa uma instância de aplicativo do Visio que contém esse documento.

readonly application: Visio.Application;

Valor da propriedade

Comentários

[ Conjunto de API: 1.1 ]

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

Representa uma coleção de páginas associadas ao documento.

readonly pages: Visio.PageCollection;

Valor da propriedade

Comentários

[ Conjunto de API: 1.1 ]

Exemplos

Visio.run(session, function (ctx) {
    const pages = ctx.document.pages;
    const pageCount = pages.getCount();
    return ctx.sync().then(function () {
        console.log("Pages Count: " +pageCount.value);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

Retorna o objeto DocumentView.

readonly view: Visio.DocumentView;

Valor da propriedade

Comentários

[ Conjunto de API: 1.1 ]

Retorna a Página Ativa do documento.

getActivePage(): Visio.Page;

Retornos

Comentários

[ Conjunto de API: 1.1 ]

Exemplos

Visio.run(session, function (ctx) {
    const document = ctx.document;
    const activePage = document.getActivePage();
    activePage.load("name");
    return ctx.sync().then(function () {
        console.log("pageName: " +activePage.name);
    });   
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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.DocumentLoadOptions): Visio.Document;

Parâmetros

Retornos

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.Document;

Parâmetros

Retornos

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.Document;

Parâmetros

Retornos

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.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

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

set(properties: Visio.Document): void;

Parâmetros

Retornos

Define a Página Ativa do documento.

setActivePage(PageName: string): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: 1.1 ]

Exemplos

Visio.run(session, function (ctx) {
    const document = ctx.document;
    const pageName = "Page-1";
    document.setActivePage(pageName);
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

Mostra ou oculta um Painel de Tarefas. Isto será consumido pelo Suplemento DV Excel/Outras aplicações de terceiros que incorporaram o desenho do Visio para mostrar/ocultar o painel de tarefas.

showTaskPane(taskPaneType: Visio.TaskPaneType, initialProps?: any, show?: boolean): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: 1.1 ]

Mostra ou oculta um Painel de Tarefas. Isto será consumido pelo Suplemento DV Excel/Outras aplicações de terceiros que incorporaram o desenho do Visio para mostrar/ocultar o painel de tarefas.

showTaskPane(taskPaneTypeString: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings", initialProps?: any, show?: boolean): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: 1.1 ]

Dispara a atualização dos dados no Diagrama, para todas as páginas.

startDataRefresh(): void;

Retornos

Comentários

[ Conjunto de API: 1.1 ]

Exemplos

Visio.run(session, function (ctx) {
    const document = ctx.document;
    document.startDataRefresh();
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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.Document original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Visio.Interfaces.DocumentData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Visio.Interfaces.DocumentData;

Retornos

Ocorre quando os dados são atualizados no diagrama.

readonly onDataRefreshComplete: OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>;

Tipo de evento

Comentários

[ Conjunto de API: 1.1 ]

Ocorre quando ocorre um erro esperado ou inesperado na sessão.

readonly onDocumentError: OfficeExtension.EventHandlers<Visio.DocumentErrorEventArgs>;

Tipo de evento

Comentários

[ Conjunto de API: 1.1 ]

Ocorre quando o Documento é carregado, atualizado ou alterado.

readonly onDocumentLoadComplete: OfficeExtension.EventHandlers<Visio.DocumentLoadCompleteEventArgs>;

Tipo de evento

Comentários

[ Conjunto de API: 1.1 ]

Ocorre quando o carregamento da página é concluído.

readonly onPageLoadComplete: OfficeExtension.EventHandlers<Visio.PageLoadCompleteEventArgs>;

Tipo de evento

Comentários

[ Conjunto de API: 1.1 ]

Ocorre quando a seleção atual de formas é alterada.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Visio.SelectionChangedEventArgs>;

Tipo de evento

Comentários

[ Conjunto de API: 1.1 ]

Ocorre quando o utilizador move o ponteiro do rato para a caixa delimitadora de uma forma.

readonly onShapeMouseEnter: OfficeExtension.EventHandlers<Visio.ShapeMouseEnterEventArgs>;

Tipo de evento

Comentários

[ Conjunto de API: 1.1 ]

Ocorre quando o utilizador move o rato para fora da caixa delimitadora de uma forma.

readonly onShapeMouseLeave: OfficeExtension.EventHandlers<Visio.ShapeMouseLeaveEventArgs>;

Tipo de evento

Comentários

[ Conjunto de API: 1.1 ]

Ocorre sempre que um estado do painel de tarefas é alterado.

readonly onTaskPaneStateChanged: OfficeExtension.EventHandlers<Visio.TaskPaneStateChangedEventArgs>;

Tipo de evento

Comentários

[ Conjunto de API: 1.1 ]