API Messagebox - TIA Portal

Introduzione al TIA Portal

ft:publication_title
Introduzione al TIA Portal
Product
TIA Portal
Version
V21
Publication date
11/2025
Language
it-IT
API Messagebox

Introduzione

Esiste la possibilità di programmare e visualizzare proprie finestre di dialogo e finestre di conferma. Queste finestre consentono di interagire con l'utente dell'Add-In.

API

La tabella seguente elenca i metodi per leggere "MessageBox" da TIA Portal:

Metodo

Descrizione

MessageBox GetService<MessageBoxProvider>()

È possibile accedere al metodo "GetService<MessageBoxProvider>()" con l'oggetto "TiaPortal".

Il metodo restituisce "MessageBox", il cui valore può essere utilizzato per visualizzare le finestre di dialogo e le finestre di conferma in TIA Portal.

La seguente tabella elenca i metodi di "MessageBox":

Metodo

Descrizione

void ShowNotification(NotificationIcon notificationIcon, string caption, string message)

Viene visualizzata una semplice finestra di dialogo che può essere confermata con "OK".

  • notificationIcon: Questo parametro è un Enum che consente di segnalare gli stati "Success", "Information", "Warning" e "Error". In base a questo Enum, nella finestra di dialogo viene visualizzato un simbolo corrispondente.

  • Caption: Questo parametro contiene l'intestazione della finestra di dialogo.

  • message: Questo parametro contiene il messaggio della finestra di dialogo.

void ShowNotification(NotificationIcon notificationIcon, string caption, string message, string detailedMessage)

Viene visualizzata una finestra di dialogo con delle informazioni aggiuntive che può essere confermata con "OK".

  • notificationIcon: Questo parametro è un Enum che consente di segnalare gli stati "Success", "Information", "Warning" e "Error". In base a questo Enum, nella finestra di dialogo viene visualizzato un simbolo corrispondente.

  • caption: Questo parametro contiene l'intestazione della finestra di dialogo.

  • message: Questo parametro contiene il messaggio della finestra di dialogo.

  • detailedMessage: Questo parametro contiene le informazioni aggiuntive.

ConfirmationResult ShowConfirmation(ConfirmationIcon icon, string caption, string message, ConfirmationChoices choices, ConfirmationResult defaultChoice)

Viene visualizzata una semplice finestra di conferma. È possibile definire quali pulsanti dovranno essere visualizzati.

  • icon: Questo parametro è un Enum che consente di assegnare il tipo di finestra di conferma: 'Critical', 'Error' e 'General'. In base a questo Enum, nella finestra di conferma viene visualizzato un simbolo corrispondente.

  • caption: Questo parametro contiene l'intestazione della finestra di conferma.

  • message: Questo parametro contiene il messaggio della finestra di conferma.

  • choices: Questo parametro è un Enum che consente di assegnare i pulsanti scelti.

    Sono possibili le seguenti combinazioni:

    “OK+CANCEL”, "YES+NO”, "YES+NO+CANCEL”, “RETRY+CANCEL”, “ABORT+RETRY+IGNORE", YES+YESTOALL+NO, YES+YESTOALL+NO+CANCEL, YES+NO+NOTOALL, YES+NO+NOTOALL+CANCEL, YES+YESTOALL+NO+NOTOALL, YES+YESTOALL+NO+NOTOALL+CANCEL.

  • defaultChoice: Questo parametro è un Enum che consente di salvare la selezione standard. La selezione standard deve essere un valore contenuto nel parametro assegnato "choices". La selezione viene visualizzata in TIA Portal come selezione predefinita.

  • confirmationResult: Questo parametro contiene il risultato della finestra di conferma, ovvero il pulsante utilizzato dall'utente per chiudere la finestra di dialogo.

ConfirmationResult ShowConfirmation(ConfirmationIcon icon, string caption, string message, string detailedMessage, ConfirmationChoices choices, ConfirmationResult defaultChoice)

Viene visualizzata una semplice finestra di conferma contenente delle informazioni aggiuntive. È possibile definire quali pulsanti dovranno essere visualizzati.

  • icon: Questo parametro è un Enum che consente di assegnare il tipo di finestra di conferma: 'Critical', 'ERROR' e 'General. In base a questo Enum, nella finestra di conferma viene visualizzato un simbolo corrispondente.

  • caption: Questo parametro contiene l'intestazione della finestra di conferma.

  • message: Questo parametro contiene il messaggio della finestra di conferma.

  • detailedMessage: Questo parametro contiene le informazioni aggiuntive.

  • choices: Questo parametro è un Enum che consente di assegnare i pulsanti scelti.

    Sono possibili le seguenti combinazioni:

    “OK+CANCEL”, "YES+NO”, "YES+NO+CANCEL”, “RETRY+CANCEL”, “ABORT+RETRY+IGNORE", YES+YESTOALL+NO, YES+YESTOALL+NO+CANCEL, YES+NO+NOTOALL, YES+NO+NOTOALL+CANCEL, YES+YESTOALL+NO+NOTOALL, YES+YESTOALL+NO+NOTOALL+CANCEL.

  • defaultChoice: Questo parametro è un Enum che consente di salvare la selezione standard. La selezione standard deve essere un valore contenuto nel parametro assegnato "choices". La selezione viene visualizzata in TIA Portal come selezione predefinita.

  • confirmationResult: Questo parametro contiene il risultato della finestra di conferma, ovvero il pulsante utilizzato dall'utente per chiudere la finestra di dialogo.

Esempio di codice per la visualizzazione di un messaggio in una finestra di dialogo

L'esempio seguente illustra come visualizzare una finestra di dialogo con informazioni aggiuntive:

//...

var messageBox = m_TiaPortal.GetService<MessageBoxProvider>;

messageBox.ShowNotification(NotificationIcon.Information, "Add-In Notification", "Pop up from Context Menu Add-In", "Pop up called from Add-In. Please click Ok to continue.");

//...

L'esempio seguente illustra come visualizzare una semplice finestra di dialogo senza informazioni aggiuntive:

//...

var messageBox = m_TiaPortalGetService<MessageBoxProvider>;

messageBox.ShowNotification(NotificationIcon.Warning, "Add-In Notification", "Pop up from Context Menu Add-In");

//...

Esempio di codice per la visualizzazione di una finestra di conferma

L'esempio seguente illustra come visualizzare una finestra di conferma con informazioni aggiuntive:

//...

var messageBox = m_TiaPortalGetService<MessageBoxProvider>;

ConfirmationResult result = messageBox.ShowConfirmation(ConfirmationIcon.General,"Add-In Confirmation","Confirm Pop up from Add-In", "Confirm Pop up called from Add-In",

ConfirmationChoices.Ok | ConfirmationChoices.Cancel, ConfirmationResult.Ok);

if (result == ConfirmationResult.Ok)

{

//...

}

else

{

//...

}

//...

L'esempio seguente illustra come visualizzare una semplice finestra di conferma senza informazioni aggiuntive:

//...

var messageBox = m_TiaPortal.GetService<MessageBoxProvider>;

ConfirmationResult result = messageBox.ShowConfirmation(ConfirmationIcon.General,"Add-In Confirmation","Confirm Pop up from Add-In",

ConfirmationChoices.Ok | ConfirmationChoices.Cancel, ConfirmationResult.Cancel);

if (result == ConfirmationResult.Ok)

{

//...

}

else

{

//...

}

//...