Document.BeginCommandGroup method - Developer Area

API Documentation > Corel DESIGNER > 2019.2 > Document > IVGDocument

Document.BeginCommandGroup method

Starts to list a group of commands, which can later be undone in a single step

Syntax:

Sub BeginCommandGroup(Optional ByVal CommandName As String)

Parameters:

Name	Type	Description
CommandName	String	Specifies the name of the command.

Remarks:

The BeginCommandGroup method marks the start of a group of commands. By starting a command group, you define a sequence of document handling commands that you can undo in a single step.

The BeginCommandGroup and EndCommandGroup commands must be used with extreme caution. If an error occurs after BeginCommandGroup but before EndCommandGroup, and the macro is terminated, the undo stack of Corel DESIGNER for the current document becomes corrupt. You must ensure that EndCommandGroup is always issued after BeginCommandGroup. Proper error-trapping is strongly recommended.

Examples:

The following VBA example creates a flower. After the macro finishes, its result can be undone in one step; the Edit menu displays an Undo Flower item.

Sub Test()
  Const Leaves As Long = 30
  Const Radius As Double = 2
  Dim stp As Double
  Dim i As Long
  Dim d As Document
  Dim s As Shape
  stp = 360 / Leaves
  Set d = ActiveDocument
  d.DrawingOriginX = 0
  d.DrawingOriginY = 0
  d.BeginCommandGroup "Flower"
  Set s = d.ActiveLayer.CreateEllipse2(0, 0, Radius)
  s.Fill.UniformColor.RGBAssign 100, 50, 50
  Set s = d.ActiveLayer.CreateEllipse2(Radius + 0.5, 0, 0.5, 0.25)
  s.Fill.UniformColor.RGBAssign 255, 255, 0
  s.RotationCenterX = 0
  s.RotationCenterY = 0
  d.ApplyToDuplicate = True
  For i = 1 To Leaves - 1
    s.Rotate i * stp
  Next i
  d.EndCommandGroup
End Sub

You must ensure that EndCommandGroup is always issued after BeginCommandGroup. Proper error-trapping, such as in the following VBA example, is strongly recommended.

Sub Test()
  ActiveDocument.BeginCommandGroup "My Command"
  On Error Goto ErrHandler
  ' Some commands go here
  ExitSub:
  ActiveDocument.EndCommandGroup
  Exit Sub
  ErrHandler:
  MsgBox "Error occured: " & Err.Description
  Resume ExitSub
End Sub

Version Information:

CorelDRAW:	X7.4, X7, X7.6, X8, 2017, 2018, 2019, 2019.2, 2020, 2021, 2020.1, 2021.5, 2022-v24, 2022-v24.1, 2022-v24.2, 2023-v24.3, 2023-v24.5, 2024-v25
Corel DESIGNER:	X7, 2017.1, 20.1, 2019.2, 2020.1, 2021.5, 2022-v24, 2022-v24.1, 2022-v24.2, 2023-v24.3, 2023-v24.5, 2024-v25