Formulários, guias e seções da API do cliente

Use Power Pages formulários, guias, seções e controles da API do cliente para inspecionar e gerenciar elementos de página. Essa referência explica as coleções, as propriedades e os métodos disponíveis para controlar a visibilidade, os valores e a navegação multissessão.

$pages.currentPage.forms

A $pages.currentPage.forms coleção inclui métodos para trabalhar com elementos de formulário na página.

Métodos $pages.currentPage.forms

Use esses métodos para listar formulários e obter instâncias de formulário específicas.

Método Returns Description
getAll IForm[] Retorna todos os formulários adicionados à página atual.
getFormById(id: string) IForm Recupera um formulário por sua ID de elemento HTML.
getFormByName(name: string) IForm Recupera um formulário pelo nome.

Exemplos do método $pages.currentPage.forms

Esses exemplos mostram como obter todos os formulários e recuperar formulários específicos por ID ou nome.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    let forms = $pages.currentPage.forms.getAll();
    let form1 = $pages.currentPage.forms.getFormById('form_#1');
    let form2 = $pages.currentPage.forms.getFormByName('form_name')
});

Interface IForm

A IForm interface representa um contêiner para controles e guias.

Propriedades IForm

As propriedades a seguir descrevem o formulário e seus controles e guias contidos.

Propriedade Tipo Description
id cadeia A ID do formulário.
name cadeia O nome do formulário.
controls Controle[] Todos os controles no formulário.
tabs Guia[] Todas as guias no formulário.
isMultiStep booleano True se o formulário for multissessão; caso contrário, false. Consulte o formulário multissessão.

Métodos IForm

Use esses métodos para consultar a visibilidade de um formulário e alternar se ele está visível.

Método Returns Description
getVisible boolean Retorna true se o formulário estiver visível; caso contrário, false.
setVisible(isVisible: boolean) void Define a visibilidade do formulário.
getHtmlElement HTMLElement Retorna o elemento HTML subjacente para o formulário.
getControlByLogicalName(logicalName: string) Controle | undefined Retorna o controle no formulário que tem o nome lógico especificado, como o nome do esquema de coluna. Retorna indefinido quando nenhum controle corresponde.

Exemplo de IForm

O exemplo a seguir recupera um formulário por ID e registra sua visibilidade, número de controles e guias.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    let form = $pages.currentPage.forms.getFormById('form_#1');

    console.log(`Form id: ${form.id} has ${form.controls.length} controls.`);

    if (form.getVisible()) {
        console.log('Form is currently visible.');
    }
    let tabs = form.tabs;
    console.log(`Form has ${tabs.length} tabs.`);

    // Look up a control by its logical name.
    let nameControl = form.getControlByLogicalName('fullname');
    if (nameControl) {
        nameControl.setValue('Jane Doe');
    }
});

Formulário de várias etapas

Um formulário de várias etapas é um contêiner que contém vários formulários básicos.

Propriedades do formulário de várias etapas

As propriedades a seguir se aplicam ao contêiner de formulário de várias etapas e descrevem o que está disponível na etapa ativa atualmente.

Propriedade Tipo Description
id cadeia A ID do formulário de várias etapas.
controls Controle[] Todos os controles na etapa atual.
tabs Guia[] Todas as guias na etapa atual.
isMultiStep booleano True se o formulário for multissessão; caso contrário, false.
nextButton Elemento JQuery Representa o próximo botão (objeto vazio, se ausente).
previousButton Elemento JQuery Representa o botão anterior (objeto vazio, se ausente).

Métodos de formulário de várias etapas

Use esses métodos para verificar a visibilidade e mover-se entre as etapas em um formulário de várias etapas.

Name Returns Description
getVisible boolean Retorna true se o formulário estiver visível; caso contrário, false.
setVisible(isVisible: boolean) void Define a visibilidade do formulário.
hasNextStep boolean Retornará true se houver uma próxima etapa; caso contrário, false.
hasPreviousStep boolean Retorna true se houver uma etapa anterior; caso contrário, false.
goToNextStep void Navega para a próxima etapa; enviará o formulário se nenhuma próxima etapa existir.
goToPreviousStep void Navega até a etapa anterior; gerará uma exceção se nenhum existir.
getControlByLogicalName(logicalName: string) Controle | undefined Retorna o controle na etapa atual que tem o nome lógico especificado, como o nome do esquema de coluna. Retorna indefinido quando nenhum controle corresponde.

Exemplo de formulário de várias etapas

Este exemplo mostra como recuperar um formulário de várias etapas, inspecioná-lo e avançar para a próxima etapa.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    let form = $pages.currentPage.forms.getFormById('multiform_#1');
    console.log(`Form id: ${form.id} has ${form.controls.length} controls.`);

    if (form.getVisible()) {
        console.log('Form is currently visible.');
    }

    let tabs = form.tabs;
    console.log(`Form has ${tabs.length} tabs.`);

    form.goToNextStep();
});

Tab

Um Tab contém uma ou mais seções em um formulário.

Propriedade Tab Sections

Uma matriz de seções dentro da guia.

Métodos tab

Use esses métodos para verificar a visibilidade de uma guia, recuperar seu nome e alternar se ela está visível.

Método Returns Description
getVisible boolean Retornará true se a guia estiver visível; caso contrário, false.
getName string Retorna o nome da guia.
setVisible(isVisible: boolean) void Define a visibilidade da guia.

Exemplo de guia

Este exemplo recupera um formulário, enumera suas guias e registra o nome da primeira guia.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    let form = $pages.currentPage.forms.getFormById('form_#1');
    let tabs = form.tabs;
    console.log(`Form has ${tabs.length} tabs.`);
    console.log(`First tab is named: ${tabs[0].getName()}`);
});

Seção

Controles de grupo de seções em uma guia.

Propriedade Section Controls

Uma matriz de controles dentro da seção.

Métodos de seção

Use esses métodos para ler o nome de uma seção e controlar sua visibilidade.

Método Returns Description
getVisible boolean Retorna true se a seção estiver visível; caso contrário, false.
getName string Retorna o nome da seção.
setVisible(isVisible: boolean) void Define a visibilidade da seção.

Exemplo de seção

Este exemplo recupera seções da primeira guia de um formulário e registra detalhes básicos.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    let form = $pages.currentPage.forms.getFormById('form_#1');
    let sections = form.tabs[0].sections;
    console.log(`Tab has ${sections.length} section(s).`);
    console.log(`First section is named: ${sections[0].getName()}`);
});

Controle

Um Control representa um elemento de formulário individual. Use os métodos de controle comuns para recuperar ou atualizar seu valor, visibilidade, estado necessário e estado desabilitado e para adicionar validação do lado do cliente. Os tipos de valor e membros adicionais dependem do tipo de controle.

  • Última atualização em