WP Get breaks

4D v20 R7

WP Get breaks


WP Get breaks ( objAlvo {; tipoQuebra} ) -> Resultado

Parâmetro	Tipo	Descrição
objAlvo	Objeto	Range/faixa de seleção ou elemento ou documento 4D write Pro
tipoQuebra	Inteiro longo	Tipo de quebra a retornar
Resultado	Collection	Coleção de ranges/faixas de seleção

Descrição

O comando WP Get breaks retorna a coleção de todas as quebras inseridas em objAlvo.

Esse comando só retorna quebras digitadas pelo usuário ou pelo código, e não as quebras geradas automaticamente por 4D Write Pro em processos de layout.

No parâmetro objAlvo, pode passar:

uma range/faixa, ou
um elemento (tabela / linha / parágrafo / corpo / cabeçalho / rodapé / seção / subseção), ou
um documento 4D Write Pro

Como padrão, quebras de qualquer tipo são retornadas. Pode selecionar um tipo de quebra específico para retornar passando uma das constantes abaixo no parâmetro opcional tipoQuebra:

Constante	Valor	Comentário
wk column break	3	Quebra de coluna: insere uma quebra de coluna
wk continuous section break	5	Define uma quebra de seção contínua (frequentemente usada para mudar o número de colunas sem começar uma nova página).
wk line break	0	Quebra de linha (no mesmo parágrafo)
wk page break	2	Quebra de página: define uma nova página
wk paragraph break	4	Quebra de parágrafo: define um novo parágrafo
wk section break	1	Quebra de seção: define uma nova seção

Valor retornado

WP Get breaks retornar uma coleção de objetos range, cada um deles descrevendo uma quebra dentro do objAlvo. Uma propriedade específica apenas leitura está disponível em cada objeto range, oferecendo o tipo de quebra:

[#table]PropriedadeTipoConstanteDescrição
[ ].breakTypeNumberwk break typeApenas leitura: tipo de quebra#/table]

Se objAlvo for uma range ou elemento, quebras são retornadas na ordem em que são encontrados. Se objAlvo for um documento 4D Write Pro, quebras são retornadas na ordem abaixo:

corpo
cabeçalho da primeira página para seção 1 (se houver)
cabeçalho da primeira página para seção 1 (se houver)
cabeçalho da página esquerda da seção 1 (se houver)
rodapé da página esquerda da seção 1 (se houver)
cabeçalho da página direita para seção 1 (se houver)
rodapé da página direita para seção 1 (se houver)
cabeçalho principal para seção 1 (se houver)
rodapé principal para seção 1 (se houver)
repetir com seção 2, seção 3, e assim por diante.
text boxes

Uma coleção vazia é retornada se objAlvo não conter qualquer quebra (ou qualquer quebra da petição de tipoQuebra).

Exemplo

Se quiser substituir todas as quebras de linha por quebras de parágrafo no documento:

 var $_filteredBreaks : Collection

 var $break : Object

 $_filteredBreaks:=WP Get breaks(WParea;wk line break)

 For each($break;$_filteredBreaks)

    WP INSERT BREAK($break;wk paragraph break;wk replace)

 End for each

Ver também

WP Get elements
WP INSERT BREAK