CogGraphicLabel Class

Cognex VisionPro 9.7

Class that represents a graphical text label.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro CogGraphicLabel

Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 73.0.0.0

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogGraphicLabel : CogObjectBase, 
	ICogNetInternal, IDisposable, ICogGraphic, ICogGraphicInteractive, ICogGraphicParentChild, 
	ICloneable, ISerializable, ICogHasChanged, ICogChangedEvent

[SerializableAttribute]
public class CogGraphicLabel : CogObjectBase, 
	ICogNetInternal, IDisposable, ICogGraphic, ICogGraphicInteractive, ICogGraphicParentChild, 
	ICloneable, ISerializable, ICogHasChanged, ICogChangedEvent

<SerializableAttribute>
Public Class CogGraphicLabel 
	Inherits CogObjectBase 
	Implements ICogNetInternal, IDisposable, ICogGraphic, ICogGraphicInteractive, 
	ICogGraphicParentChild, ICloneable, ISerializable, ICogHasChanged, ICogChangedEvent

<SerializableAttribute>
Public Class CogGraphicLabel 
	Inherits CogObjectBase 
	Implements ICogNetInternal, IDisposable, ICogGraphic, ICogGraphicInteractive, 
	ICogGraphicParentChild, ICloneable, ISerializable, ICogHasChanged, ICogChangedEvent

[SerializableAttribute]
public ref class CogGraphicLabel : public CogObjectBase, 
	ICogNetInternal, IDisposable, ICogGraphic, ICogGraphicInteractive, ICogGraphicParentChild, 
	ICloneable, ISerializable, ICogHasChanged, ICogChangedEvent

[SerializableAttribute]
public ref class CogGraphicLabel : public CogObjectBase, 
	ICogNetInternal, IDisposable, ICogGraphic, ICogGraphicInteractive, ICogGraphicParentChild, 
	ICloneable, ISerializable, ICogHasChanged, ICogChangedEvent

The CogGraphicLabel type exposes the following members.

Constructors

	Name	Description
	CogGraphicLabel	Constructs a new instance of this class.
	CogGraphicLabel(IntPtr)	Constructs a new instance of this class using com pointer.
	CogGraphicLabel(CogGraphicLabel)	Constructs a new instance of this class as a deep copy of the given instance.

Top

