FORM GET OBJECTS

4D v16.3

FORM GET OBJECTS


FORM GET OBJECTS ( arrObjetos {; arrVariaveis {; arrPags}} {; opcaoPag} )

Parâmetro	Tipo	Descrição
arrObjetos	Array string	Nome dos objetos do formulário
arrVariaveis	Array ponteiro	Ponteiros a variáveis ou campos associados aos objetos
arrPags	Array inteiro	Número de página de cada objeto
opcaoPag	Inteiro longo, Operador	1=Página atual do formulário, 2=Todas as páginas, 4=Páginas herdadas Se passar * (obsoleto) = página atual com objetos herdados

Descrição

O comando FORM GET OBJECTS retorna em forma de array(s) a lista de todos os objetos presentes no formulário atual da tabela atual. Esta lista pode estar restrita à página atual do formulário. O comando pode ser utilizado com os formulários de entrada e de saída.

Se um array passado como parâmetro não for declarado previamente, o comando o cria e dimensiona automaticamente. Entretanto, pensando na compilação da aplicação, lhe recomendamos declarar explicitamente cada array.

Passe em arrObjetos o nome do array alfa que conterá os nomes dos objetos (cada nome de objeto é único em um formulário). A ordem na qual os objetos aparecem no array não é significativo.

Os outros arrays preenchidos opcionalmente pelo comando são sincronizados com o primeiro array.

Passe no parâmetro opcional arrVariaveis o nome do array ponteiro que contém os ponteiros às variáveis ou campos associados aos objetos. Se um objeto não tiver uma variável associada, o ponteiro Nil é retornado. Se houver um objeto de tipo “subformulário”, é retornado um ponteiro à tabela do subformulário.

O terceiro array (opcional), arrPags, é preenchido com os números de páginas do formulário. Cada linha deste array contém o número de página do objeto correspondente.

O parâmetro opcional * lhe permite reduzir a lista de objetos retornados na página atual do formulário. Quando se passa este parâmetro, só os objetos da página atual, da página 0 e das páginas herdadas são retornados pelo comando. Em outras palavras, todos os objetos presentes na página atual do formulário (visíveis ou não) são processados pelo comando.

O parâmetro opcional opcaoPag permite designar a(s) parte(s) do formulário desde onde deseja obter os objetos. Por padrão, se o parâmetro opcaoPag se omite (assim como o parâmetro *), se devolvem os objetos de todas as páginas, incluindo os objetos herdados. Para reduzir o alcance do comando, pode passar um valor em opcaoPag. Pode passar uma (ou uma combinação) das seguintes constantes, que se encontram no tema "Objetos de formulário (Acesso)":

Constante	Tipo	Valor	Comentário
Form all pages	Inteiro longo	2	Devolve todos os objetos de todas as páginas, excluindo os objetos herdados
Form current page	Inteiro longo	1	Devolve todos os objetos da página atual, incluindo a página 0, mas excluindo os objetos herdados
Form inherited	Inteiro longo	4	Devolve só os objetos herdados

Nota de compatibilidade: passar o parâmetro * é equivalente a passar Form current page+Form inherited. A sintaxe com o parâmetro * agora é obsoleta e não deve ser mais utilizada.

Exemplo 1

Você quer receber informação sobre todas as páginas, incluindo objetos do formulário herdado (se existir):

  //Formulário aberto

 FORM GET OBJECTS(arrayObjetos;arrayVariaveis;arrayPaginas)

  //Formulário carregado

 FORM LOAD([Tabela1];"MeuForm")

 FORM GET OBJECTS(arrayObjetos;arrayVariaveis;arrayPaginas;Form all pages+Form inherited)

Exemplo 2

Você deseja obter os objetos da página atual do formulário carregado, incluindo a página 0 do formulário e os objetos dos formulários herdados (se existir):

 FORM LOAD("MiForm")

 FORM GOTO PAGE(2)

 FORM GET OBJECTS(arrayObjetos;arrayVariaveis;arrayPag;Formulario página atual+Formulário herdado)

Exemplo 3

Quer obter informação sobre todos os objetos no formulário herdado (se os houver). Se não há formulários herdados, os arrays se devolverão vazios.

 FORM LOAD("MiForm")

 FORM GET OBJECTS(arrayObjetos;arrayVariaveis;arrayPag;Formulário herdado)

Exemplo 4

Você quer obter os objetos da página 4, incluindo os da página 0, mas sem os objetos de formulários herdados (se existir):

 FORM LOAD([Tabela1];"MeuForm")

 FORM GOTO PAGE(4)

 FORM GET OBJECTS(arrayObjetos;arrayVariables;arrayPag;Formulario página actual)

Exemplo 5

Você quer obter informação dos objetos de todas as páginas, mas sem objetos de formulário herdado (se existissem):

 FORM LOAD([Tabela1];"MeuForm")

 FORM GET OBJECTS(arrayObjetos;arrayVariaveis;arrayPaginas;Form todas as páginas)

Ver também

FORM GET PROPERTIES
Objetos (Formulários)
Objetos de formulário (Acesso)