BlackBox.

Metodi

 

void DisableTemporarilyValidityRulesForElement(string elementName): disabilita le validity rules associate all' elemento indicato;

string elementName: nome dell' elemento di cui si vogliono disabilitare le VR associate;
void ActivateTemporarilyDisabledValidityRules(): attiva le VR disattivate senza attivarne l' esecuzione;
void AddDiagramRuleOnPage(string areaGrafica, string diagramName, BBTRulesEngine.Diagrams.RuleNode mainNode, System.Collections.Generic.List menuActions, BBTRulesEngine.Diagrams.Types.DiagramRuleOptions optionsGraphic): crea un nuovo diagram sulla pagina grafica indicata sui parametri di passaggio;

string areaGrafica: nome dell' area grafica definita come place holder sulla pagina Web corrispondente;

string ruleName: nome del diagramma. Di fatto si consiglia di utilizzare il nome della regola;

BBTRulesEngine.Diagrams.RuleNode mainNode: nodo principale della regola grafica;

System.Collections.Generic.List shapeDefinitions: definizione della grafica dei nodi;

System.Collections.Generic.List menuActions: definizione del contesto delle azioni associate ai singoli nodi;

BBTRulesEngine.Diagrams.Types.DiagramRuleOptions optionsGraphic: opzioni grafiche del diagram;

void AddDiagramRuleOnPage(BBTRulesEngine.Diagrams.DiagramRule diagram): aggiorna il diagram passato come parametro sulla pagina grafica su cui si sta operando. Il diagram deve già essere stato creato;

BBTRulesEngine.Diagrams.DiagramRule diagramdiagram con cui si sta operando, creato con il precedente metodo;

void AddJavascript(string javaScript): manda in esecuzione un java script;

string javaScript: contiene il java script;

void ClearAll(): effettua la clear di tutti gli elementi definiti su Box;

void DisableAllAutomaticFormula(): disabilita il calcolo automatico delle formule definite sui numerici del Box;

void EnableAllAutomaticFormula(): abilita il calcolo automatico delle formule definite sui numerici del Box. Di default il calcolo automatico è abilitato;

void Dispose(): rimuove l' engine dalla memoria;

void DownloadFile(string filePath, string fileName, string completePath): effettua il download di un file;

string filePath: path in cui si ritrova il file;

string fileName: nome del file;

string completePath: path completo di download;

void ExportDiagramRule(string diagramName, string mode, string mode, string format, string savePath, string afterExportMethod): consente di effettuare l' export x la stampa della grafica di una regola;

string diagramName: nome della regola;

string mode: modalità di export. Se Data si predispone l' immagine grafica della regola per la stampa di un successiovo documento. Se Download si effettua il semplice download dell' immagine;

string format: formato dell' immagine (ad es. PNG);

string savePath: path completo (include il nome dell' immagine) per il salvataggio dell' immagine;

string afterExportMethod: metodo da attivare dopo l' export;

(List Type ElementRow) ExportElementRows(IBlackBoxElement elementName): esporta le righe di un elemento Lista;

IBlackBoxElement elementName: elemento di cui predisporre la lista delle righe;

[output] (List Type ElementRow): lista delle righe esportate dell' elemento;

string ExportSelection((List Type string) elementsList): ritorna una stringa contenente l' esportazione degli elementi passati o di tutti gli elementi del Box;

(List Type string) elementsList: lista degli elementi che si vogliono esportare. Se la lista è nulla, vengono esportati tutti gli elementi;

[output] string: stringa contenente l' esportazione richiesta;

BlackBoxDecisionRule GetBlackBoxDecisionRule(string ruleName): rende disponibile l' oggetto rule richiesto;

string ruleName: identificativo o nome della regola;

[output] BlackBoxDecisionRule: oggetto rule;

BlackBoxMethod GetBlackBoxMethod(string methodName): rende disponibile l' oggetto method richiesto;

string methodName: identificativo o nome del metodo;

[output] BlackBoxMethod: oggetto method;

BlackBoxPage GetBlackBoxPage(string pageName): rende disponibile l' oggetto page richiesto;

string pageName: identificativo o nome della pagina;

[output] BlackBoxPage: oggetto page;

BlackBoxProperty GetBlackBoxProperty(string propertyName): rende disponibile l' oggetto property (sia quelle standard che le Extra);

string propertyName: identificativo o nome della property;

[output] BlackBoxProperty: oggetto property;

DiagramRule GetCurrentOnPageDiagramRule(string diagramName): rende disponibile l' oggetto diagram della pagina corrente;

string diagramName: identificativo o nome del diagram;

[output] DiagramRule: oggetto diagram;

RuleNodeBase GetLastClickedDiagramInfo(string ruleName): rende dispobile l' oggetto node corrispondente all' ultimo nodo su cui si è cliccato della regola passata;

string ruleName: nome della regola;

[output] RuleNodeBase: oggetto node. é l' ultimo nodo su cui si è cliccato;

string GetTranslation(string word, string language): ritorna la traduzione del testo richiesto nel linguaggio richiesto;

string word: testo di cui si richiede la traduzione. Il testo deve essere o una label sulle pagine Web o il valore di una oggetto sempre presente sulle pagine Web o una label/valore manuale;

string language: linguaggio in cui si vuole la traduzione;

[output] string: traduzione;

bool HasDiagramRuleBeenDrawn(string diagramName): verifica se il diagramma indicato è stato graficamente rappresentato sulla pagina;

string diagramName: identificativo o nome del diagramma (di fatto la regola);

[output] bool: true se disegnato, false in caso contrario;

bool HasElement(string elementName): verifica se l' elemento indicato è di fatto un oggetto del Box;

string elementName: nome dell' elemento;

[output] bool: true se oggetto del Box, false in caso contrario;

void ImportElementRows((List Type ElementRow) elementRows, BlackBoxListElement listElement): importa le righe di un elemento Lista;

(List Type ElementRow) elementRows: righe da importare;

BlackBoxListElement listElement): oggetto Lista;

