←Select platform

AnnAutomation Class Members

Summary

The following tables list the members exposed by AnnAutomation.

Public Constructors

Name Description
Public Constructor AnnAutomation Initializes a new instance of the AnnAutomation class.

Public Methods

Name Description
Public Method AddLayer Adds a layer to the container.
Public Method AlignBottoms Aligns the selected objects along with alignment target bottom side.
Public Method AlignCenters Aligns the selected objects along with alignment target horizontal center.
Public Method AlignLefts Aligns the selected objects along with alignment target left side.
Public Method AlignMiddles Aligns the selected objects along with alignment target vertical center.
Public Method AlignRights Aligns the selected objects along with alignment target right side.
Public Method AlignTops Aligns the selected objects along with alignment target top side.
Public Method ApplyAllDecryptors Applies all the decryptor AnnEncryptObject objects in this AnnAutomation.
Public Method ApplyAllEncryptors Applies all the encryptor AnnEncryptObject objects in this AnnAutomation.
Public Method ApplyDecryptor Applies the decryptor AnnEncryptObject that is currently being edited (selected).
Public Method ApplyEncryptor Applies the encryptor AnnEncryptObject object currently being edited (selected).
Public Method Attach Attaches this AnnAutomation object to an IAnnAutomationControl object.
Public Method AttachContainer Attaches this AnnAutomation object to a container and optional undo/redo object.
Public Method BeginUndo Creates a new undo node in this AnnAutomation object.
Public Method BeginUpdateContainers Stops the automation from passing events to the automation control while containers are being added or removed.
Public Method BringLayerToFront Brings the currently selected layer up in the Z-order.
Public Method BringToFront Brings the currently selected object(s) up in the Z-order.
Public Method Cancel Cancels the operation currently being performed in this AnnAutomation.
Public Method CancelUndo Cancels the undo node started in this AnnAutomation object.
Public Method Copy Copies the objects currently being edited to the clipboard.
Public Method DeleteLayer Deletes a layer from the container.
Public Method DeleteSelectedObjects Deletes the selected objects from this AnnAutomation.
Public Method Detach Detaches this AnnAutomation object from its IAnnAutomationControl object.
Public Method EndDesigner Ends (and commits) the operation currently being performed in this AnnAutomation.
Public Method EndUndo Commits the undo node started in this AnnAutomation object.
Public Method EndUpdateContainers Instructs the viewer that updates are completed and rendering of the content can be resumed.
Public Method Flip Flips the objects that are currently being edited (selected) in this AnnAutomation.
Public Method GetContainerInvalidRect Gets the current invalidate rectangle (the physical location and size) of a container.
Public Method GetObjectInvalidateRect Gets a LeadRectD object that specifies the current physical rectangle of this AnnObject.
Public Method GetUndoRedoObject Gets an object that contains the current undo/redo object data.
Public Method HitTestContainer Gets the container under the specified location.
Public Method Invalidate Invalidates the specified region of the automation control.
Public Method InvalidateContainer Invalidates the specified container and re-renders its content in the automation control.
Public Method InvalidateObject Invalidates and re-draws an object.
Public Method InvokeAfterObjectChanged Invokes the AfterObjectChanged event with the specified parameters.
Public Method InvokeObjectModified Invokes the ObjectModified event with the specified parameters.
Public Method LayerFromSelectedObjects Creates a new layer from the currently selected objects.
Public Method Lock Locks the object(s) currently being edited (selected).
Public Method MakeSameHeight Make the height for selected objects the same with alignment target height.
Public Method MakeSameSize Make the size for selected objects the same with alignment target size.
Public Method MakeSameWidth Make the width for selected objects the same with alignment target width.
Public Method Paste Copies the annotation objects from the clipboard to this AnnAutomation.
Public Method PasteAt Copies the annotation objects from the clipboard to this AnnAutomation at the specified position.
Public Method PasteStringAt Copies the annotation objects contained in a serialization object at the specified position.
Public Method RealizeAllRedactions Realizes all the AnnRedactionObject objects in this AnnAutomation.
Public Method RealizeRedaction Realizes the AnnRedactionObject object currently being edited (selected).
Public Method Redo Reapplies the last operation that was undone in this AnnAutomation.
Public Method ResetRotatePoints Resets the rotate control points of the selected AnnObject to their default locations.
Public Method RestoreAllRedactions Restores all of the AnnRedactionObject objects in this AnnAutomation.
Public Method RestoreRedaction Restores the AnnRedactionObject object currently being edited (selected).
Public Method SelectLayer Selects a layer in this AnnAutomation.
Public Method SelectObject Selects an object in this AnnAutomation.
Public Method SelectObjects Selects an object or a group of objects in this AnnAutomation.
Public Method SendLayerToBack Sends the currently selected layer down in the Z-order.
Public Method SendToBack Sends the currently selected object(s) down in the Z-order.
Public Method ShowContextMenu Displays the automation context menu.
Public Method ShowObjectContextMenu Displays the object context menu.
Public Method ShowObjectProperties Shows the object properties.
Public Method Undo Reverses the last operation performed in this AnnAutomation.
Public Method Unlock Unlocks the object(s) currently being edited (selected).

