WP Get section

4D v20

WP Get section


WP Get section ( alvoObj ) \| (wpDoc ; índiceSeção ) -> Resultado

Parâmetro	Tipo	Descrição
alvoObj	Objeto	Range ou elemento de referência
wpDoc	Objeto	Documento 4D Write pro
índiceSeção	Inteiro longo	Índice da seção
Resultado	Objeto	Seção 4D Write Pro

O comando WP Get section devolve a primeira seção intersectada pela range alvoObj ou elemento, ou ao indiceSeção especificado do documento wpDoc.

Com a primeira sintaxe (utilizando o parâmetro alvoObj), o comando devolve a primeira seção intersectada pela range ou o elemento. Pode passar em targetObj:
- uma range (gama ou faixa de seleção de elementos) ou
- uma referência de elemento (tabela / fila / parágrafo / corpo / cabeçalho / rodapé). Não se pode passar uma referência de subseção, nem uma imagem ancorada (se devolve um erro nesse caso).
Se a range ou a referência do elemento pertencer a uma caixa de texto, WP Get section sempre devolve a primeira seção, exceto se estiver ancorado a uma seção (nesse caso a seção é devolvida).

Com a segunda sintaxe (utilizando o parâmetro wpDoc), o comando devolve a seção correspondente à seção indiceSeção (o valor de indiceSeção deve ser >=1).
Se não for definida nenhuma seção para o indiceSeção especificado, o comando devolve um objeto indefinido (não se devolve nenhum erro).

Nota: utilize o comando WP Get subsection para obter uma subseção de uma seção ou de uma range.

Se quiser obtera primeira seção:

 C_OBJECT($section)

  // obtém a primeira seção

 $section:=WP Get section(wpDoc;1)

Ver também