Visio.Page class

Pacote:

visio

Representa a classe Page.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: 1.1 ]

Propriedades

allShapes	Todas as formas na Página, incluindo sub-shapes.
comments	Retorna a Coleção de Comentários.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
height	Retorna a altura da página.
index	O índice da Page.
isBackground	Seja a página uma página de plano de fundo ou não.
name	Nome da página.
shapes	Todas as formas de nível superior na Página.
view	Retorna a visualização da página.
width	Retorna a largura da página.

Métodos

activate()	Define a página como 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.
setMockData(data)	Definir dados simulados
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.Page original é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Visio.Interfaces.PageData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

allShapes

Todas as formas na Página, incluindo sub-shapes.

readonly allShapes: Visio.ShapeCollection;

Valor da propriedade

Visio.ShapeCollection

Comentários

[ Conjunto de API: 1.1 ]

comments

Retorna a Coleção de Comentários.

readonly comments: Visio.CommentCollection;

Valor da propriedade

Visio.CommentCollection

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

height

Retorna a altura da página.

readonly height: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: 1.1 ]

index

O índice da Page.

readonly index: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: 1.1 ]

isBackground

Seja a página uma página de plano de fundo ou não.

readonly isBackground: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: 1.1 ]

name

Nome da página.

readonly name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: 1.1 ]

shapes

Todas as formas de nível superior na Página.

readonly shapes: Visio.ShapeCollection;

Valor da propriedade

Visio.ShapeCollection

Comentários

[ Conjunto de API: 1.1 ]

view

Retorna a visualização da página.

readonly view: Visio.PageView;

Valor da propriedade

Visio.PageView

Comentários

[ Conjunto de API: 1.1 ]

width

Retorna a largura da página.

readonly width: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: 1.1 ]

Detalhes do método

activate()

Define a página como Página Ativa do documento.

activate(): void;

Retornos

void

Comentários

[ Conjunto de API: 1.1 ]

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.PageLoadOptions): Visio.Page;

Parâmetros

options

Visio.Interfaces.PageLoadOptions

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

Retornos

Visio.Page

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

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

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

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

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

Parâmetros

properties

Visio.Interfaces.PageUpdateData

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

Parâmetros

properties

Visio.Page

Retornos

void

setMockData(data)

Definir dados simulados

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

Parâmetros

data

Visio.Interfaces.PageData

Retornos

void

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

toJSON(): Visio.Interfaces.PageData;

Retornos

Visio.Interfaces.PageData