GraphDocument Class

SystemObject
  Altaxo.MainSuspendableDocumentNodeBase
    Altaxo.MainSuspendableDocumentNode
      Altaxo.MainSuspendableDocumentNodeWithSingleAccumulatedDataEventArgs
        Altaxo.GraphGraphDocumentBase
          Altaxo.Graph.GdiGraphDocument

C#

Copy

public class GraphDocument : GraphDocumentBase

	Name	Description
	GraphDocument	Creates a empty GraphDocument with no layers and a standard size of A4 landscape.
	GraphDocument(GraphDocument)	Initializes a new instance of the GraphDocument class

Top

	Name	Description
	AccumulatedEventData	Gets the accumulated event data. (Inherited from SuspendableDocumentNodeWithSingleAccumulatedDataT)
	CreationTimeUtc	The date/time of creation of this graph. (Inherited from GraphDocumentBase)
	Debug_AbsolutePath	Gets the absolute path of the node for debugging purposes. (Inherited from SuspendableDocumentNodeBase)
	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)
	LastChangeTimeUtc	The date/time when this graph was changed. (Inherited from GraphDocumentBase)
	Name	(Inherited from GraphDocumentBase)
	Notes	Notes concerning this graph. (Inherited from GraphDocumentBase)
	ParentObject	Get / sets the parent object of this table. (Inherited from GraphDocumentBase)
	PrintOptions
	PropertyBag	(Inherited from GraphDocumentBase)
	PropertyBagNotNull	(Inherited from GraphDocumentBase)
	RootLayer	The collection of layers of the graph.
	Size	Gets/sets the size of this graph in points (1/72 inch). The value returned is exactly the size of the root layer. (Overrides GraphDocumentBaseSize)

Top

	Name	Description
	AccumulateChangeData	(Inherited from GraphDocumentBase)
	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 GraphDocumentBaseClone)
	CopyFrom
	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)
	GetChildObjectNamed	Retrieves the child node of this instance with the name C# Copy name . (Inherited from SuspendableDocumentNode)
	GetDefaultBackColor
	GetDefaultFont
	GetDefaultForeColor
	GetDefaultMajorTickLength	Gets the default major tick length for all graphics in this graph, using the provided property context.
	GetDefaultPenWidth	Gets the default width of the pen for all graphics in this graph, using the provided property context.
	GetDefaultPlotColor
	GetDefaultSymbolSize	Gets the default plot symbol size for all graphics in this graph, using the provided property context.
	GetDocumentNodeChildrenWithName	(Overrides SuspendableDocumentNodeGetDocumentNodeChildrenWithName)
	GetFirstLayerOfTypeTLayer	Gets the first layer in the graph that has the provided type. If such a layer is not found, an exception is thrown.
	GetFirstXYPlotLayer	Gets the first xy plot layer of the graph. If such a layer is not found, an exception is thrown.
	GetGraphProperty	Gets an arbitrary object that was stored as graph property by SetGraphProperty(String, Object). (Inherited from GraphDocumentBase)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetNameOfChildObject	Gets the name of child node. (Inherited from SuspendableDocumentNode)
	GetPropertyValueT	(Inherited from GraphDocumentBase)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	HandleHighPriorityChildChangeCases	(Inherited from GraphDocumentBase)
	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)
	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	(Overrides SuspendableDocumentNodeBaseOnChanged(EventArgs))
	OnInvalidate	Fires the Invalidate event.
	OnNameChanged	Fires both a Changed and a TunnelingEvent when the name has changed. The event arg of the Changed event is an instance of NamedObjectCollectionChangedEventArgs. The event arg of the Tunneling event is an instance of DocumentPathChangedEventArgs. (Inherited from GraphDocumentBase)
	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)
	OnSizeChanged	Fires the SizeChanged event. (Inherited from GraphDocumentBase)
	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	Paints the graph.
	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)
	SetDisposeInProgress	Sets the flag that dispose is in progress for this node and all child nodes recursively. (Inherited from SuspendableDocumentNode)
	SetGraphProperty	The table properties, key is a string, val is a object you want to store here. (Inherited from GraphDocumentBase)
	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)
	SuspendGetToken	Suspend will increase the SuspendLevel. (Inherited from SuspendableDocumentNode)
	ToString	Returns a string that represents the current object. (Inherited from Object)
	TryGetName	Tests if this item already has a name. (Inherited from GraphDocumentBase)
	VisitDocumentReferences	Replaces path of items (intended for data items like tables and columns) by other paths. Thus it is possible to change a plot so that the plot items refer to another table. (Overrides GraphDocumentBaseVisitDocumentReferences(DocNodeProxyReporter))

