Descrizione parametri

ViewId

Id della View da visualizzare

ViewExternalId

ExternalId della View da visualizzare

SelectIds

Elenco degli ID dei campi da mostrare in griglia, separati dal carattere ';'

SelectExternalIds

Elenco degli ExternalId dei campi da mostrare in griglia, separati dal carattere ';'

FieldsToLoadIds

Elenco degli ID dei campi da caricare forzatamente nella griglia senza doverli effettivamente mostrare, separati dal carattere ';'. Risulta utile nel caso in cui si vogliano realizzare delle colonne calcolate che neccessitano del valore di campi da non visualizzare sempre in griglia.

FieldsToLoadExternalIds

Elenco degli ExternalId dei campi da caricare forzatamente nella griglia senza doverli effettivamente mostrare, separati dal carattere ';' Risulta utile nel caso in cui si vogliano realizzare delle colonne calcolate che neccessitano del valore di campi da non visualizzare sempre in griglia.

InsertParams

Permette di specificare dei parametri da passare alle maschere di Insert. Si possono utilizzare tutti i parametri che è possibile passare normalmente ad una maschera di Insert.

Attenzione: Per utilizzare il parametro "Presenter" bisogna utilizzare i ":" e non il "." per specificare le sotto-proprietà ( come da esempio ).

"Presenter[NumeroIdentificativoParametro]:XXX"

Leggi l'elenco completo dei parametri utilizzabili

UpdateParams

Permette di specificare dei parametri da passare alle maschere di Update. Si possono utilizzare tutti i parametri che è possibile passare normalmente ad una maschera di Update.

Attenzione: Per utilizzare il parametro "Presenter" bisogna utilizzare i ":" e non il "." per specificare le sotto-proprietà ( come da esempio ).

"Params[NumeroIdentificativoParametro]:XXX"

Leggi l'elenco completo dei parametri utilizzabili

SessionId

SessionId dell'utente con cui loggarsi a DocsMarshal.

Questo parametro non può essere definito tramite ConfigUrl. Deve essere definito (opzionalmente) nell'URL di chiamata all'API.

ElementId

Id dell'elemento HTML che verrà generato per creare la griglia. L'ID NON deve riferirsi ad un ID già esistente, in quando DocsMarshal ne creerà uno.

ConfigUrl

Url di un documento JSON contenente la configurazione per il componente. Questo parametro è necessario nel caso in cui si vogliano specificare molti parametri, al fine di non superare la lunghezza massima di un'url HTTP.

SaveLayout

Se true, allora il sistema salverà ogni modifica che l'utente apporterà al layout della griglia. Se false, allora la griglia verrà mostrata ogni volta con le impostazioni di default definite tramite i parametri di configurazione.

DocsMarshal memorizza un layout per ogni UserId per ogni GridId.

Attenzione: se questo parametro è impostato su "true" alcuni parametri di ordinamento/raggruppamento come OrderById o GroupByExternalIds (e simili) verranno ignorati.

LoadLayout

Se true, allora il sistema caricherà il layout precedentemente salvato per questi utenti e griglia, se presente.

DocsMarshal memorizza un layout per ogni UserId per ogni GridId.

SaveLayoutFilters

Se true, allora il sistema salverà tutti i filtri configurati nella griglia.

Per essere configurato a true, è necessario che anche il parametro SaveLayout sia impostato a true.

GridId

Identificatore della griglia per il salvataggio del layout.

Il GridId dovrebbe identificare in modo univoco la pagina nella quale viene usata la griglia, oppure dovrebbe indicare lo scopo della griglia. Uno stesso UserId avrà lo stesso layout in tutte le griglie che condividono lo stesso GridId.

UserId

Identificatore dell'utente per il salvataggio del layout.

LanguageId

ID della lingua da impostare per la visualizzazione della griglia. Definisce, ad esempio, quale lingua viene visualizzata quando si seleziona un campo multilanguage.

LanguageCode

LanguageCode della lingua da impostare per la visualizzazione della griglia. Definisce, ad esempio, quale lingua viene visualizzata quando si seleziona un campo multilanguage.

GroupByIds

