Compartilhar via

Visio.Document class

  • Referência
Pacote:
visio

Representa a classe Document.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: 1.1 ]

Propriedades

application

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

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

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

Retorna o objeto DocumentView.

Métodos

getActivePage()

Retorna a Página Ativa do documento.
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.
setActivePage(PageName)

Define a Página Ativa do documento.
setMockData(data)

Definir dados simulados
showTaskPane(taskPaneType, initialProps, show)

Mostra ou oculta um TaskPane. Isso será consumido pelo Suplemento do DV Excel/Outros aplicativos de terceiros que inseriram o desenho do Visio para mostrar/ocultar o painel de tarefas.
showTaskPane(taskPaneTypeString, initialProps, show)

Mostra ou oculta um TaskPane. Isso será consumido pelo Suplemento do DV Excel/Outros aplicativos de terceiros que inseriram o desenho do Visio para mostrar/ocultar o painel de tarefas.
startDataRefresh()

Dispara a atualização dos dados no Diagrama, para todas as páginas.
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.Document original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Visio.Interfaces.DocumentData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Eventos

onDataRefreshComplete

Ocorre quando os dados são atualizados no diagrama.
onDocumentError

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

Ocorre quando o Documento é carregado, atualizado ou alterado.
onPageLoadComplete

Ocorre quando a página termina de carregar.
onSelectionChanged

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

Ocorre quando o usuário move o ponteiro do mouse para a caixa delimitadora de uma forma.
onShapeMouseLeave

Ocorre quando o usuário move o mouse para fora da caixa delimitadora de uma forma.
onTaskPaneStateChanged

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

Detalhes da propriedade

application

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

readonly application: Visio.Application;

Valor da propriedade

Visio.Application

Comentários

[ Conjunto de API: 1.1 ]

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

pages

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

readonly pages: Visio.PageCollection;

Valor da propriedade

Visio.PageCollection

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));
    }
});

view

Retorna o objeto DocumentView.

readonly view: Visio.DocumentView;

Valor da propriedade

Visio.DocumentView

Comentários

[ Conjunto de API: 1.1 ]

Detalhes do método

getActivePage()

Retorna a Página Ativa do documento.

getActivePage(): Visio.Page;

Retornos

Visio.Page

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));
    }
});

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

Parâmetros

options
Visio.Interfaces.DocumentLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Visio.Document

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

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

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

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

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

Parâmetros

properties
Visio.Interfaces.DocumentUpdateData

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

Parâmetros

properties
Visio.Document

Retornos

void

setActivePage(PageName)

Define a Página Ativa do documento.

setActivePage(PageName: string): void;

Parâmetros

PageName

string

Nome da página

Retornos

void

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));
    }
});

setMockData(data)

Definir dados simulados

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

Parâmetros

data
Visio.Interfaces.DocumentData

Retornos

void

showTaskPane(taskPaneType, initialProps, show)

Mostra ou oculta um TaskPane. Isso será consumido pelo Suplemento do DV Excel/Outros aplicativos de terceiros que inseriram o desenho do Visio para mostrar/ocultar o painel de tarefas.

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

Parâmetros

taskPaneType
Visio.TaskPaneType

Tipo do TaskPane de 1ª Parte. Ele pode usar valores de enumeração TaskPaneType

initialProps

any

Parâmetro opcional. Essa é uma estrutura de dados genérica que seria preenchida com dados iniciais necessários para inicializar o conteúdo do painel de tarefas.

show

boolean

Parâmetro opcional. Se ele estiver definido como false, ele ocultará o painel de tarefas especificado.

Retornos

void

Comentários

[ Conjunto de API: 1.1 ]

showTaskPane(taskPaneTypeString, initialProps, show)

Mostra ou oculta um TaskPane. Isso será consumido pelo Suplemento do DV Excel/Outros aplicativos de terceiros que inseriram o desenho do Visio para mostrar/ocultar o painel de tarefas.

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

Parâmetros

taskPaneTypeString

"None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings"

Tipo do TaskPane de 1ª Parte. Ele pode usar valores de enumeração TaskPaneType

initialProps

any

Parâmetro opcional. Essa é uma estrutura de dados genérica que seria preenchida com dados iniciais necessários para inicializar o conteúdo do painel de tarefas.

show

boolean

Parâmetro opcional. Se ele estiver definido como false, ele ocultará o painel de tarefas especificado.

Retornos

void

Comentários

[ Conjunto de API: 1.1 ]

startDataRefresh()

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

startDataRefresh(): void;

Retornos

void

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));
    }
});

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

toJSON(): Visio.Interfaces.DocumentData;

Retornos

Visio.Interfaces.DocumentData

Detalhes do evento

onDataRefreshComplete

Ocorre quando os dados são atualizados no diagrama.

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

Tipo de evento

OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>

Comentários

[ Conjunto de API: 1.1 ]

onDocumentError

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

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

Tipo de evento

OfficeExtension.EventHandlers<Visio.DocumentErrorEventArgs>

Comentários

[ Conjunto de API: 1.1 ]

onDocumentLoadComplete

Ocorre quando o Documento é carregado, atualizado ou alterado.

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

Tipo de evento

OfficeExtension.EventHandlers<Visio.DocumentLoadCompleteEventArgs>

Comentários

[ Conjunto de API: 1.1 ]

onPageLoadComplete

Ocorre quando a página termina de carregar.

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

Tipo de evento

OfficeExtension.EventHandlers<Visio.PageLoadCompleteEventArgs>

Comentários

[ Conjunto de API: 1.1 ]

onSelectionChanged

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

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

Tipo de evento

OfficeExtension.EventHandlers<Visio.SelectionChangedEventArgs>

Comentários

[ Conjunto de API: 1.1 ]

onShapeMouseEnter

Ocorre quando o usuário move o ponteiro do mouse para a caixa delimitadora de uma forma.

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

Tipo de evento

OfficeExtension.EventHandlers<Visio.ShapeMouseEnterEventArgs>

Comentários

[ Conjunto de API: 1.1 ]

onShapeMouseLeave

Ocorre quando o usuário move o mouse para fora da caixa delimitadora de uma forma.

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

Tipo de evento

OfficeExtension.EventHandlers<Visio.ShapeMouseLeaveEventArgs>

Comentários

[ Conjunto de API: 1.1 ]

onTaskPaneStateChanged

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

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

Tipo de evento

OfficeExtension.EventHandlers<Visio.TaskPaneStateChangedEventArgs>

Comentários

[ Conjunto de API: 1.1 ]