void ImportSelection(string selection, bool silent = false): importa le info esportate precedentemente e contenute in selection;

string selection: stringa contenente le info da importare;

bool silent: se false eventuali errori vengono segnalati, se true no;

void InitializeDefaults(): riassegna agli oggetti del Box l' eventuale valore di default assegnato in anagrafica;

void MakePrompt(string promptText, string promptElementName, string promptTitle = "", string submitButtonText = "", string afterPromptMethod = "", string startPromptText = ""): consente di effettuare una domanda all' utente (prompt);

string promptText: label associata al campo di prompt;

string promptElementName: identificativo della stringa che conterrà la risposta;

string promptTitle: titolo del frame prompt;

string submitButtonText: testo da associare al bottone di conferma;

string afterPromptMethod: metodo da attivare a seguito della risposta;

string startPromptText: testo iniziale associato al prompt;

void MakeQuestion(string question, string firstAnswer, string secondAnswer, string firstAnswerMethod, string secondAnswerMethod, string title = ""): richiesta all' utente;

string question: testo della domanda

string firstAnswer: testo da riportare sul primo CB di risposta;

string secondAnswer: testo da riportare sul secondo CB di risposta;

string firstAnswerMethod: metodo da attivare se prima risposta;

string secondAnswerMethod: metodo da attivare se seconda risposta;

string title: titolo del frame prompt;

void MakeQuestion(string question, (List Type BlackBoxAnswer) answers, string title = ""): richiesta all' utente;

string question: testo della richiesta;

(List Type BlackBoxAnswer) answers: lista delle possibili risposte;

string title: titolo del frame prompt;

void MakeToast(BlackBoxToast toast): visualizza il messaggio toast indicato;

BlackBoxToast toast: toast;

void MakeToast(string message, string title, BlackBoxToastType type, BlackBoxToastPosition position, int duration = 1000): visulizza il toast applicando le caratteristiche indicate;

string message: testo del messaggio;

string title: titolo del toast;

BlackBoxToastType type: tipologia (Warning, Info, Error, Success);

BlackBoxToastPosition position: posizionamento (toast_top_right, toast_bottom_right, toast_bottom_left, toast_top_left, toast_top_full_width, toast_bottom_full_width, toast_top_center, toast_bottom_center);

int duration: tempo di permanenza sulla pagina;

public void MergeDocumentFields(DocumentFile document): prende tutti i bookmark e li itera, e per ogni bookmark, il cui nome corrisponde al nome di un oggetto definito sul Box, sostituisce il valore (per ora non contemplate le column, prossimi rilasci). Visto che word non permette di inserire due volte un bookmark con lo stesso nome (la casistica potrebbe nascere nel caso che lo stesso element vada messo più volte nel documento in punti diversi) basta dare il nome al bookmark come segue:
ElementName__1,ElementName__2...ElementName__n
In questo caso verrà preso solo ciò che c'è prima di __ (doppio underscore).

DocumentFile document: oggetto document;

void OpenFrame(BlackBoxFrame blackBoxFrame): apre l' oggetto frame indicato;

BlackBoxFrame blackBoxFrame: frame;

void OpenFrame(string pageName, string title = "", string icon = "", string closeMethod = ""): apre il frame con le caratteristiche indicate

string pageName: identificativo o nome della pagina Web corrispondente;

string title: titolo del frame;

string icon: icona da riportare sulla testata del frame;

string closeMethod: metodo da attivare alla chiusura del frame;

void SetClipboard(string text): assegna il testo indicato alla variabile interna BlackBox._clipBoard;

string text: testo da assegnare alla variabile;

void SetLastClickedDiagramInfo(string diagramName, RuleNodeBase clickedInfo): setta il nodo indicato come ultimo nodo cliccato sul diagramma indicato;

string diagramName: identificativo o nome del diagramma;

RuleNodeBase clickedInfo: oggetto nodo della struttura;

