Saltar para o conteúdo principal
Versão: Próximo

WP Get frame

WP Get frame ( {* ;} wpArea {; textBoxID} ) -> Resultado

ParâmetroTipoDescrição
*OperadorSe especificado, wpArea é um nome de objeto de formulário (string). Se omitido, wpArea é um campo de objeto ou variável
wpAreaTextNome de objeto de formulário (se * for especificado) ou variável ou campo de objeto 4D Write Pro
textBoxIDString🡘ID of the text box (only filled if a text box has the focus)
ResultadoIntegero Frame onde o cursor está atualmente estabelecido

Esse comando não é seguro para thread e não pode ser usado em código adequado.

Descrição

O comando WP Get frame devolve o marco no qual se encontra atualmente o cursor na área 4D Write Pro wpArea.

Se passar o parâmetro opcional *, indica que wpArea é um nome de objeto de formulário (string). Se não passar este parâmetro, indica que wpArea é uma variável ou um campo objeto 4D Write Pro.

Nota: Este comando pode ser usado se wpArea for associado com um objeto formulário (ou seja, é exibido no formulário/página atual).

O valor devolvido pode ser comparado com uma das constantes abaixo do tema Constantes 4D Write Pro:

ConstanteTipoValorComentário
wk bodyInteiro longo0Body frame da sessão
wk current section default footerInteiro longo10Rodapé principal da seção (disponível só se não houver rodapé de sub-seção ativo)
wk current section default headerInteiro longo9Cabeçalho principal da seção (disponível só se não houver cabeçalho de subseção ativo)
wk current section first footerInteiro longo4Rodapé da primeira página da seção
wk current section first headerInteiro longo3Cabeçalho da primeira página da seção
wk current section left footerInteiro longo6Rodapé das páginas esquerdas da seção
wk current section left headerInteiro longo5Cabeçalho das páginas esquerdas da seção
wk current section right footerInteiro longo8Rodapé das páginas direitas da seção
wk current section right headerInteiro longo7Cabeçalho das páginas direitas da seção
wk text boxInteiro longo11caixa de texto

Se o cursor estiver no momento em um elemento caixa de texto, a id do elemento da caixa de texto é devolvida no parâmetro textBoxID. Em todos os outros casos, este parâmetro se devolve vazio.

Exemplo

Se quiser ter certeza de que o usuàrio tenha colocado o cursor em um marco cabeçalho ou rodapé:

 var $frameGet Integer

$frameGet: :=WP Get frame(*;"WParea")
 If($frameGet=wk body)|($frameGet=wk text box)
    ALERT("Please select a footer or a header.")
 End if


Ver também

WP Get footer
WP SET FRAME