Top

	Name	Description
	Changed	Fired when something in the object has changed, and the object is not suspended. (Inherited from SuspendableDocumentNodeBase)
	SizeChanged	Event fired if the size of this document (i.e. the size of the root layer) changed. (Inherited from GraphDocumentBase)
	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

	Name	Description
	_accumulatedEventData	Holds the accumulated change data. (Inherited from SuspendableDocumentNodeWithSingleAccumulatedDataT)
	_creationTime	The date/time of creation of this graph. (Inherited from GraphDocumentBase)
	_graphIdentifier	An identifier that can be shown on the graph and that is searchable. (Inherited from GraphDocumentBase)
	_graphProperties	The graph properties, key is a string, value is a property (arbitrary object) you want to store here. (Inherited from GraphDocumentBase)
	_hasFixupChangedAnything	This flag is set if during fixup anything has changed. (Inherited from GraphDocumentBase)
	_isFixupInternalDataStructuresActive	(Inherited from GraphDocumentBase)
	_lastChangeTime	The date/time when this graph was changed. (Inherited from GraphDocumentBase)
	_name	The name of the graph. (Inherited from GraphDocumentBase)
	_notes	Notes concerning this graph. (Inherited from GraphDocumentBase)
	_paintThread	Events which are fired from this thread are not distributed. (Inherited from GraphDocumentBase)
	_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)
	DefaultRootLayerSizeX
	DefaultRootLayerSizeY
	PropertyKeyDefaultBackColor
	PropertyKeyDefaultFont
	PropertyKeyDefaultForeColor
	PropertyKeyDefaultPlotColor
	PropertyKeyDefaultRootLayerSize

