Visio.Document class
Representa a classe Document.
- Extends
Comentários
Propriedades
| application | Representa uma instância de aplicativo do Visio que contém esse documento. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| pages | Representa uma coleção de páginas associadas ao documento. |
| view | Retorna o objeto DocumentView. |
Métodos
| get |
Retorna a Página Ativa do documento. |
| 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. |
| set |
Define a Página Ativa do documento. |
| show |
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. |
| show |
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. |
| start |
Dispara a atualização dos dados no Diagrama, para todas as páginas. |
| toJSON() | Substitui o método JavaScript |
Eventos
| on |
Ocorre quando os dados são atualizados no diagrama. |
| on |
Ocorre quando ocorre um erro esperado ou inesperado na sessão. |
| on |
Ocorre quando o Documento é carregado, atualizado ou alterado. |
| on |
Ocorre quando o carregamento da página é concluído. |
| on |
Ocorre quando a seleção atual de formas é alterada. |
| on |
Ocorre quando o utilizador move o ponteiro do rato para a caixa delimitadora de uma forma. |
| on |
Ocorre quando o utilizador move o rato para fora da caixa delimitadora de uma forma. |
| on |
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
Comentários
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
pages
Representa uma coleção de páginas associadas ao documento.
readonly pages: Visio.PageCollection;Valor da propriedade
Comentários
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
Comentários
Detalhes do método
getActivePage()
Retorna a Página Ativa do documento.
getActivePage(): Visio.Page;Retornos
Comentários
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
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.Document;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.Document;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.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Visio.Interfaces.DocumentUpdateData
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.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
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));
}
});
showTaskPane(taskPaneType, initialProps, show)
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
- taskPaneType
- Visio.TaskPaneType
Tipo do Painel de Tarefas originais. Pode obter valores de enum TaskPaneType
- initialProps
-
any
Parâmetro Opcional. Esta é 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 estiver definido como falso, irá ocultar o painel de tarefas especificado.
Retornos
void
Comentários
showTaskPane(taskPaneTypeString, initialProps, show)
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
- taskPaneTypeString
-
"None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings"
Tipo do Painel de Tarefas originais. Pode obter valores de enum TaskPaneType
- initialProps
-
any
Parâmetro Opcional. Esta é 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 estiver definido como falso, irá ocultar o painel de tarefas especificado.
Retornos
void
Comentários
startDataRefresh()
Dispara a atualização dos dados no Diagrama, para todas as páginas.
startDataRefresh(): void;Retornos
void
Comentários
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 é 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
Detalhes do evento
onDataRefreshComplete
Ocorre quando os dados são atualizados no diagrama.
readonly onDataRefreshComplete: OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>;Tipo de evento
Comentários
onDocumentError
Ocorre quando ocorre um erro esperado ou inesperado na sessão.
readonly onDocumentError: OfficeExtension.EventHandlers<Visio.DocumentErrorEventArgs>;Tipo de evento
Comentários
onDocumentLoadComplete
Ocorre quando o Documento é carregado, atualizado ou alterado.
readonly onDocumentLoadComplete: OfficeExtension.EventHandlers<Visio.DocumentLoadCompleteEventArgs>;Tipo de evento
Comentários
onPageLoadComplete
Ocorre quando o carregamento da página é concluído.
readonly onPageLoadComplete: OfficeExtension.EventHandlers<Visio.PageLoadCompleteEventArgs>;Tipo de evento
Comentários
onSelectionChanged
Ocorre quando a seleção atual de formas é alterada.
readonly onSelectionChanged: OfficeExtension.EventHandlers<Visio.SelectionChangedEventArgs>;Tipo de evento
Comentários
onShapeMouseEnter
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
onShapeMouseLeave
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
onTaskPaneStateChanged
Ocorre sempre que um estado do painel de tarefas é alterado.
readonly onTaskPaneStateChanged: OfficeExtension.EventHandlers<Visio.TaskPaneStateChangedEventArgs>;