Transformer Class
This class contains methods to transform a selection of location objects.
This object can only be created from an ApiLocationTools that is bound to a specific location.
Definition
Namespace: Articy.Api
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
C#
public class Transformer- Inheritance
- Object Transformer
Properties
Methods
| Add | Adds the given object to the transformation list |
| AddRange | Adds a list of objects to the transformation selection. Only shapes, images, texts, spots & links are allowed. This method can only be called when the transformation is not active. |
| AddResultSet | Adds all objects from a query result, the result set must only contain objects of the bound location that can be transformed |
| BeginTransform | Begins the transformation of the currently selected transform object with the selected transform mode Only allowed if no transformation is currently active |
| CancelTransform | If there is a current transformation and it is not unknown, restore the values from the initial snapshot and then end it |
| Clear | Clear the selection to work with |
| EndTransform | If there is a current transformation and it is not unknown, end it |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| FlipHorizontal | Flips the currently selected transform object on the global horizontal axis if it is a custom shape, on the local horizontal axis if it is not |
| FlipVertical | Flips the currently selected transform object on the global vertical axis if it is a custom shape, on the local vertical axis if it is not |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetHeight | Gets the height length of the currently selected transform object as a double value |
| GetPivot | Gets the pivot position of the currently selected transform object as a point |
| GetPosition | Gets the current position of the selected transform object as a point |
| GetRotation | Gets the rotation as a double value of the currently selected transform object |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetWidth | Gets the width length of the currently selected transform object as a double value |
| RecenterPivot | Resets the pivot position to the center middle of the currently selected transform object |
| Redo | If there is a redoable action, restore the next snapshot |
| Remove | remove the given object from the transform selection |
| RemoveRange | Removes a list IEnumerable list of objects from the transform selection. Invalid objects in the list are ignored. This method can only be called when the transformation is not active. |
| RemoveResultSet | Remove all objects from a query result from the transform selection |
| SetHeight | Sets the height length of the currently selected transform object with a specified value and a possibility to keep the current aspect ratio |
| SetPivot(TransformerAnchorPosition) | Sets the pivot of the currently selected transform object to a specific anchor position with the option to snap |
| SetPivot(Point) | Sets the pivot of the currently selected transform object to a specific point with the option to snap |
| SetPosition | Sets the position of the selected transform object to a new point |
| SetRotation | Sets the rotation angle of the currently selected transform object with a specified double value |
| SetSize | Sets the size of the currently selected transform object to a specified value |
| SetTransformMode | Sets the transform mode of the currently selected transform object to object aligned or axis aligned (or unknown) Only allowed if no transformation is currently active. Object aligned transformation is only available for single shape, text or image objects. |
| SetWidth | Sets the width length of the currently selected transform object with a specified value and a possibility to keep the current aspect ratio |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Undo | If there is an undoable action, restore the last snapshot |
Extension Methods
| TraceError | (Defined by TraceHelper) |
| TraceInfo | (Defined by TraceHelper) |
| TraceWarning | (Defined by TraceHelper) |