Protected Methods

Name Description
Protected Method GetDefaultCurrentObjectId Returns the value of the default current object id.
Protected Method OnAfterUndoRedo Raises the AfterUndoRedo event.
Protected Method OnAutomationPointerDown Called by the IAnnAutomationControl pointer down event.
Protected Method OnAutomationPointerMove Called by the IAnnAutomationControl pointer move event.
Protected Method OnAutomationPointerUp Called by the IAnnAutomationControl pointer up event.
Protected Method OnCurrentDesignerChanged Raises the CurrentDesignerChanged event.
Protected Method OnDragDrop Raises the DragDrop event.
Protected Method OnUndoRedoChanged Raises the UndoRedoChanged event.

Public Properties

Name Description
Public Property Active Gets or sets a value indicating whether this AnnAutomation is active.
Public Property ActiveContainer Gets or sets the active container of the automation.
Public Property AutomationControl Gets the automation control for this AnnAutomation.
Public Property CanAlign Gets a value that indicates whether this AnnAutomation can align or change the size for selected objects based on alignment target.
Public Property CanApplyAllDecryptors Gets a value that indicates whether any decryptor AnnEncryptObject object in this AnnAutomation can be applied.
Public Property CanApplyAllEncryptors Gets a value that indicates whether any encryptor AnnEncryptObject object in this AnnAutomation can be applied.
Public Property CanApplyDecryptor Gets a value that indicates whether the object currently being edited is a decryptor AnnEncryptObject and can be applied.
Public Property CanApplyEncryptor Gets a value that indicates whether the object currently being edited (selected) is an encryptor AnnEncryptObject and can be applied.
Public Property CanBringLayerToFirst Gets a value that indicates whether this AnnAutomation is currently in a state where a layer can be brought up to the top of the z-order.
Public Property CanBringLayerToFront Gets a value that indicates whether this AnnAutomation is currently in a state where a layer can be brought up the z-order.
Public Property CanBringToFirst Gets a value that indicates whether this AnnAutomation can bring the currently selected object(s) to the top of the Z-order.
Public Property CanBringToFront Gets a value that indicates whether this AnnAutomation can bring the currently selected object(s) up in the Z-order.
Public Property CanCopy Gets a value that indicates whether this AnnAutomation is currently in a state where objects can be copied to the clipboard.
Public Property CanDeleteObjects Gets a value that indicates whether this AnnAutomation is currently in a state where objects can be deleted.
Public Property CanFlip Gets a value that indicates whether this AnnAutomation is currently in a state where objects can be flipped.
Public Property CanGroup Gets a value indicating whether this AnnAutomation is in a state where objects can be grouped together.
Public Property CanLock Gets a value that indicates whether the object currently being edited (selected) can be locked.
Public Property CanPaste Gets a value that indicates whether the clipboard contains annotation objects that can be pasted.
Public Property CanRealizeAllRedactions Gets a value that indicates whether any of the AnnRedactionObject objects in this AnnAutomation can be realized.
Public Property CanRealizeRedaction Gets a value that indicates whether the object currently being edited (selected) is an AnnRedactionObject and can be realized.
Public Property CanRedo Gets a value indicating whether the user can redo the previous operation performed in this AnnAutomation.
Public Property CanResetRotatePoints Gets a value that indicates whether this AnnAutomation is currently in a state where the selected AnnObject is able to have its rotate control points reset to the default location.
Public Property CanRestoreAllRedactions Gets a value that indicates whether any AnnRedactionObject objects in this AnnAutomation can be restored.
Public Property CanRestoreRedaction Gets a value that indicates whether the object currently being edited (selected) is an AnnRedactionObject and can be restored.
Public Property CanSelectNone Gets a value indicating whether this AnnAutomation is in a state where it can deselect objects.
Public Property CanSelectObjects Gets a value that indicates whether this AnnAutomation is in a state where any object can be selected.
Public Property CanSendLayerToBack Gets a value that indicates whether this AnnAutomation is currently in a state where a layer can be sent down the z-order.
Public Property CanSendLayerToLast Gets a value that indicates whether this AnnAutomation is currently in a state where a layer can be sent to the end of the z-order.
Public Property CanSendToBack Gets a value that indicates whether this AnnAutomation can send the currently selected object(s) down in the Z-order.
Public Property CanSendToLast Gets a value that indicates whether this AnnAutomation can send the currently selected object(s) to the bottom of the Z-order.
Public Property CanShowObjectContextMenu Gets a value that indicates whether this AnnAutomation is currently in a state where the object context menu can be displayed.
Public Property CanShowObjectProperties Gets a value that indicates whether this AnnAutomation is currently in a state where the object properties can be displayed.
Public Property CanShowProperties Gets a value that indicates whether this AnnAutomation is currently in a state where the user properties dialog can be displayed.
Public Property CanUndo Gets a value that indicates whether the user can undo the previous operation performed in this AnnAutomation.
Public Property CanUngroup Gets a value indicating whether this AnnAutomation is in a state where objects can be ungrouped.
Public Property CanUnlock Gets a value that indicates whether the object currently being edited (selected) can be unlocked.
Public Property Container Gets the AnnContainer of this AnnAutomation.
Public Property Containers The list of containers in this AnnAutomation when multi-containers mode is used.
Public Property CurrentDesigner Gets the current working designer.
Public Property CurrentEditObject Gets the current AnnObject being edited.
Public Property DefaultCurrentObjectId The annotations object ID to use when a draw designer finishes its operation.
Public Property EnableDragDrop A value that indicates whether drag and drop is enabled in this AnnAutomation.
Public Property Manager Returns the AnnAutomationManager that this AnnAutomation object belongs to.
Public Property UndoCapacity A value that specifies the capacity of the undo/redo buffer.

