Class that represents a graphical text label.
Cognex.Vision ShareableBase
Cognex.Vision ChangedEventShareableBase
Cognex.Vision GraphicInteractiveBase
Cognex.Vision GraphicLabel
Namespace: Cognex.Vision
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.10.0.0
The GraphicLabel type exposes the following members.
| Name | Description | |
|---|---|---|
 | GraphicLabel | Constructs a new instance of this class. |
| Name | Description | |
|---|---|---|
| Copy | Create a new shape that copies specified parameters. |
| CopyBase | Copy a graphic and its derived parameters. |
| Equals | Compares the equality of this object with another. (Overrides GraphicInteractiveBase Equals(Object).) |
| GetHashCode | Returns the hash code of this object. (Overrides GraphicInteractiveBase GetHashCode .) |
| GetParentFromChildTransform | Gets the parent transform from the child transform. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetTypeMeta | Get the TypeMeta that describes the type of this object. |
| MapLinear | Map through a linear transform. |
| ResumeAndRaiseChangedEvent | Re-enables raising of the ChangedEvent after SuspendChangedEvent has been called, and raises the ChangedEvent if the ChangedEventSuspended count is reduced to zero and any changes were made while events were suspended. Must be called once for each call to SuspendChangedEvent. |
| SetXYText | Initialize this graphic label from the X, Y, and Text. |
| SuspendChangedEvent | Temporarily suspends the raising of the ChangedEvent. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent. |
| ToString | Returns a human readable string that represents the object. |
| Name | Description | |
|---|---|---|
  | Equality | Compares the equality of two GraphicLabel objects. |
| Inequality | Compares the inequality of two GraphicLabel objects. |
| Name | Description | |
|---|---|---|
 | SfAlignment | |
| SfBackgroundColor | |
| SfDragBackgroundColor | |
| SfFont | |
| SfOffset | |
| SfOffsetAngle | |
| SfOffsetAngleSpaceName | |
| SfOffsetSpaceName | |
| SfRotation | |
| SfSelectedBackgroundColor | |
| SfText | |
| SfX | |
| SfY |
| Name | Description | |
|---|---|---|
 | Alignment | Get Returns how the text is aligned with respect to the X,Y position. |
| BackgroundColor | Get Returns the background color for text. Use ColorConstants.None for transparent. |
| ChangedEventSuspended | Indicates if raising the ChangedEvent has been suspended. |
| Children | Children of this graphic. |
| Color | Color of this graphic. Can be any OLE_COLOR. |
| DragBackgroundColor | Get Returns the background color for text when the label is being dragged. Use ColorConstants.None for transparent. |
| DragColor | Color of this graphic when dragged. |
| DragLineStyle | Line style of the graphic when dragged. |
| DragLineWidthInScreenPixels | Line width of this graphic when dragged. |
| FillColor | The fill color of this graphic. |
| Font | Get Gets the font of the text displayed by the GraphicLabel. |
| GraphicDOFEnable | Get Interactive Degree of freedom for this graphic object. Provides the ability to govern interactive manipulation of an object; for example could be used to prevent an object from being resized. |
| GraphicDOFEnableBase | Interactive Degree of freedom for a graphic object. Allows access to each graphic's GraphicDOFEnable property without knowing the specific graphic type. |
| Handle | (Overrides GraphicInteractiveBase Handle.) |
| Interactive | Interactive property allow this graphic object to be selected. See GraphicDOFEnable for information on governing interactive manipulation of an object. |
| LineStyle | Line style of this graphic. |
| LineWidthInScreenPixels | Line width (in screen pixels) of this graphic. |
| MouseCursor | Mouse cursor to be displayed when the mouse is over the graphic. The cursor will be visible only if the graphic is interactive. |
| Offset | Get The distance from X,Y, as measured in OffsetSpaceName coordinates,to use to adjust the label position. |
| OffsetAngle | Get The angle (in radians) as measured in OffsetAngleSpaceName coordinates to use to adjust the label position. |
| OffsetAngleSpaceName | Get Coordinate space in which this shape's OffsetAngle property is to be interpreted. |
| OffsetSpaceName | Get Coordinate space in which this shape's Offset property is to be interpreted. |
| Parent | Return a reference to the containing tracking collection. May be null. |
| Rotation | Get The angle (in radians, from the x-axis) of the text label. |
| Selected | True when the shape is selected in a display. |
| SelectedBackgroundColor | Get Returns the background color for text when the label is selected. Use ColorConstants.None for transparent. |
| SelectedColor | Color of this graphic when selected. |
| SelectedLineStyle | Line style of this graphic when selected. |
| SelectedLineWidthInScreenPixels | Line width of this graphic when selected. |
| SelectedSpaceName | Get (Overrides GraphicInteractiveBase SelectedSpaceName.)Coordinate space in which this shape is to be interpreted. |
| Text | Get Text for this label. |
| TipText | Text to describe this graphic in a tool tip. Newline characters can be used to create multi-line tip text. |
| Visible | Visible property of this graphic. |
| X | Get X coordinate of the text. |
| Y | Get Y coordinate of the text. |
| Name | Description | |
|---|---|---|
 | Changed | The actual event. |
| Dragging | Raised when an interactive graphic is being dragged. |
| DraggingStopped | Raised after the drag operation of an interactive graphic is complete. |
Class describing non-scaling Text Label graphic.