TextGraphic Class

TextGraphics provides not only simple text on a graph, but also some formatting of the text, and quite important - the plot symbols to be used either in the legend or in the axis titles

Inheritance Hierarchy

SystemObject
  Altaxo.MainSuspendableDocumentNodeBase
    Altaxo.MainSuspendableDocumentNode
      Altaxo.MainSuspendableDocumentNodeWithSingleAccumulatedDataEventArgs
        Altaxo.Graph.Gdi.ShapesGraphicBase
          Altaxo.Graph.Gdi.ShapesTextGraphic

Namespace: Altaxo.Graph.Gdi.Shapes
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)

Syntax

Copy

[SerializableAttribute]
public class TextGraphic : GraphicBase, 
	IRoutedPropertyReceiver

The TextGraphic type exposes the following members.

Constructors

	Name	Description
	TextGraphic(IReadOnlyPropertyBag)	Initializes a new instance of the TextGraphic class
	TextGraphic(IXmlDeserializationInfo)	Initializes a new instance of the TextGraphic class for deserialization purposes.
	TextGraphic(TextGraphic)	Initializes a new instance of the TextGraphic class
	TextGraphic(PointD2D, String, FontX, NamedColor)	Initializes a new instance of the TextGraphic class
	TextGraphic(Double, Double, String, FontX, NamedColor)	Initializes a new instance of the TextGraphic class
	TextGraphic(PointD2D, String, FontX, NamedColor, Double)	Initializes a new instance of the TextGraphic class
	TextGraphic(Double, Double, String, FontX, NamedColor, Double)	Initializes a new instance of the TextGraphic class

Top

Properties

	Name	Description
	AccumulatedEventData	Gets the accumulated event data. (Inherited from SuspendableDocumentNodeWithSingleAccumulatedDataT)
	AllowNegativeSize	Returns the information if this object allows negative sizes. (Inherited from GraphicBase)
	AutoSize	(Overrides GraphicBaseAutoSize)
	Background
	Bounds	Gets the bound of the object. The X and Y positions depend on the transformation model chosen for this graphic object: if the transformation takes into account the local anchor point, then the X and Y of the bounds are always 0. If the transformation does not take the local anchor point into account, then (X and Y) is the vector from the local anchor point to the upper left corner of the graphical object. (Inherited from GraphicBase)
	Color
	Debug_AbsolutePath	Gets the absolute path of the node for debugging purposes. (Inherited from SuspendableDocumentNodeBase)
	Empty
	Font
	Height	Gets/sets the height of the item. This is the unscaled height. (Inherited from GraphicBase)
	IsDisposed	Gets a value indicating whether this instance is disposed. (Inherited from SuspendableDocumentNodeBase)
	IsDisposeInProgress	Gets a value indicating whether for this instance dispose is in progress, or the instance is already disposed. (Inherited from SuspendableDocumentNodeBase)
	IsResumeInProgress	Gets a value indicating whether this instance is currently resuming the events. (Inherited from SuspendableDocumentNode)
	IsSomeoneListeningToChanges	Gets a value indicating whether someone is listening to changes. For this, either the ParentObject or the Changed event must be set. (Inherited from SuspendableDocumentNodeBase)
	IsSuspended	Gets a value indicating whether this instance is suspended. (Inherited from SuspendableDocumentNode)
	IsSuspendedOrResumeInProgress	Gets a value indicating whether this instance is suspended or resume is currently in progress. (Inherited from SuspendableDocumentNode)
	LineSpacing
	Location	(Inherited from GraphicBase)
	Name	Gets the name of this document node. Null is returned if the name is not set or unknown. The set accessor will for most nodes throw a InvalidOperationException, since the name can only be set on IProjectItems. (Inherited from SuspendableDocumentNodeBase)
	ParentObject	Gets/sets the parent object this instance belongs to. (Inherited from SuspendableDocumentNodeBase)
	ParentSize	(Inherited from GraphicBase)
	Position	Get/set the position of the object. This is defined as the vector from the parent's reference point to the object's pivot point. (Inherited from GraphicBase)
	Rotation	Get/sets the rotation value, measured in degrees in counterclockwise direction. (Inherited from GraphicBase)
	Scale	(Inherited from GraphicBase)
	ScaleX	Get/sets the scale for the width of the item. Normally this number is one (1). (Inherited from GraphicBase)
	ScaleY	Get/sets the scale for the height of the item. Normally this number is one (1). (Inherited from GraphicBase)
	Shear	Get/sets the shear of the item. This is the factor, by which the item points are shifted in x direction, when doing a unit step in y direction. The shear is the tangents of the shear angle. (Inherited from GraphicBase)
	Size	Get/set the unscaled size of the item. (Inherited from GraphicBase)
	Text
	TextFillBrush
	Width	Get/sets the width of the item. This is the unscaled width. (Inherited from GraphicBase)
	X	Get/sets the x position of the reference point of the object in layer coordinates. (Inherited from GraphicBase)
	Y	Get/sets the y position of the reference point of the object in layer coordinates. (Inherited from GraphicBase)

