eventoCondizioni di notifica
Questo evento viene notificato al documento quando l'interfaccia utente vuole sapere come chiamare il documento corrispondente. Questo può avvenire in diversi contesti, fra i quali:
- Una visualizzazione ad albero vuole sapere come nominare il nodo corrispondente al documento.
- In una videata master-detail DO, il pannello detail riesegue la query.
- Viene utilizzata la funzione GetName da una procedura Visual Code.
- Il modulo di debug vuole sapere come indicare il documento nel debug.
- Un documento viene associato ad una form impostandone la proprietà Document.
Utilizzo consigliato
Questo evento deve essere utilizzato per fornire un buon "nome" per il documento. Se l'evento non viene gestito, il framework calcola in modo automatico il nome del documento mostrando la prima proprietà del documento che corrisponde ad un campo del database che ha il flag Describe Row attivo.
Argomenti
| Name | Parametro di input/output di tipo stringa. Inizialmente contiene il nome che il framework ha calcolato per il documento, può essere impostato per chiamare il documento a proprio piacimento. |
| Name Type | Questo parametro intero indica quale "tipo" di nome viene richiesto. Il framework può richiedere diversi tipi di nome, vedere le note per maggiori informazioni. |
| Caller Collection | Collection in cui è contenuto il documento. Può essere diversa dalla ParentCollection se il documento è contenuto per reference. |
| Caller Form | Form che contiene l'oggetto visuale per cui l'evento viene chiamato. Usare la funzione Me dell'oggetto Form per effettuare i confronti. Può valere ZERO per non indicare una form in particolare. |
| Caller Frame | Oggetto visuale per cui viene chiamato l'evento. Utilizzare la funzione Me per effettuare i confronti. Può valere ZERO per non indicare un oggetto visuale in particolare. |
Esempio di codice
// ********************************************************************
// Fired by a tree to know which name should by shown for this document
// ********************************************************************
event Categoria.OnGetName(
inout string Name // Name of this document
int NameType // Name Type (i.e. 0 = standard name, 1 = full name...)
IDCollection CallerCollection // This is the collection this document is contained in.
int CallerForm // Caller Form Index
int CallerFrame // Caller Frame Index
)
{
string np = "???" // Numero di prodotti
//
if Prodotti.Loaded
{
np := ToString(Prodotti.Count())
}
//
// Nel nome della categoria voglio indicare il numero di prodotti
Name := FormatMessage(MSG Prodotti, Name, np, ??, ??, ??)
}
// Fired by a tree to know which name should by shown for this document
// ********************************************************************
event Categoria.OnGetName(
inout string Name // Name of this document
int NameType // Name Type (i.e. 0 = standard name, 1 = full name...)
IDCollection CallerCollection // This is the collection this document is contained in.
int CallerForm // Caller Form Index
int CallerFrame // Caller Frame Index
)
{
string np = "???" // Numero di prodotti
//
if Prodotti.Loaded
{
np := ToString(Prodotti.Count())
}
//
// Nel nome della categoria voglio indicare il numero di prodotti
Name := FormatMessage(MSG Prodotti, Name, np, ??, ??, ??)
}
- Il framework chiama l'evento con il parametro Name Type = 0 se vuole sapere il nome "semplice" del documento.
- Il framework chiama l'evento con il parametro Name Type = 1 se vuole sapere il nome "completo" del documento. Il nome completo normalmente comprende il nome del tipo di documento (nome della classe) seguito dal nome semplice.
- Il framework chiama l'evento con il parametro Name Type = 2 se vuole sapere il nome "decorato" del documento. Il nome decorato è un nome completo in cui la seconda parte viene racchiusa da tag HTML che lo rendono di colore diverso, più visibile.
- La funzione AsString chiama l'evento con Name Type = 3. In questo modo potrebbe essere restituita una rappresentazione testuale completa del contenuto del documento.
- La funzione GetName chiama l'evento con Name Type a piacimento. In questo modo è possibile ottenere diverse rappresentazioni testuali del documento in base alle esigenze applicative.
Ultima modifica: 23/03/2021 / Validità: da 6.5.2680