Elenco degli ID dei campi su cui effettuare raggruppamento, separati dal carattere ';'. È possibile inserire l'ID tra (), così facendo il gruppo verrà inizialmente impostato come collassato, altrimenti verrà impostato come espanso

GroupByExternalIds

Elenco degli ExternalId dei campi su cui effettuare raggruppamento, separati dal carattere ';'. È possibile inserire l'ExternalId tra (), così facendo il gruppo verrà inizialmente impostato come collassato, altrimenti verrà impostato come espanso

OrderByIds

Elenco degli ID dei campi su cui effettuare ordinamento, separati dal carattere ';' e seguiti dal carattere A (Ascending) o D (Descending)

Ad esempio: 10A;20D

OrderByExternalIds

Elenco degli ExternalId dei campi su cui effettuare ordinamento, separati dal carattere ';' e seguiti dal carattere underscore e A (Ascending) o D (Descending)

Ad esempio: Persone_A;Nome_D

NoLayout

Se true, l'HTML generato includerà esclusivamente i tag <script> e <link> necessari, oltre all'elemento contenitore specificato come ElementId.

Se false, l'HTML generato sarà una pagina completa.

NoJQuery

Se true allora non verrà generato il codice per l'inclusione di jQuery. Usare solamente se jQuery è già incluso nella pagina di inclusione. È richiesta una versione di jQuery pari o successiva a v3.x.

NoBootstrap

Se true allora non verrà generato il codice per l'inclusione di Bootstrap. Usare solamente se Bootstrap è già incluso nella pagina di inclusione. È richiesto Bootstrap>=3.3.7, sia script che stylesheet.

NoDxIncludes

Se true allora non verrà generato il codice per l'inclusione degli script DevExpress. Usare solamente se sono già inclusi nella pagina altri componenti di questo tipo.

SearchVisible

Se true allora viene mostrata la barra di ricerca.

Questa ricerca agisce client-side ed è modificabile dall'utente.

FilterPanelVisible

Se true allora viene mostrato il pannello di filtro.

Il pannello di filtro permette di configurare complessi filtri client-side tramite UI.

SearchText

Definisce il valore iniziale di ricerca.

Questa ricerca agisce client-side ed è modificabile dall'utente.

DateFormat

Stringa di formato per la formattazione dei campi Date

DateTimeFormat

Stringa di formato per la formattazione dei campi DateTime

EnableSelection

Se true abilita la selezione, ovvero la possibilità di dare focus a una o più righe.

MultipleSelection

Se true abilita la selezione multipla delle varie righe

MultipleSelectionCheckboxes

Definisce se e quando verranno visualizzati i checkbox per la gestione della multiselezione. Questo parametro viene considerato solamente se MultipleSelection = true. I possibili valori sono i seguenti:

• always: sempre visibili;
• none: sempre nascosti, viene rimossa la colonna aggiuntiva dedicata ai checkbox;
• onClick: visibili quando l'utente clicca la colonna dei checkbox, oppure se vengono selezionate due o più righe;
• onLongTap: visibili se viene tenuto premuto il tasto sinistro del mouse, oppure se viene tenuto premuto il dito con un dispositivo touch.

ShiftSelectionOnArrows

Default: true
Se abilitato, muoversi tra le righe della griglia utilizzando le frecce della tastiera sposta automaticamente anche la selezione.
Disattivabile solo in caso di griglia con multiselezione attraverso questo parametro, oppure premendo il tasto 'Spazio'

NoColumnChooser

Se true allora verrà tolta all'utente la possibilità di aggiungere e rimuovere colonne dalla griglia.

NoGrouping

Se true allora verrà tolta all'utente la possibilità di usare la funzione "Group By".

NoColReordering

Se true allora verrà tolta all'utente la possibilità di riordinare le colonne.

NoColResizing

Se true allora verrà tolta all'utente la possibilità di modificare la largheza delle colonne.

NoStateColor

Se true allora non verranno applicati alla griglia i colori degli stati di DocsMarshal.

Sarà comunque possibile controllare gli stili delle righe sulla base del loro stato tramite CSS: il componente applica ad ogni <tr> una classe CSS .dm-object-state-id-{id} con il corrispondente ObjectStateId.

CanInsert