Public Events

Name Description
Public Event ActiveContainerChanged Occurs when the active container of this object is changed.
Public Event AfterObjectChanged Occurs when an AnnObject has changed.
Public Event AfterUndoRedo Occurs after an undo or redo operation.
Public Event BeforeObjectChanged Occurs when an AnnObject is about to be changed.
Public Event CurrentDesignerChanged Occurs when the current designer has been changed.
Public Event DeserializeObjectError Occurs when an error occurs during an object serialization operation.
Public Event DragDrop Occurs when an AnnObject is being dragged out of a container.
Public Event Draw Occurs when an AnnObject is being drawn.
Public Event Edit Occurs when an AnnObject is being edited.
Public Event EditContent Occurs when the content of an AnnObject is edited.
Public Event EditText Occurs when the text of an AnnObject is edited.
Public Event LockObject Occurs when an AnnObject is locked.
Public Event ObjectModified Occurs when one or more AnnObjects has changed.
Public Event OnShowContextMenu Occurs when the automation needs to show the context menu when no objects are selected.
Public Event OnShowObjectProperties Occurs when the automation needs to show the properties dialog of the selected object.
Public Event RestoreCursor Occurs when the automation has determined that the original cursor needs to be restored.
Public Event Run Occurs when an AnnObject is being run.
Public Event SelectedObjectsChanged Occurs when the selected object changes.
Public Event SetCursor Occurs when the automation has determined that the user needs to change the cursor.
Public Event ToolTip Occurs when the mouse hovers over an annotation object and a tooltip is requested.
Public Event UndoRedoChanged Occurs when the undo or redo buffer changes.
Public Event UnlockObject Occurs when an AnnObject is unlocked.

See Also

AnnAutomation Class

Leadtools.Annotations.Automation Namespace

Help Version 22.0.2023.4.25
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Annotations.Automation Assembly
Introduction
Getting Started
Namespaces
Leadtools.Annotations.Automation Namespace
Assemblies
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.