Top

	Name	Description
	CopyToClipboardAsBitmap	Copies the current graph as an bitmap image to the clipboard in native bmp format. (Defined by GraphDocumentClipboardActions)
	CopyToClipboardAsNative	Puts the entire graph to the clipboard in XML format. (Defined by GraphDocumentClipboardActions)
	CopyToClipboardLayerAsNative	Puts the layer with index layerNumber to the clipboard in XML format. (Defined by GraphDocumentClipboardActions)
	CreateNewLayerLinkedRightY	Creates a new layer with right y axis, which is linked to the same position with top x axis and right y axis. (Defined by GraphDocumentLayerCreation)
	CreateNewLayerLinkedTopX	Creates a new layer with top x axis, which is linked to the same position with top x axis and right y axis. (Defined by GraphDocumentLayerCreation)
	CreateNewLayerLinkedTopXRightY	Creates a new layer with bottom x axis and left y axis, which is linked to the same position with top x axis and right y axis. (Defined by GraphDocumentLayerCreation)
	CreateNewLayerLinkedTopXRightY_XAxisStraight	Creates a new layer with bottom x axis and left y axis, which is linked to the same position with top x axis and right y axis. The x axis is linked straight to the x axis of the linked layer. (Defined by GraphDocumentLayerCreation)
	CreateNewLayerNormalBottomXLeftY	Creates a new layer with bottom x axis and left y axis, which is not linked. (Defined by GraphDocumentLayerCreation)
	DeleteLayer	Deletes the layer specified by index layerNumber. (Defined by GraphDocumentOtherActions)
	MoveLayerToPosition	Moves the layer specified by index sourcePosition to index destposition. (Defined by GraphDocumentOtherActions)
	OnUserRescaledAxes	This command will rescale all axes in all layers (Defined by GraphDocumentOtherActions)
	PasteFromClipboard	Try to paste the entire GraphDocument from the clipboard using the specified paste options. (Defined by GraphDocumentClipboardActions)
	PasteFromClipboardAsGraphStyle	Try to paste the entire GraphDocument from the clipboard. (Defined by GraphDocumentClipboardActions)
	PasteFromClipboardAsNewChildLayerOfLayerNumber	Pastes a layer on the clipboard as new layer after the layer at index currentActiveLayerNumber. (Defined by GraphDocumentClipboardActions)
	PasteFromClipboardAsNewLayer	(Defined by GraphDocumentClipboardActions)
	PasteFromClipboardAsNewLayerAfterLayerNumber	Pastes a layer on the clipboard as new layer after the layer at index currentActiveLayerNumber. (Defined by GraphDocumentClipboardActions)
	PasteFromClipboardAsNewLayerBeforeLayerNumber	Pastes a layer on the clipboard as new layer before the layer specified by index currentActiveLayerNumber. (Defined by GraphDocumentClipboardActions)
	PasteFromClipboardAsTemplateForLayer	(Defined by GraphDocumentClipboardActions)
	Print	Prints the document on the currently active printer (no Gui interaction). An exception will be thrown if something fails during printing. (Defined by GraphDocumentPrinting)
	RenderAsBitmap	(Defined by GraphDocumentExportActions)
	RenderAsBitmap	Saves the graph as an bitmap file and returns the bitmap. (Defined by GraphDocumentExportActions)
	RenderAsBitmap	Saves the graph as an bitmap file and returns the bitmap. (Defined by GraphDocumentExportActions)
	RenderAsBitmapToFile	Saves the graph as an bitmap file into the file filename using the default pixel format 32bppArgb. (Defined by GraphDocumentExportActions)
	RenderAsBitmapToFile	Saves the graph as an bitmap file into the file filename using the default pixel format 32bppArgb and no background brush. (Defined by GraphDocumentExportActions)
	RenderAsBitmapToFile	Saves the graph as an bitmap file into the file filename using the default pixel format 32bppArgb. (Defined by GraphDocumentExportActions)
	RenderAsBitmapToFile	Saves the graph as an bitmap file into the file filename. (Defined by GraphDocumentExportActions)
	RenderAsBitmapToStream	Saves the graph as an bitmap file into the stream using the default pixelformat 32bppArgb.stream. (Defined by GraphDocumentExportActions)
	RenderAsBitmapToStream	Saves the graph as an bitmap file into the stream using the default pixelformat 32bppArgb and no background brush.stream. (Defined by GraphDocumentExportActions)
	RenderAsBitmapToStream	Saves the graph as an bitmap file into the stream using the default pixelformat 32bppArgb.stream. (Defined by GraphDocumentExportActions)
	RenderAsBitmapToStream	Saves the graph as an bitmap file into the stream stream. (Defined by GraphDocumentExportActions)
	RenderAsEnhancedMetafileVectorFormat	Saves the graph as an bitmap file into the file filename using the default pixel format 32bppArgb and no background brush. (Defined by GraphDocumentExportActions)
	RenderAsEnhancedMetafileVectorFormat	Renders the graph document as enhanced metafile image in vector format with the options given in exportOptions (Defined by GraphDocumentExportActions)
	RenderAsEnhancedMetafileVectorFormat	(Defined by GraphDocumentExportActions)
	RenderAsEnhancedMetafileVectorFormat	Saves the graph as an bitmap file into the file filename using the default pixel format 32bppArgb. (Defined by GraphDocumentExportActions)
	RenderAsEnhancedMetafileVectorFormat	Saves the graph as an bitmap file into the file filename. (Defined by GraphDocumentExportActions)
	RenderAsEnhancedMetafileVectorFormatToStream	Renders the graph document as enhanced metafile image in vector format with the options given in exportOptions (Defined by GraphDocumentExportActions)
	RenderToFile	(Defined by GraphDocumentExportActions)
	RenderToStream	(Defined by GraphDocumentExportActions)
	ShowCopyPageOptionsDialog	Shows the copy page options dialog and stores the result as the static field CopyPageOptions here in this class (Defined by GraphDocumentClipboardActions)
	ShowFileExportDialog	(Defined by GraphDocumentBaseExportActions)
	ShowFileExportMetafileDialog	(Defined by GraphDocumentBaseExportActions)
	ShowFileExportSpecificDialog	(Defined by GraphDocumentBaseExportActions)
	ShowFileExportTiffDialog	(Defined by GraphDocumentBaseExportActions)
	ShowLayerArrangementDialog	Shows the layer arrangement dialog and then arranges the layers according to the user input. (Defined by GraphDocumentLayerArrangement)
	ShowLayerDialog	(Defined by GraphDocumentOtherActions)
	ShowMoveLayerToPositionDialog	Moves the layer specified by index layerNumber as specified by the user in the opened dialog. (Defined by GraphDocumentOtherActions)
	ShowPrintDialogAndPrint	Shows the print dialog to choose the printer, and then prints the document. (Defined by GraphDocumentPrinting)
	ShowPrintOptionsDialog	Shows the dialog to set the print options for this document. (Defined by GraphDocumentPrinting)
	ShowPropertyDialog	(Defined by GraphDocumentOtherActions)
	ShowRenameDialog	(Defined by GraphDocumentOtherActions)

Top

The coordinate system of the graph is in units of points (1/72 inch). The origin (0,0) of the graph is the top left corner of the printable area (and therefore _not_ the page bounds). The value of the page bounds is stored inside the class only to know what the original page size of the document was.

Reference

Altaxo.Graph.Gdi Namespace