funzioneScopo
Questa funzione ritorna una stringa che rappresenta il nome del documento in modo tale che l'utente che la legge è in grado di capire di che documento si tratta. Ad esempio, se il documento è un articolo viene ritornato il suo nome. Questa funzione può essere utile per far capire all'utente su quale documento sta lavorando.
Sintassi
string nome = "" // Il nome proprio del documento
//
nome := Documento.GetName(tipo di nome)
//
nome := Documento.GetName(tipo di nome)
Argomenti
| tipo di nome | E' un parametro intero che rappresenta il tipo di nome desiderato. Internamente vengono riconosciuti i valori 0, 1 o 2 come meglio indicato nelle note seguenti. |
Valore di ritorno
Viene ritornata una stringa che rappresenta il nome del documento. Esso risulta dalla concatenazione delle proprietà del documento che derivano da campi del database che hanno il flag "describe row" attivo. L'evento di OnGetName permette di personalizzare questo algoritmo per esprimere il nome desiderato.
Esempio di codice
// ********************************************
// Fired when the active row in a panel changes
// ********************************************
event Prodotti.Prodotto.OnChangeRow()
{
Prodotto p = null // Il prodotto selezionato
//
// Prendo il prodotto selezionato nel pannello
p := Prodotto.Document
//
// Se ce n'è uno...
if NOT(p IS Null Object)
{
// Scriviamo a video di che documento si tratta
Prodotto.Valore0.Caption := p.GetName(ZERO)
Prodotto.Valore1.Caption := p.GetName(ONE)
Prodotto.Valore2.Caption := p.GetName(C2)
}
}
// Fired when the active row in a panel changes
// ********************************************
event Prodotti.Prodotto.OnChangeRow()
{
Prodotto p = null // Il prodotto selezionato
//
// Prendo il prodotto selezionato nel pannello
p := Prodotto.Document
//
// Se ce n'è uno...
if NOT(p IS Null Object)
{
// Scriviamo a video di che documento si tratta
Prodotto.Valore0.Caption := p.GetName(ZERO)
Prodotto.Valore1.Caption := p.GetName(ONE)
Prodotto.Valore2.Caption := p.GetName(C2)
}
}
- Se il parametro vale zero o viene lasciato vuoto, allora viene ritornato il nome del documento come sopra indicato.
- Se il parametro vale uno allora viene ritornato il nome del documento prefisso dal nome leggibile della classe.
- Se il parametro vale due allora viene ritornato lo stesso valore del caso precedente, ma il nome del documento è circondato da tag HTML che ne cambiano il colore e lo rendono più visibile.
- E' possibile chiamare la funzione anche con valori del parametro maggiori di due. In questo caso il framework calcola il nome come se valesse zero, ma poi l'evento di OnGetName riceve il valore passato e può agire di conseguenza. E' così possibile programmare ulteriori tipi di nome supportati dal documento.
- Se si attacca un documento ad una form, come ad esempio in caso di videate master detail DO, allora il nome del documento viene mostrato nella caption della form.
Ultima modifica: 25/10/2016 / Validità: da 6.5.2680