Partager via


Méthode Document.BeginCustomUndoAction (Publisher)

Spécifie le point de départ et l'étiquette (texte de description) d'un groupe d'actions réunies pour créer une action d'annulation unique.

La méthode EndCustomUndoAction permet de spécifier le point final des actions utilisées pour créer l'action d'annulation unique. Le groupe d'actions formé peut être annulé par une annulation unique.

Syntaxe

expression. BeginCustomUndoAction (ActionName)

Expression Variable qui représente un objet Document .

Parameters

Nom Requis/Facultatif Type de données Description
ActionName Obligatoire Chaîne Étiquette qui correspond à l'action d'annulation unique. Cette étiquette s’affiche lorsque vous choisissez la flèche en regard du bouton Annuler dans la barre d’outils Standard .

Remarques

Les méthodes suivantes de l'objet Document ne sont pas disponibles au sein d'une action d'annulation personnalisée. Une erreur d'exécution est renvoyée si une de ces méthodes sont appelée au sein d'une action d'annulation personnalisée :

  • Close
  • MailMerge.DataSource.Close
  • PrintOut
  • Redo
  • Save
  • SaveAs
  • Undo
  • UndoClear
  • UpdateOLEObjects

La méthode BeginCustomUndoAction doit être appelée avant que la méthode EndCustomUndoAction est appelée. Une erreur d'exécution est renvoyée si la méthode EndCustomUndoAction est appelée avant BeginCustomUndoAction.

L'imbrication d'une action d'annulation personnalisée dans une autre est autorisée, mais l'action d'annulation personnalisée imbriquée n'aura aucun effet. Seule l’action d’annulation personnalisée extérieure sera active.

Exemple

L'exemple suivant contient deux actions d'annulation personnalisé. La première est créée sur la première page de la composition active. La méthode BeginCustomUndoAction est utilisée pour spécifier le point auquel l'action d'annulation personnalisée doit commencer. Six actions individuelles sont exécutées, puis elles sont regroupées en une seule action avec l'appel à EndCustomUndoAction.

Le texte du cadre qui a été créé dans la première action d'annulation personnalisée est ensuite vérifié pour déterminer si la police est Verdana. Si ce n'est pas le cas, la méthode Undo est appelée avec UndoActionsAvailable transmis en tant que paramètre. Dans ce cas, une seule action d’annulation est disponible. Ainsi, l’appel à la méthode Undo n’annule qu’une seule action, mais cette action a encapsulé six actions en une seule.

Une deuxième action d'annulation est ensuite créée. Elle peut être également annulée ultérieurement à l'aide d'une opération d'annulation unique.

Dim thePage As page 
Dim theShape As Shape 
Dim theDoc As Publisher.Document 
 
Set theDoc = ActiveDocument 
Set thePage = theDoc.Pages(1) 
 
With theDoc 
 ' The following six actions are wrapped to create one 
 ' custom undo action named "Add Rectangle and Courier Text". 
 .BeginCustomUndoAction ("Add Rectangle and Courier Text") 
 With thePage 
 Set theShape = .Shapes.AddShape(msoShapeRectangle, _ 
 75, 75, 190, 30) 
 With theShape.TextFrame.TextRange 
 .Font.Size = 14 
 .Font.Bold = msoTrue 
 .Font.Name = "Courier" 
 .Text = "This font is Courier." 
 End With 
 End With 
 .EndCustomUndoAction 
 
 If Not thePage.Shapes(1).TextFrame.TextRange.Font.Name = "Verdana" Then 
 ' This call to Undo will undo all actions that are available. 
 ' In this case, there is only one action that can be undone. 
 .Undo (.UndoActionsAvailable) 
 ' A new custom undo action is created with a name of 
 ' "Add Balloon and Verdana Text". 
 .BeginCustomUndoAction ("Add Balloon and Verdana Text") 
 With thePage 
 Set theShape = .Shapes.AddShape(msoShapeBalloon, _ 
 75, 75, 190, 30) 
 With theShape.TextFrame.TextRange 
 .Font.Size = 11 
 .Font.Name = "Verdana" 
 .Text = "This font is Verdana." 
 End With 
 End With 
 .EndCustomUndoAction 
 End If 
End With

Assistance et commentaires

Avez-vous des questions ou des commentaires sur Office VBA ou sur cette documentation ? Consultez la rubrique concernant l’assistance pour Office VBA et l’envoi de commentaires afin d’obtenir des instructions pour recevoir une assistance et envoyer vos commentaires.