Simula la mancanza di riservatezze di inserimento nella griglia. Se falso, tutti i metodi per inserire profili verranno quindi disabilitati.

CanUpdate

Simula la mancanza di riservatezze di modifica su tutti i profili della griglia. Se falso, tutti i metodi per modificare i profili verranno quindi disabilitati.

CanDelete

Simula la mancanza di riservatezze di eliminazione su tutti i profili della griglia. Se falso, tutti i metodi per eliminare i profili verranno quindi disabilitati.

AskToInsertAgain

Se true allora dopo ogni inserimento verrà chiesto all'utente se si vuole inserire un altro profilo

ShowEditButton

Indica se mostrare il bottone "modifica" per i profili con le riservatezze necessarie

ShowDeleteButton

Indica se mostrare il bottone "elimina" per i profili con le riservatezze necessarie

ShowPrefixInDynAssColumns

Indica se le colonne provenienti da Dynamic Association devono riportare il prefisso della classe di provenienza. Qualora settando a "false" questo parametro ci dovessero essere due colonne con lo stesso nome, in quelle colonne verrebbero automaticamente re-introdotti i prefissi

FieldLabels

Consente di modificare i label delle colonne della griglia. Questo è valido per campi di sistema, campi aggiuntivi e campi provenienti da Dynamic Associations.

Ogni elemento è così formato:

UsePaging

Se true verrà impostata una paginazione con 20 elementi per pagina.

PageSize

Il numero impostato è il corrispettivo degli elementi visualizzati per ogni pagina.

Valore di default: 20.

ShowNavigationButtons

Se true verranno visualizzati i bottoni avanti e indietro ( < e > ) nella paginazione.

ShowRowLines

Se true mostra il bordo tra le righe

ShowColLines

Se true mostra il bordo tra le colonne

RowFilterCallback

Nome di una funzione Javascript (disponibile nello scope globale) che applica un filtro ai dati ricevuti dalla DataGrid prima che questi vengano passati al componente.

La funzione viene chiamata una volta per ogni riga, e riceve come unico parametro un oggetto contenente i dati relativi alla riga. La funzione deve ritornare true se si vuole tenere la riga, oppure false per scartarla.

RowIsSelectedCallback

Nome di una funzione Javascript (disponibile nello scope globale) che stabilisce per ogni profilo se è selezionato o meno.

La funzione viene chiamata una volta per ogni profilo, e riceve come parametri un oggetto contenente i relativi dati e un booleano che indica se la riga è attualmente selezionata o meno. La funzione deve ritornare true se la riga deve risultare selezionata.

ProfileIsUpdatableCallback

Nome di una funzione Javascript (disponibile nello scope globale) che stabilisce per ogni profilo se è modificabile o meno. Non è possibile rendere modificabile un profilo se le riservatezze non lo consentono.

La funzione viene chiamata una volta per ogni profilo, e riceve come unico parametro un oggetto contenente i relativi dati. La funzione deve ritornare false se si vuole impedire di modificare il profilo.

OnRowPrepared

Nome di una funzione Javascript (disponibile nello scope globale) che verrà invocata ogni qual volta il componente avrà finito di generare l'elemento corrispondente ad una riga della griglia.

La funzione viene chiamata una volta per ogni riga, e riceve come unico parametro un oggetto con le seguenti proprietà:

• rowType object: ha uno dei seguenti valori: data, detail, detailAdaptive, group, groupFooter, header, filter, totalFooter
• data object: i dati relativi alla riga generata. Se ad esempio la griglia mostra dei profili, allora in questa proprietà si trovano i campi di sistema e quelli aggiuntivi. Questa proprietà è valorizzata solamente se rowType ha valore data.
• isSelected bool: definisce se la riga generata è selezionata.
• rowElement object: un oggetto jQuery che rappresenta la riga. È possibile, ad esempio, intervenire su questo oggetto per aggiungere stili personalizzati alla riga.

Where

Specifica dei filtri di ricerca da applicare server-side, non modificabili dall'utente. Ogni elemento dell'array specifica una condizione su un campo aggiuntivo. Tutte le condizioni vengono combinate in AND.

ObjectStates

Elenco degli id o externalid degli object da includere nella search, separati dal carattere ';'

