Leadtools.Windows.Annotations Requires Document/Medical license. | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
StartEditing Method
See Also  Example
Leadtools.Windows.Annotations Namespace > AnnAutomation Class : StartEditing Method



annObject
An existing AnnObjectBase to edit.
group
true to group this annObject with the object(s) currently being edited if(any); false otherwise.
annObject
An existing AnnObjectBase to edit.
group
true to group this annObject with the object(s) currently being edited if(any); false otherwise.
Starts editing the given AnnObjectBase.

Syntax

Visual Basic (Declaration) 
Public Overridable Sub StartEditing( _
   ByVal annObject As AnnObjectBase, _
   ByVal group As Boolean _
) 
Visual Basic (Usage)Copy Code
Dim instance As AnnAutomation
Dim annObject As AnnObjectBase
Dim group As Boolean
 
instance.StartEditing(annObject, group)
C# 
public virtual void StartEditing( 
   AnnObjectBase annObject,
   bool group
)
C++/CLI 
public:
virtual void StartEditing( 
   AnnObjectBase^ annObject,
   bool group
) 

Parameters

annObject
An existing AnnObjectBase to edit.
group
true to group this annObject with the object(s) currently being edited if(any); false otherwise.

Example

This example will add a new rectangle object to the active automation of an automation manager. It will then "select" this object and make it ready for editing.

Visual BasicCopy Code
Private Sub AnnAutomation_StartEditing(ByVal manager As AnnAutomationManager)
   ' find the active automation
   Dim automation As AnnAutomation = Nothing
   Dim index As Integer = 0
   Do While index < manager.Automations.Count AndAlso automation Is Nothing
      If manager.Automations(index).Active Then
         automation = manager.Automations(index)
      End If
      index += 1
   Loop
   If Not automation Is Nothing Then
      ' add a new rectangle object to this automation
      Dim rectObj As AnnRectangleObject = New AnnRectangleObject()
      rectObj.Left = 100
      rectObj.Top = 100
      rectObj.Width = 200
      rectObj.Height = 200
      rectObj.Stroke = Brushes.Blue
      rectObj.StrokeThickness = 2.0
      rectObj.Fill = Brushes.Yellow

      ' surround the changes to the automation by an undo
      automation.BeginUndo()

      automation.Container.Children.Add(rectObj)

      ' "select" this rectangle and make it ready for editing
      automation.StartEditing(rectObj, False)

      automation.EndUndo()
   End If
End Sub
C#Copy Code
private void AnnAutomation_StartEditing(AnnAutomationManager manager) 

   // find the active automation 
   AnnAutomation automation = null; 
   for(int index = 0; index < manager.Automations.Count && automation == null; index++) 
   { 
      if(manager.Automations[index].Active) 
         automation = manager.Automations[index]; 
   } 
   if(automation != null) 
   { 
      // add a new rectangle object to this automation 
      AnnRectangleObject rectObj = new AnnRectangleObject(); 
      rectObj.Left = 100; 
      rectObj.Top = 100; 
      rectObj.Width = 200; 
      rectObj.Height = 200; 
      rectObj.Stroke = Brushes.Blue; 
      rectObj.StrokeThickness = 2.0; 
      rectObj.Fill = Brushes.Yellow; 
 
      // surround the changes to the automation by an undo 
      automation.BeginUndo(); 
 
      automation.Container.Children.Add(rectObj); 
 
      // "select" this rectangle and make it ready for editing 
      automation.StartEditing(rectObj, false); 
 
      automation.EndUndo(); 
   } 
}

Remarks

This method is called by the AnnAutomation object in design user mode whenever an object is "selected" (by clicking it with the mouse usually). You can manually start the editing process of an object by calling this method.

If you have object(s) that are currently being edited in this AnnAutomation and you want to either create a new group or add an annObject to the group currently being edited, then pass true for group; otherwise pass false. Passing true when no objects are currently being edited will not create a new group and edits this object individually as normal. Passing false when objects are currently being edited will cause the current editing operation to be canceled and start a new one for annObject.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Vista, and Windows Server 2003 family

See Also

StartEditing requires a Document/Medical product license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features and Unlocking Special LEAD Features.