Top

Methods

	Name	Description
	AccumulateChangeData	(Inherited from GraphicBase)
	AccumulatedChangeData_SetBackAfterResumeAndSuspend	Sets the change data without further processing. This function is infrastructure and intended to use only in OnResume after the parent has suspended this node again. (Inherited from SuspendableDocumentNodeWithSingleAccumulatedDataT)
	AccumulatedEventData_Clear	Clears the accumulated event data. (Inherited from SuspendableDocumentNodeWithSingleAccumulatedDataT)
	AccumulatedEventData_HasZeroOrOneEventArg	Determines whether there is no or only one single event arg accumulated. If this is the case, the return value is true. If there is one event arg accumulated, it is returned in the argument singleEventArg. The return value is false if there is more than one event arg accumulated. In this case the singleEventArg is null on return, and the calling function should use AccumulatedEventData to enumerate all accumulated event args. (Inherited from SuspendableDocumentNodeWithSingleAccumulatedDataT)
	ChildCloneFromT	Clones a node that is intended to use as child node of this instance (e.g. in collections). Consider using ChildCloneToMemberT(T, T) instead if the child node is stored in a member of this instance. (Inherited from SuspendableDocumentNode)
	ChildCloneToMemberT	Sets a member variable that holds a child with a cloned instance of another variable. If an old instance member (provided in myChild exists and can not be used, it is disposed first. The node is then cloned using System.ICloneable. The resulting node's ParentObject is then set to this instance in order to maintain the parent-child relationship. (Inherited from SuspendableDocumentNode)
	ChildCloneToMemberAltT	Set a member variable that holds a child node of this instance. The child node may or may not implement IDocumentLeafNode. The value to set may or may not implement ICloneable. If it implements ICloneable, then the member variable is set to a clone of the value. Otherwise, the member variable is set directly with the value. It helps to ensure the correct order: first, the child node is set to the new instance and then the old child node is disposed. (Inherited from SuspendableDocumentNode)
	ChildCopyToMemberT	Copies a document node from another source into a member of this instance. If an old instance member (provided in myChild exists and can not be used, it is disposed first. The node is then copied using either Main.ICopyFrom or System.ICloneable. The resulting node's ParentObject is then set to this instance in order to maintain the parent-child relationship. (Inherited from SuspendableDocumentNode)
	ChildCopyToMemberOrCreateNewT	Copies a document node from another source into a member of this instance. If an old instance member (provided in myChild exists and can not be used, it is disposed first. If the node is not null, the node is then copied using either Main.ICopyFrom or System.ICloneable. If the node is null, a new node is created using the provided generation function. The resulting node's ParentObject is then set to this instance in order to maintain the parent-child relationship. (Inherited from SuspendableDocumentNode)
	ChildDisposeMemberT	Helper function to dispose a child node of this instance. It helps to ensure the correct order: first, the child node is set to null and only then the child node is disposed. (Inherited from SuspendableDocumentNodeBase)
	ChildSetMemberT	Set a member variable that holds a child node of this instance. It helps to ensure the correct order: first, the child node is set to the new instance and then the old child node is disposed. (Inherited from SuspendableDocumentNode)
	ChildSetMemberAltT	Set a member variable that holds a child node of this instance. The child node may or may not implement IDocumentLeafNode. It helps to ensure the correct order: first, the child node is set to the new instance and then the old child node is disposed. (Inherited from SuspendableDocumentNode)
	Clone	(Overrides GraphicBaseClone)
	CopyFrom(Object)	(Overrides GraphicBaseCopyFrom(Object))
	CopyFrom(GraphicBase, Boolean)	(Inherited from GraphicBase)
	CopyFrom(TextGraphic, Boolean)
	CountEvent	Counts the number of events during the suspend state. Every call to this function will increment the event counter by 1 (but only in the suspended state). The event counter will be reset to zero when the object is resumed. (Inherited from SuspendableDocumentNode)
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from SuspendableDocumentNodeBase)
	Dispose(Boolean)	(Inherited from SuspendableDocumentNode)
	EhChildChanged	Used by childs of this object to inform us about a change in their state. (Inherited from SuspendableDocumentNode)
	EhParentTunnelingEventHappened	Is called by the parent when a tunneling event happened in the parent. (Inherited from SuspendableDocumentNode)
	EhSelfChanged	Called if some (simple) member or property of this instance itself has changed. (Inherited from SuspendableDocumentNode)
	EhSelfTunnelingEventHappened(TunnelingEventArgs)	Is called by this instance if a tunneling event happened into this instance. The tunneling event triggers the TunneledEvent and is additionally distributed to all childs of this instance. (Inherited from SuspendableDocumentNodeBase)
	EhSelfTunnelingEventHappened(TunnelingEventArgs, Boolean)	Is called by this instance if a tunneling event happened into this instance. The tunneling event triggers the TunneledEvent and is - depending on the provided parameter - also distributed to all childs of this instance. (Inherited from SuspendableDocumentNode)
	EnumerateFromHereToLeaves	Enumerates all document node including this node, its child nodes, its child-child nodes up to the leaf nodes. (Inherited from SuspendableDocumentNode)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Finalizes an instance of the SuspendableDocumentNodeBase class. (Inherited from SuspendableDocumentNodeBase)
	FixupInternalDataStructures	(Inherited from GraphicBase)
	GetChildObjectNamed	Retrieves the child node of this instance with the name C# Copy name . (Inherited from SuspendableDocumentNode)
	GetCornerOutVector	Gets an vector (not normalized), which assumes that the given point is a corner. The calculated vector points in the direction of the angle bisector of the two edges. The returned vector and coordinates are in page coordinates. (Inherited from GraphicBase)
	GetDocumentNodeChildrenWithName	(Overrides GraphicBaseGetDocumentNodeChildrenWithName)
	GetGrips	(Inherited from GraphicBase)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetNameOfChildObject	Gets the name of child node. (Inherited from SuspendableDocumentNode)
	GetNewHitTestObject	(Inherited from GraphicBase)
	GetObjectOutlineForArrangements	Get the object outline for arrangements in object world coordinates. (Overrides GraphicBaseGetObjectOutlineForArrangements)
	GetPosition	Returns the position of the pivot point of the object in parent coordinates (strictly speaking: as vector from the parent's reference point to the pivot point of the object). (Inherited from GraphicBase)
	GetRectangularObjectOutline	Get the path that is often used in HitTestObject to show the selected outline of the object if multiple objects are selected. (Inherited from GraphicBase)
	GetRoutedProperties
	GetType	Gets the Type of the current instance. (Inherited from Object)
	HandleHighPriorityChildChangeCases	Handles the case when a child changes, and a reaction is neccessary independently on the suspend state of the table. (Inherited from SuspendableDocumentNode)
	HandleLowPriorityChildChangeCases	Processes the event args e when this object is not suspended. This function serves two purposes: i) updating some cached data of this object by processing the event args of the child, and ii) optional transforming the event args, for instance to a new type, which afterwards is send to the parent and is used as event args in the [E:Changed] event of this object. The transformed event args is not used if this object is suspended (in this case the original event args is used). (Inherited from SuspendableDocumentNode)
	HitTest(HitTestPointData)	(Overrides GraphicBaseHitTest(HitTestPointData))
	HitTest(HitTestRectangularData)	(Inherited from GraphicBase)
	IsCompatibleWithParent	Determines whether this graphical object is compatible with the parent specified in the argument. (Inherited from GraphicBase)
	MeasureBackground
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	NotifyChildrenTunnelingEventHappened	Notifies the child nodes of this instance that a tunneling event has happened. (Inherited from SuspendableDocumentNode)
	OnAboutToBeResumed	Is called when the suspend level is still 1 (one), but is about to fall to zero, i.e. shortly before the call to OnResume(Int32). This function is not called before OnResumeSilently(Int32)! (Inherited from SuspendableDocumentNode)
	OnChanged	(Inherited from GraphicBase)
	OnResume	Is called when the object is resumed, i.e. change notifications are allowed again. During the execution of this function, the [P:IsResumeInProgress] property will return true to indicate that the resume is currently in progress. (Inherited from SuspendableDocumentNode)
	OnResumeSilently	Is called when the suspend level falls down from 1 to zero by a call to ResumeSilently. This implementation disarma the suspendTokens of the childs of this object, deletes any accumulated events, and does not send any change event to the parent or the listeners of the Change event. (Inherited from SuspendableDocumentNode)
	OnSuspended	Called when the suspend level has just gone from 0 to 1, i.e. the object was suspended. (Inherited from SuspendableDocumentNode)
	OnTunnelingEvent	Fires the TunneledEvent event. (Inherited from SuspendableDocumentNodeBase)
	Paint(Graphics, IPaintContext)	(Overrides GraphicBasePaint(Graphics, IPaintContext))
	Paint(Graphics, IPaintContext, Boolean)
	PaintBackground
	PaintPreprocessing	Is called before the paint procedure is executed. (Inherited from GraphicBase)
	ParentCoordinatesToLocalDifference	Calculates the difference vector between two points in parent coordinates and transforms the vector to local coordinates. (Inherited from GraphicBase)
	RelativeLocalToAbsoluteLocalCoordinates	Converts relative positions (0..1, 0..1) to absolute coordinates in the world coordinate system of the object. To convert this to layer coordinates, you have to transform it with the transformation matrix of this object. (Inherited from GraphicBase)
	RelativeLocalToAbsoluteParentCoordinates	Converts relative positions of the object (0..1, 0..1) to coordinates in the world coordinate system of the parent (normally the layer). (Inherited from GraphicBase)
	RelativeLocalToAbsoluteParentVector	Converts relative positions (0..1, 0..1) to coordinates in the world coordinate system of the parent (normally the layer). (Inherited from GraphicBase)
	RelativeToAbsolutePosition	Converts relative positions (0..1, 0..1) to absolute position of the rectangle, taking into account the current rotation. (Inherited from GraphicBase)
	Resume(ISuspendToken)	Resumes changed events by calling Resume for the provided suspend token, and setting the reference to the suspend token to null. If Event data were accumulated during the suspended state, a changed event is triggered for each event data. (Inherited from SuspendableDocumentNodeBase)
	Resume(ISuspendToken, EventFiring)	Resumes changed events, either with taking the accumulated event data into account (see Resume(ISuspendToken)) or discarding the accumulated event data (see ResumeSilently(ISuspendToken), depending on the provided argument eventFiring. (Inherited from SuspendableDocumentNodeBase)
	ResumeCompleteTemporarily	Resumes the object completely for only a short time. Thus, if object was suspended before, it will be suspended again when the function returns. (Inherited from SuspendableDocumentNode)
	ResumeCompleteTemporarilyGetToken	Resumes the object completely for the time the returned token is referenced and not disposed. The return value is a token that had 'absorbed' the suspend count of the object, resulting in the suspend count of the object dropped to 0 (zero). When the returned token is finally disposed, the suspend count of the object is increased again by the 'absorbed' suspend count. (Inherited from SuspendableDocumentNode)
	ResumeSilently	Resumes changed events by calling Resume for the provided suspend token, and setting the reference to the suspend token to null. All event data accumulated during the suspended state are discarded, and thus no change event is triggered even if the instance has changed during the suspended state. (Inherited from SuspendableDocumentNodeBase)
	SetBoundsFrom	Sets the bounds from. (Inherited from GraphicBase)
	SetCoordinatesByAppendInverseTransformation	(Inherited from GraphicBase)
	SetCoordinatesByAppendTransformation	(Inherited from GraphicBase)
	SetDisposeInProgress	Sets the flag that dispose is in progress for this node and all child nodes recursively. (Inherited from SuspendableDocumentNode)
	SetMemberAndRaiseSelfChangedT(NullableT, NullableT)	Sets a member variable of this instance and raise a change event with Empty if the new value is different from the old value. The comparison is done using the IEquatableT interface of the member variable. Note: to set members that implement IDocumentNode please use the Child... functions. (Inherited from SuspendableDocumentNodeBase)
	SetMemberAndRaiseSelfChangedT(T, T)	Sets a member variable of this instance and raise a change event with Empty if the new value is different from the old value. The comparison is done using the IEquatableT interface of the member variable. Note: to set members that implement IDocumentNode please use the Child... functions. (Inherited from SuspendableDocumentNodeBase)
	SetMemberEnumAndRaiseSelfChangedT	Sets a member variable (which is an Enum) of this instance and raise a change event with Empty if the new value is different from the old value. The comparison is done using the IEquatableT interface of the member variable. Note: to set members that implement IDocumentNode please use the Child... functions. (Inherited from SuspendableDocumentNodeBase)
	SetParentSize	(Inherited from GraphicBase)
	SetPosition	Sets the position of the object's pivot point. (Inherited from GraphicBase)
	SetRelativeSizePositionFromAbsoluteValues	Sets the size and position of this item in relative units, calculated from absolute values. Note that the ParentSize must be set prior to calling this function. (Inherited from GraphicBase)
	SetRotationFrom	(Inherited from GraphicBase)
	SetScalesFrom	(Inherited from GraphicBase)
	SetShearFrom	(Inherited from GraphicBase)
	SetSize	Sets the size of the item. (Inherited from GraphicBase)
	ShiftPosition(PointD2D)	(Inherited from GraphicBase)
	ShiftPosition(Double, Double)	(Inherited from GraphicBase)
	SilentSetPosition	Sets the position of the object without causing a Changed event. (Inherited from GraphicBase)
	SuspendGetToken	Suspend will increase the SuspendLevel. (Inherited from SuspendableDocumentNode)
	ToRotatedDifference	(Inherited from GraphicBase)
	ToString	(Overrides ObjectToString)
	ToUnrotatedCoordinates	(Inherited from GraphicBase)
	ToUnrotatedDifference(PointD2D)	(Inherited from GraphicBase)
	ToUnrotatedDifference(PointD2D, PointD2D)	(Inherited from GraphicBase)
	TransformationFromHereToParent	Transforms a PointD2D from our own coordinates to the coordinates of the parent. (Inherited from GraphicBase)
	TransformCoordinatesFromHereToParent	Transforms a PointD2D from our own coordinates to the coordinates of the parent. (Inherited from GraphicBase)
	TransformGraphics	Transforms the graphics context is such a way, that the object can be drawn in local coordinates. (Inherited from GraphicBase)
	TryGetName	Test if this item already has a name. (Inherited from SuspendableDocumentNodeBase)
	UpdateTransformationMatrix	Updates the internal transformation matrix to reflect the settings for position, rotation, scaleX, scaleY and shear. It is designed here by default so that the local anchor point of the object is located at the world coordinates (0,0). The transformation matrix update can be overridden in derived classes so that for instance the left upper corner of the object is located at (0,0). (Inherited from GraphicBase)

Top

Events

	Name	Description
	Changed	Fired when something in the object has changed, and the object is not suspended. (Inherited from SuspendableDocumentNodeBase)
	TunneledEvent	The event that is fired when the object is disposed. First argument is the sender, second argument is the original source, and third argument is the event arg. (Inherited from SuspendableDocumentNodeBase)

Top

Fields

	Name	Description
	_accumulatedEventData	Holds the accumulated change data. (Inherited from SuspendableDocumentNodeWithSingleAccumulatedDataT)
	_background
	_cachedExtendedTextBounds
	_cachedParentSize	The size of the parent object. (Inherited from GraphicBase)
	_cachedSymbolPositions	Hashtable where the keys are graphic paths giving the position of a symbol into the list, and the values are the plot items.
	_cachedTextOffset
	_font
	_isMeasureInSync
	_isStructureInSync
	_lineSpacingFactor
	_location	The item's location (size, position, rotation, shear, scale ..) (Inherited from GraphicBase)
	_parent	The parent object this instance belongs to. (Inherited from SuspendableDocumentNodeBase)
	_suspendTokensOfChilds	Stores the suspend tokens of the suspended childs of this object. (Inherited from SuspendableDocumentNode)
	_text
	_textBrush
	_transformation	Cached matrix which transforms from own coordinates to parent (layer) coordinates. (Inherited from GraphicBase)
	PlotItemEditorMethod
	TextGraphicsEditorMethod

Top

Reference

Altaxo.Graph.Gdi.Shapes Namespace