Methods

	Name	Description
	Clone	Returns a deep copy of this class instance. Derived classes that implement Clone should override this method; other clients who wish to clone this instance should call ICloneable.Clone. See also CogSerializer.DeepCopyObject
	Copy	Create a new shape that copies specified parameters.
	CopyBase	Copy a graphic and its derived parameters.
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	Dispose
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	(Overrides Object Finalize .)
	GetAttributes	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetClassName	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetComponentName	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetConverter	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetDefaultEvent	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetDefaultProperty	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEditor	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEvents	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEvents( Attribute )	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetObjectData
	GetParentFromChildTransform
	GetProperties	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetProperties( Attribute )	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetPropertyOwner	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	MapLinear	Map through a linear transform.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	ResumeAndRaiseChangedEvent	Re-enables raising of the Changed event after SuspendChangedEvent has been called. Also raises the Changed event 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 Changed event. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent.
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Fields

	Name	Description
	SfAlignment	This bit will be set in the EventArgs of a Changed event every time the value returned by Alignment may have changed.
	SfBackgroundColor	This bit will be set in the EventArgs of a Changed event every time the value returned by BackgroundColor may have changed.
	SfChildren	This bit will be set in the EventArgs of a Changed event every time the value returned by Children may have changed.
	SfColor	This bit will be set in the EventArgs of a Changed event every time the value returned by Color may have changed.
	SfDragBackgroundColor	This bit will be set in the EventArgs of a Changed event every time the value returned by DragBackgroundColor may have changed.
	SfDragColor	This bit will be set in the EventArgs of a Changed event every time the value returned by DragColor may have changed.
	SfDragLineStyle	This bit will be set in the EventArgs of a Changed event every time the value returned by DragLineStyle may have changed.
	SfDragLineWidthInScreenPixels	This bit will be set in the EventArgs of a Changed event every time the value returned by DragLineWidthInScreenPixels may have changed.
	SfFont	This bit will be set in the EventArgs of a Changed event every time the value returned by Font may have changed.
	SfGraphicDOFEnable	This bit will be set in the EventArgs of a Changed event every time the value returned by GraphicDOFEnable may have changed.
	SfGraphicDOFEnableBase	This bit will be set in the EventArgs of a Changed event every time the value returned by GraphicDOFEnableBase may have changed.
	SfInteractive	This bit will be set in the EventArgs of a Changed event every time the value returned by Interactive may have changed.
	SfLineStyle	This bit will be set in the EventArgs of a Changed event every time the value returned by LineStyle may have changed.
	SfLineWidthInScreenPixels	This bit will be set in the EventArgs of a Changed event every time the value returned by LineWidthInScreenPixels may have changed.
	SfMouseCursor	This bit will be set in the EventArgs of a Changed event every time the value returned by MouseCursor may have changed.
	SfOffset	This bit will be set in the EventArgs of a Changed event every time the value returned by Offset may have changed.
	SfOffsetAngle	This bit will be set in the EventArgs of a Changed event every time the value returned by OffsetAngle may have changed.
	SfOffsetAngleSpaceName	This bit will be set in the EventArgs of a Changed event every time the value returned by OffsetAngleSpaceName may have changed.
	SfOffsetSpaceName	This bit will be set in the EventArgs of a Changed event every time the value returned by OffsetSpaceName may have changed.
	SfParent	This bit will be set in the EventArgs of a Changed event every time the value returned by Parent may have changed.
	SfRotation	This bit will be set in the EventArgs of a Changed event every time the value returned by Rotation may have changed.
	SfSelected	This bit will be set in the EventArgs of a Changed event every time the value returned by Selected may have changed.
	SfSelectedBackgroundColor	This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedBackgroundColor may have changed.
	SfSelectedColor	This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedColor may have changed.
	SfSelectedLineStyle	This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedLineStyle may have changed.
	SfSelectedLineWidthInScreenPixels	This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedLineWidthInScreenPixels may have changed.
	SfSelectedSpaceName	This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedSpaceName may have changed.
	SfText	This bit will be set in the EventArgs of a Changed event every time the value returned by Text may have changed.
	SfTipText	This bit will be set in the EventArgs of a Changed event every time the value returned by TipText may have changed.
	SfVisible	This bit will be set in the EventArgs of a Changed event every time the value returned by Visible may have changed.
	SfX	This bit will be set in the EventArgs of a Changed event every time the value returned by X may have changed.
	SfY	This bit will be set in the EventArgs of a Changed event every time the value returned by Y may have changed.

Top

Properties

	Name	Description
	Alignment	Controls how the text is aligned with respect to the X,Y position.
	BackgroundColor	Controls the background color for text. Use cogColorNone for transparent.
	ChangedEventSuspended	If nonzero, indicates that the raising of the Changed event has been suspended. This value is incremented when SuspendChangedEvent is called and decremented when ResumeAndRaiseChangedEvent is called.
	Children	Children of this graphic.
	Color	Color of this graphic. Can be any OLE_COLOR.
	DragBackgroundColor	Controls the background color for text when the label is being dragged. Use cogColorNone for transparent.
	DragColor	Color of this graphic when dragged.
	DragLineStyle	Line style of this graphic when dragged.
	DragLineWidthInScreenPixels	Line width of this graphic when dragged.
	Font
	GraphicDOFEnable	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.
	HasChanged	If true, the serializable state of this object has changed since the last time it was serialized.
	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	The distance from X,Y, as measured in OffsetSpaceName coordinates,to use to adjust the label position.
	OffsetAngle	The angle (in radians) as measured in OffsetAngleSpaceName coordinates to use to adjust the label position.
	OffsetAngleSpaceName	Coordinate space in which this shape's OffsetAngle property is to be interpreted.
	OffsetSpaceName	Coordinate space in which this shape's Offset property is to be interpreted.
	Parent	Parent of this graphic.
	Rotation	The angle (in radians, from the x-axis) of the text label.
	Selected	True when the shape is selected in a display.
	SelectedBackgroundColor	Controls the background color for text when the label is selected. Use cogColorNone 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	Coordinate space in which this shape is to be interpreted.
	Text	Text for this label.
	TipText	Text to describe this graphic in a tool tip.
	Visible	Visible property of this graphic.
	X	X coordinate of the text.
	Y	Y coordinate of the text.

Top

Events

	Name	Description
	Changed	Occurs when one or more parts of the object's state may have changed.
	Dragging	Occurs when an interactive graphic is being dragged.
	DraggingStopped	Occurs after the drag operation of an interactive graphic is complete.

Top

Remarks

Interface describing non-scaling Text Label graphic.