Visio.Page class
Representa a classe Page.
- Extends
Comentários
Usada por
Propriedades
| all |
Todas as formas na página, incluindo subformas. |
| 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. |
| 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. 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. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
allShapes
Todas as formas na página, incluindo subformas.
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 de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host 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 quais propriedades do objeto devem ser carregadas.
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 de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.
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 de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.
Retornos
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 de propriedades tentar definir 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
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Visio.Page original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Visio.Interfaces.PageData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
toJSON(): Visio.Interfaces.PageData;