Partager via


XmlFormCancelEventArgs, classe

Fournit les données du message personnalisé qui s'affiche en cas d'annulation d'événements déclenchés par le formulaire et le document XML sous-jacent.

Espace de noms : Microsoft.Office.InfoPath
Assembly : Microsoft.Office.InfoPath (dans microsoft.office.infopath.dll)

Syntaxe

Public MustInherit Class XmlFormCancelEventArgs
    Inherits CancelEventArgs

Dim instance As XmlFormCancelEventArgs
public abstract class XmlFormCancelEventArgs : CancelEventArgs

Remarques

L'objet XmlFormCancelEvent fournit les propriétés Message et MessageDetails afin de spécifier ou de récupérer un message personnalisé lors de l'annulation des événements Changing, Validating, Save, Merge, Submit, VersionUpgrade et Loading.

Par défaut, les propriétés Message et MessageDetails ont la valeur null.

  • Si ces deux valeurs sont null, le message d'erreur par défaut s'affiche en cas d'annulation d'un événement.

  • Si les deux valeurs ne sont pas null, ce sont alors les valeurs spécifiées pour les propriétés Message et MessageDetails qui s'affichent dans la boîte de dialogue du message d'erreur.

  • Si les deux propriétés sont définies sur une chaîne vide, aucun texte ne s'affiche dans la boîte de dialogue du message d'erreur.

  • La propriété Message peut avoir la valeur null et la propriété MessageDetails une valeur non-null, et inversement. Si l'une des valeurs n'est pas null, InfoPath affiche la valeur spécifiée. Par exemple, si Message est null alors que MessageDetails a une valeur spécifique, InfoPath affiche une boîte de dialogue du message d'erreur ne contenant que la section de détails, pas de texte de niveau supérieur.

  • Dans l'interface utilisateur d'InfoPath en mode Création, vous pouvez indiquer un message personnalisé à afficher en cas d'envoi de réussites ou d'échecs à l'aide de la commande Options d'envoi de formulaire du menu Outils. Si la propriété Message ou MessageDetails contient du code, ces valeurs remplacent le texte spécifié dans l'interface utilisateur d'InfoPath.

Hiérarchie d'héritage

System.Object
   System.EventArgs
     System.ComponentModel.CancelEventArgs
      Microsoft.Office.InfoPath.XmlFormCancelEventArgs
         Microsoft.Office.InfoPath.SaveCancelEventArgs

Sécurité des threads

Les membres statiques publics de ce type (Shared en Visual Basic) sont sécurisés au niveau des threads. Il n'est pas garanti que les membres d'instance soient sécurisés au niveau des threads.

Voir aussi

Référence

Membres XmlFormCancelEventArgs
Microsoft.Office.InfoPath, espace de noms