ObjectStateIds

Elenco degli id degli object da includere nella search, separati dal carattere ';'

ObjectStateExternalIds

Elenco degli external id degli object da includere nella search, separati dal carattere ';'. È possibile utilizzare la sintassi "DynAssExternalId.ObjectStateExternalId" per applicare filtri agli stati in Dynamic Association.

Domains

Elenco degli id o degli external id dei Domain da includere nella search, separati dal carattere ';'

DomainIds

Alternativa più ordinata di Domains, elenco degli id dei Domain da includere nella search.

DomainExternalIds

Elenco degli ExternalId dei domini da includere nella search. È possibile utilizzare la sintassi "DynAssExternalId.DomainExternalId" per applicare filtri sui profili in Dynamic Association.

Actions

Specifica delle azioni custom che si possono mettere a disposizione dell'utente.

{
    FieldId: 3,
    FieldExternalId: "Test"
    DynAssPathIds: "4ab45d2f-9a97-4798-bb08-6bb099ba37ee"
    DynAssPathExternalIds: "TestDyn"
    ParameterName * : "extraParamName"
    DefaultValue : "customValForExtraParamName"
}

GridActions

Serve per eseguire delle azioni custom su più profili.

Utilizza i parametri di Actions più alcuni dedicati.

Labels

Serve per definire delle "Etichette" di tipo testuale da andare a sostituire con le etichette di base.

InsertPopupLabel

Se impostato cambia il testo dell'etichetta della finestra di insert

InsertLabel

Se impostato cambia il testo del bottone di insert

UpdatePopupLabel

Se impostato cambia l'etichetta della finestra di update

UpdateLabel

Se impostato cambia il testo del bottone di update

TotalSummary

Serve per aggiungere un sommario, il totale o simili sotto l'ultima riga della pagina. O il "FieldId" o l'"ExternalID" devono essere presenti.

GroupSummary

Serve per aggiungere un sommario sotto i raggruppamenti.

Utilizza gli stessi parametri di TotalSummary, più alcuni dedicati.

Computed

Serve per creare delle colonne aggiuntive calcolate da un parametro passato.

Popups

Permette di configurare l'aspetto e il comportamento di tutti i popup aperti dalla griglia.

Height

Definisce l'altezza da impostare per la griglia. Si può utilizzare un qualsiasi valore valido per CSS.

MenuVisible

Se impostato a "true" allora sarà visibile la barra laterale, che permette di eseguire operazioni sui profili.

MenuEnabled

Se impostato a "true" allora verranno abilitati i comandi che permettono di mostrare e nascondere la barra laterale.

MenuAutoHide

Se impostato a "false" allora la sidebar non verrà chiusa automaticamente nel momento in cui si effettuerà un click al suo esterno

MenuItems

Definisce cosa mostrare nella barra laterale. Il parametro accetta una lista di ID separati dal carattere ";".

Alcuni ID fanno riferimento a dei "gruppi" di elementi. Abilitare il gruppo corrisponde ad abilitare ogni singolo elemento al suo interno.

I possibili ID sono i seguenti:

