Visio.Page class
Representa a classe Page.
- Extends
Comentários
Propriedades
| all |
Todas as formas na Página, incluindo subshapes. |
| comments | Retorna a Coleção de 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. |
| height | Retorna a altura da página. |
| index | O índice da Page. |
| is |
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 |
| 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. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
allShapes
Todas as formas na Página, incluindo subshapes.
readonly allShapes: Visio.ShapeCollection;Valor da propriedade
Comentários
comments
Retorna a Coleção de Comentários.
readonly comments: Visio.CommentCollection;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
height
Retorna a altura da página.
readonly height: number;Valor da propriedade
number
Comentários
index
O índice da Page.
readonly index: number;Valor da propriedade
number
Comentários
isBackground
Seja a página uma página de plano de fundo ou não.
readonly isBackground: boolean;Valor da propriedade
boolean
Comentários
name
Nome da página.
readonly name: string;Valor da propriedade
string
Comentários
shapes
Todas as formas de nível superior na Página.
readonly shapes: Visio.ShapeCollection;Valor da propriedade
Comentários
view
Retorna a visualização da página.
readonly view: Visio.PageView;Valor da propriedade
Comentários
width
Retorna a largura da página.
readonly width: number;Valor da propriedade
number
Comentários
Detalhes do método
activate()
Define a página como Página Ativa do documento.
activate(): void;Retornos
void
Comentários
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 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.Page;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.Page;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.PageUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Visio.Interfaces.PageUpdateData
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.Page): void;Parâmetros
- properties
- Visio.Page
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 original Visio.Page é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Visio.Interfaces.PageData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Visio.Interfaces.PageData;