Partilhar via


getPageContext (referência da API do cliente)

Obtém o contexto da página como um objeto que representa a página.

Observação

Este método é suportado apenas na Interface Unificada.

Sintaxe

Xrm.Utility.getPageContext();

Devoluções

O método retorna um objeto com a input propriedade. A input propriedade é um objeto com os seguintes valores, dependendo se você está atualmente no formulário de entidade ou na lista de entidades:

Formulário de entidade

Nome Tipo Description
pageType Corda O tipo de página atual. O valor retornado é entityrecord.
entityName Corda Nome lógico da tabela exibida no momento.
entityId Corda ID do registro de tabela exibido atualmente no formulário.
createFromEntity Busca O registro pai que fornece valores padrão com base em valores de coluna mapeados. O objeto de pesquisa tem as seguintes propriedades String: entityType, ide name.
formId Corda ID do formulário exibido no momento.

Lista de entidades

Nome Tipo Description
pageType Corda O tipo de página atual. O valor retornado é entitylist.
entityName Corda Nome lógico da tabela exibida no momento.
viewId Corda ID da vista atualmente apresentada.
viewType Corda Tipo do modo de exibição exibido no momento. Os valores possíveis são savedquery ou userquery.

Observação

Somente os pageType parâmetros e entityName retornarão valores sempre, todos os outros parâmetros retornarão valores somente se especificados pela lógica que abriu a página.

Xrm.Utility