• archive
• open
• changeStatus
• delete
• clone
• communicationsBox
• profile (gruppo: archive, open, changeStatus, delete, clone, communicationsBox)
• getDefaultDocument
• createFromModel
• documents (gruppo: getDefaultDocument, createFromModel
• startManualWorkflow
• workflow (gruppo: startManualWorkflow)
• resetLayout
• clearLayout
• exportToExcel
• refreshData
• grid (gruppo: resetLayout, clearLayout, refreshData)
• commands (gruppo: profiles, documents, workflow, grid)
• dynamicAssociations
• * (include tutto: commands e dynamicAssociations)

MenuSelectedItem

Definisce quale pannello (tra Commands e DynamicAssociations) deve essere visibile inizialmente nella barra laterale. I possibili valori sono:

• Commands
• DynamicAssociations

MenuExpandedItems

Definisce quale gruppo di elementi deve essere inizialmente espanso nella barra laterale. I possibili valori sono:

• profile
• documents
• workflow
• processes
• grid

TitlesFg

Imposta il colore di foreground dei titoli, ad esempio le intestazioni di colonna. Accetta un qualsiasi colore CSS valido.

AlternateRows

Imposta una colorazione delle righe della griglia a colori alternati.

AlternateRowsColor

Quando viene usato il parametro AlternateRows, questo parametro permette di definire tramite un colore CSS quale colore devono avere le righe dispari.

ObjectStateStyle

Determina l'apparenza della colonna ObjectState. È possibile visualizzare i seguenti elementi:

• Name: Il nome dello stato;
• DotFg: Un cerchio riempito con il colore di foreground dello stato;
• DotBg: Un cerchio riempito con il colore di background dello stato;
• Dot: Un cerchio del colore di background dello stato, con all'interno un cerchio del colore di foreground dello stato;
• DotInverted: Un cerchio del colore di foreground dello stato, con all'interno un cerchio del colore di background dello stato;

È possibile combinare a piacere questi elementi in una stringa, separandoli con il carattere ";". Ad esempio:

• Dot
• Dot;Name
• Name;DotFg
• DotFg;DotBg;Name

FocusOnLoad

Se true, allora il fuoco verrà portato sulla griglia non appena la griglia sarà stata generata.

Export

Se true, allora sarà visibile un pulsante che permette l'esportazione della griglia come file xlsx.

ExportFileName

Permette di specificare il nome del file generato dalla procedura di Export.

ExportFormat

Permette di specificare il formato del file generato dalla procedura di Export. I formati supportati sono:

• XLSX
• PDF - Vedi il parametro PdfExportSettings

PdfExportSettings

Permette di specificare le caratteristiche del file PDF generato dalla procedura di Export.

Le proprietà sono le seguenti:

FixCommands

Permette di specificare se e dove la colonna dei comandi deve essere bloccata.
I valori accettati sono left e right.

InlineEditingMode

Permette di specificare la modalità di inline editing consentita all'utente.
I valori accettati sono:

• none: non consente di fare inline editing.
• cell: le modifiche vengono salvate ogni volta che il valore di una cella viene modificato.
• row: permette di modificare diverse celle di una stessa riga eseguendo un solo update. Mentre le celle vengono modificate, riga rimarrà in uno stato "in modifica" e per salvare le modifiche sarà sufficiente premere "invio" oppure premere l'apposito bottone che si trova nella riga stessa.
• batch: permette di modificare celle su righe e colonne diverse, salvando le modifiche solamente quando l'utente lo richiede esplicitamente. Quando una cella verrà modificata, comparirà un contorno colorato per fare capire che quel dato è stato modificato ma non salvato. L'utente potrà modificare qualsiasi cella, e al termine delle modifiche potrà premere un bottone nella parte alta della griglia per salvare le modifiche oppure per annullare tutte le modifiche.
• form: permette di modificare una riga tramite un form. Le modifiche andranno salvate premendo "invio" oppure tramite l'apposito bottone nella parte bassa del form.

Quando l'inline editing è abilitato, premendo F2 si entra in modalità editing.

L'inline editing permette di fare data entry in modo rapido, con le seguenti eccezioni:

• Non si possono modificare i campi di sistema;
• Non si possono modificare i campi aggiunti da Dynamic Association;
• Tutti i campi sono mostrati con presenter Default.

InlineEditingFieldExternalIds

Elenco degli ExternalId dei campi su cui deve essere possibile fare inline editing. Se non viene specificato alcun valore, allora saranno editabili tutti i campi supportati.
Gli ExternalId devono essere separati dal carattere ";".

Autorefresh

Permette di specificare ogni quanti secondi la griglia deve refreshare automaticamente i dati.

AddRefreshCountdownToTitle

Se è utilizzata la funzionalità di autorefresh della griglia allora questo parametro indica che il titolo della pagina corrente deve essere modificato per mostrare il tempo mancante al prossimo refresh dei dati.

MasterDetailEnabled

Abilita la funzionalità di master/detail sulla griglia, permettendo all'utente di "espandere" individualmente ogni riga rivelandone il dettaglio. A meno che non si indichi diversamente, il dettaglio mostra la maschera di update del profilo selezionato.

MasterDetailHeight

Stringa CSS che indica l'altezza da assegnare al dettaglio quando viene espansa una riga con la funzionalità master/detail.

MasterDetailMaxWidth

Stringa CSS che indica la larghezza da assegnare al detail.

MasterDetailMaskType

Indica se la maschera aperta nel dettaglio dovrà essere di Update o di View. Possibili valori: UPDATE, VIEW.

MasterDetailCustomCallback

Indica il nome di una funzione Javascript che verrà invocata quando l'utente espande una riga per rivelarne il contenuto. La funzione riceve in ingresso un oggetto con due proprietà:

• container: l'elemento jQuery al quale vanno aggiunti i contenuti da mostrare nel dettaglio.
• data: i dati relativi al profilo di cui è stato richiesto il detail.

MasterDetailDynAssExternalId

Permette di indicare l'ExternalId di una DynamicAssociation che verrà mostrata nel detail.

MasterDetailDynAssGridConfig

Il parametro MasterDetailDynAssExternalId consente di configurare la griglia di Dynamic Association da aprire nel dettaglio. Si possono usare tutti i parametri disponibili per una griglia di Dynamic Association.

MasterDetailMaskConfig

Il parametro MasterDetailMaskConfig consente di configurare la maschera di update da aprire nel dettaglio. Si possono usare tutti i parametri disponibili per una maschera di update.

PreviewPanelAllowPrinting

Abilita la funzionalità di stampa di un documento che si sta visualizzando tramite PreviewPanel.

PreviewPanelShowWatermark

Se viene usato il parametro PreviewPanelShowWatermark allora comparirà un Watermark sul documento che si sta visualizzando tramite PreviewPanel.

PreviewPanelFieldExternalId

Se viene usato il parametro PreviewPanelFieldExternalId allora all'apertura del PreviewPanel nell'elenco dei campi sarà preselezionato il campo indicato.

PreviewPanelOpenOnLoad

Se viene usato il parametro PreviewPanelOpenOnLoad allora verrà aperto automaticamente il PreviewPanel a fine caricamento della Grid.

PreviewPanelMaskEnabled

Abilita la funzionalità di visualizzazione del Field Profile nel PreviewPanel, permettendo la visualizzazione della maschera di update predefinita.

PreviewPanelMaskExternalId

Se viene usato il parametro PreviewPanelMaskExternalId verrà utilizzata una maschera aggiuntiva fornita tramite external id per la visualizzazione dei dati del Field Profile nel PreviewPanel.

DynAssGrids

Permette di configurare le griglie che verranno aperte in Dynamic Association tramite il menu "Dynamic Associations" oppure tramite una Action.

Ogni elemento fa riferimento ad una Dynamic Association tramite il suo Id o ExternalId e definisce la configurazione della griglia usando qualsiasi parametro elencato in questa pagina.

In alternativa è possibile indicare una Dynamic Association indicando il ClassTypeId o ClassTypeExternalId di destinazione. In queto modo si configura in maniera più generica come devono essere aperte le griglie che sfoceranno in quella classe, non solo al primo livello ma anche all'n-esimo.

Ad esempio: è necessario creare un griglia di Ordini, ed è necessario che se l'utente navigherà verso una griglia di Clienti, questa dovrà essere aperta con il flag MenuEnabled=false. Esistono più DynAss che vanno da Ordini a Clienti: "Ordini -> Clienti" e "Ordini -> Offerte -> Clienti". Se configurassi le griglie di DynAss utilizzando il parametro DynAssExternalId dovrei ripetere la stessa configurazione per ogni DynAss. Inoltre, qualora dovessero esserci altri "percorsi" di DynAss che portano a Clienti e che non mi sono ricordato (oopure che verranno aggiunti in futuro), l'utente potrebbe arrivare ad una griglia di Clienti avendo il menu abilitato, ed avere quindi accesso a funzionalità non previste. Specificando invece la configurazione della griglia di DynAss usando il parametro ClassTypeExternalId=Clienti ho modo di definire la configurazione della griglia di DynAss una volta sola avendo la garanzia che qualsiasi griglia di DynAss che dovesse raggiungere la classe Clienti avrà il menu disabilitato.

Ogni elemento dell'array può avere queste proprietà: