Visio.DocumentView class

Pacote:

visio

Representa a classe DocumentView.

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.
disableHyperlinks	Desabilitar Hiperlinks.
disablePan	Desabilitar Panorâmica.
disablePanZoomWindow	Desative PanZoomWindow.
disableZoom	Desabilitar Zoom.
hideDiagramBoundary	Ocultar Limite do Diagrama.

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.
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.DocumentView original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Visio.Interfaces.DocumentViewData) 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

disableHyperlinks

Desabilitar Hiperlinks.

disableHyperlinks: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: 1.1 ]

Exemplos

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

disablePan

Desabilitar Panorâmica.

disablePan: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: 1.1 ]

disablePanZoomWindow

Desative PanZoomWindow.

disablePanZoomWindow: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: 1.1 ]

disableZoom

Desabilitar Zoom.

disableZoom: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: 1.1 ]

hideDiagramBoundary

Ocultar Limite do Diagrama.

hideDiagramBoundary: 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.DocumentViewLoadOptions): Visio.DocumentView;

Parâmetros

options

Visio.Interfaces.DocumentViewLoadOptions

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

Retornos

Visio.DocumentView

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

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Visio.DocumentView

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

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

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

Parâmetros

properties

Visio.Interfaces.DocumentViewUpdateData

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

Parâmetros

properties

Visio.DocumentView

Retornos

void

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

toJSON(): Visio.Interfaces.DocumentViewData;

Retornos

Visio.Interfaces.DocumentViewData