void SetValiditySecondStepActive(bool isActive): attiva una maggior analisi di dettaglio sulle VR;

bool isActive: true se l' analisi è attiva, false in caso contrario;

void ThrowBlackBoxException(Exception ex): attiva un' eccezione. Da utilizzarsi per tenere sotto controllo errori non previsti sui metodi;

Exception ex: testo dell' eccezione;

 

Variabili

 

string AuthenticatedUserId { get; private set; }: ID dell' utente che si è autenticato;

string Clipboard: contenuto della clipboard settata dall' engine;

ConnectorType ConnectorType: tipologia del connettore con cui si sta operando. Ad oggi valori possibili: None, SugarCRM;

(IEnumerable Type BlackBoxDecisionRule) DecisionRules: lista delle decision rules definite sul Box;

string DescriptionUNKNOWN;

(IEnumerable Type IBlackBoxElement) Elements { get; private set; }: riporta la lista degli oggetti definiti sul Box;

(IEnumerable Type BlackBoxFrame) Frames: iporta la lista degli oggetti frame definiti sul Box;

bool HasConnector: se è definito e attivo un connettore. True se definito, false se non definito;

bool HasConnectorLoadElements: se presenti elementi del Box che prevedono una inizializzazione via Load Connector. True se la prevedono, false in caso contrario;

Guid Id { get; }UNKNOWN;

Dictionary<string, string> InitialRequestUNKNOWN;

(IEnumerable Type BlackBoxJavascript) Javascripts: lista di tutti i JavaScripts definiti da attivare;

(IEnumerable Type BlackBoxMessageElement) Messages: lista di tutti gli oggetti di tipo messaggio definiti sul Box;

(IEnumerable Type BlackBoxMethod) Methods: lista di tutti gli oggetti di tipo method definiti sul Box;

string Name: UNKNOWN;

(IEnumerable Type BlackBoxPage) Pages: lista di tutti gli oggetti di tipo page definiti sul Box;

(IEnumerable Type BlackBoxPrompt) Prompts: lista di tutti gli oggetti di tipo prompt;

(IEnumerable Type BlackBoxQuestion) Questions: lista di tutti gli oggetti di tipo question;

(IEnumerable Type IBlackBoxRule) Rules { get; internal set; }: lista di tutti gli oggetti di tipo rule;

string SourceFileDirectory { get; }: definisce la directory in cui è contenuto l' XLSX del Box;

Stream SourceFileStream { get; }UNKNOWN;

BlackBoxSourceType SourceType: tipologia della struttura base del Box. Ad oggi unico valore: Excel;

BlackBoxPage StartPage: identifica l' oggetto page che è di fatto la pagina di start dell' applicazione;

(IEnumerable Type BlackBoxToast) Toasts: lista di tutti gli oggetti di tipo toast;

BlackBoxTranslationInfo TranslationInfo { get; set; }: identificativo dell' oggetto che contiene le info relative alla localizzazione;

(IEnumerable Type BlackBoxValidityRule) ValidityRules: di tutti gli oggetti di tipo validity rule;

BlackBoxFactory.

Metodi

 

BlackBox CreateNewBlackBox(BlackBoxSourceType sourceType, string sourceFileDirectory): crea un nuovo Box;

BlackBoxSourceType sourceType: tipologia della sorgente (attualmente: Excel);

string sourceFileDirectory: path completo del file sorgente utile per la creazione del Box;

[output] BlackBox: oggetto BlackBox;

BlackBox CreateNewBlackBox(BlackBoxSourceType sourceType, Stream sourceFileStream): crea un nuovo Box;

BlackBoxSourceType sourceType: tipologia della sorgente (attualmente: Excel);

Stream sourceFileStream: ;

[output] BlackBox: oggetto BlackBox;

BlackBox GetBlackBoxsById(Guid id): ritorna l' oggetto BlackBox riferito all' ID indicato;

Guid id: ID del Box;

[output] BlackBox: oggetto BlackBox;

bool HasBlackBox(string id): verifica l' esistenza del Box con ID indicato;

string id: ID del Box in formato stringa;

[output] bool: true se il Box esiste, false in caso contrario;

bool HasBlackBoxById(Guid id): verifica l' esistenza del Box con ID indicato;

Guid id: ID del Box;

[output] bool: true se il Box esiste, false in caso contrario;

void RemoveBlackBoxById(Guid id): elimina il Box con l' ID indicato;

Guid id: ID del Box;

BlackBoxGeneralUtility.

Metodi

 

DateTime ConvertToDateTime(string dValue): converte una data da stringa a DateTime;

string dValue: stringa contenente la data;

[output] DateTime: data convertita;

bool TryParseToDateTime(string dValue, out DateTime dateTime): converte una data da stringa a DateTime e ritorna l' esito della conversione;

string dValue: stringa contenente la data;

out DateTime dateTime: data convertita;

[output] bool: true se la conversione è andata a buon fine, false in caso contrario;